Enterprise Solutions

Safe Deposit Audit Inquiry

Enterprise SOAP API > API by Reference > Core Services > Safe Deposit Audit Inquiry
Safe Deposit Audit Inquiry

Safe Deposit Audit Inquiry

Safe Deposit Audit Inquiry is a jXchange service designed to allow consumers to access safe deposit audit records.

Message Flow

In jXchange, the Safe Deposit Audit Inquiry service uses a typical exchange of MType messages to allow consumers to access safe deposit audit records.

Primary Request

The consumer forwards the SafeDepAuditInqRq_MType message to the service provider. The message contains the following simple elements:

  • AcctId
  • AcctType
  • ActIntent
  • SafeDepBoxAuditType

Primary Response

The service provider returns the SafeDepAuditInqRs_MType message to the consumer. The message contains the following simple elements:

  • AcctId
  • AcctType
  • ActIntent
  • ActIntentKey
  • SafeDepBoxAuditType

Safe Deposit Audit Inquiry Behavior

The Safe Deposit Audit Inquiry service behavior is as follows.

The Safe Deposit Audit Inquiry root request message (SafeDepAuditInq_MType) requires a valid Account Id (AcctId).

The Safe Deposit Audit Inquiry root request message (SafeDepAuditInq_MType) optionally includes Account Type (AcctType), Activity Intention (ActIntent), and Safe Deposit Box Audit Type (SafeDepBoxAuditType). Currently, there is no modification service, so the Activity Intention is for future use. Also, the only canonical value for Safe Deposit Box Audit Type (SafeDepBoxAuditType) is Access, so the provider can determine if blank returns all records.

The Safe Deposit Audit Inquiry root response message (SafeDepAuditInqRs_MType) includes an echo back of the Account Id (AcctId), Account Type (AcctType), and Activity Intention (ActIntent).

The Safe Deposit Audit Inquiry root response message (SafeDepAuditInqRs_MType) also includes the optional Activity Intention Key (ActIntentKey), Safe Deposit Box Audit Type (SafeDepAuditType), and the Safe Deposit Audit Inquiry Array (SafeDepAuditInqArray_AType).

The Safe Deposit Audit Inquiry Array includes the Safe Deposit Audit Inquiry Record complex (SafeDepAuditInqRec_CType), which includes Safe Deposit Signature Verification Description (SafeDepSigVerifyDesc), Audit User Id (AuditUsrId), and the Safe Deposit Audit Inquiry Information complex (SafeDepAuditInfo_CType). This element contains Audit Time Date (AuditTimeDt), Person Name complex (PersonName_CType), Employee Name (EmpName), Safe Deposit Signature Verification Code (SafeDepSigVerifyCode), and Remark Array (RmkArray_AType). The Employee Name (EmpName) and Audit User Id (AuditUsrId) elements are typically the same.

SafeDepAuditInqRq_MType

SafeDepAuditInqRq_MType is a message MType element.

Contains:

  • Custom_CType
  • MsgRqHdr_CType

Simple Elements

The following simple element is contained within this message.

AcctId
The number or character that identifies an account record.
AcctType
The number or character that categorizes the AcctId.
ActIntent
Conveys the consumer intention for a subsequent operation for the data set included in the response. Canonical values are:
  • Dlt
  • ReadOnly
  • Upd

The default value is ReadOnly.

SafeDepBoxAuditType
The element describing the safe deposit audit type. The canonical value is Access.

Custom_CType

Custom_CType is a complex CType element.

This element is optional.

MsgRqHdr_CType

MsgRqHdr_CType is a complex CType element. This is the default message request header.

Contains:

  • AuthenUsrCred_CType
  • jXchangeHdr_CType

Simple Elements

The following simple elements are contained within this complex.

AuthenProdCred
Authentication of the Consumer Product Credentials in the form of a WS Security element that contains a single SAML V2.0 Assertion.

AuthenUsrCred_CType

AuthenUsrCred_CType is a complex CType element. This element represents authentication of the end-user credentials in the form of a WS Security element that contains a single SAML V2.0 Assertion.

Simple Elements

The following simple elements are contained within this complex.

Security
Defines the wsse:Security SOAP header element per section 4.

jXchangeHdr_CType

jXchangeHdr_CType is a complex CType element.

Simple Elements

The following simple elements are contained within this complex.

AuditUsrId
The user ID that the consumer would like written in the audit as performing the requested service. It varies, but it could be the same as the user ID. It is not used to authenticate. It is used to audit the Soap Header Fault.
AuditWsId
The workstation ID that the consumer would like written in the audit as performing the requested service for the Soap Header Fault. It varies, but it could be the same as the user ID.
AuthenUsrId
The user ID which the consumer would like the service provider to authenticate with for the Soap Header Fault. It is a user ID that the provider understands.

This element deprecates in accordance with XSD contract tenets. Effective date: 2017–01–01. The new complex element for user authentication credentials was added to both the Search Message Request Header SrchMsgRqHdr_CType and the Message Request Header MsgRqHdr_CType. AuthenUsrId is ignored by the service providers when the authentication user credentials AuthenUsrCred_CType package is delivered. The expectation is that the password credentials and the user name token are provided in the authentication user credential complex element in accordance with the standards established by WS-Security.

BusCorrelId
The correlation identification as related to business functions and activities.
ConsumerName
The name of the service consumer (business name) for the Soap Header Fault.
ConsumerProd
The name of the product which is consuming the service (business product name) for the Soap Header Fault.
InstEnv
An identification provided by the consumer that defines the environment in which the institution is operating. Canonical values are:
  • Prod
InstRtId
The identification of the entity of the submitted message. A financial institution entity uses the routing transit or nine-digit number assigned to financial institutions for routing as assigned by the American Bankers Association. Any leading zeros must be provided for a complete routing and transit number. A non-financial institution entity should use a mutually agreed upon identification that must contain at least one non-integer character. The canonical value is JHA.

The element is required in all message requests.

jXLogTrackingId
An identification provided by jXchange to be able to trace the request and response of a message from the third-party gateway, internal gateway, and service provider for the Soap Header Fault.
JxVer
Contains the version jXchange is running for the Soap Header Fault.
ValidConsmName
The consumer name that can be validated by enterprise governance. The canonical values are managed in a consumer/product enterprise table. The canonical value is: JHA.
ValidConsmProd
The consumer product name that can be validated by enterprise governance. The canonical values are managed in a consumer/product enterprise table.
WorkflowCorrelId
The correlation identification as related to workflow functions and activities.
jXchangeHdr_CType Deprecation Details
AuthenUsrId
The user ID which the consumer would like the service provider to authenticate with for the Soap Header Fault. It is a user ID that the provider understands.

This element deprecates in accordance with XSD contract tenets. Effective date: 2017–01–01. The new complex element for user authentication credentials was added to both the Search Message Request Header SrchMsgRqHdr_CType and the Message Request Header MsgRqHdr_CType. AuthenUsrId is ignored by the service providers when the authentication user credentials AuthenUsrCred_CType package is delivered. The expectation is that the password credentials and the user name token are provided in the authentication user credential complex element in accordance with the standards established by WS-Security.

SafeDepAuditInqRs_MType

SafeDepAuditInqRs_MType is a message MType element.

Contains:

  • Custom_CType
  • MsgRsHdr_CType
  • SafeDepAuditInqArray_AType

Simple Elements

The following simple elements are contained within this message.

AcctId
The number or character that identifies an account record.
AcctType
The number or character that categorizes the AcctId.
ActIntent
Conveys the consumer intention for a subsequent operation for the data set included in the response. Canonical values are:
  • Dlt
  • ReadOnly
  • Upd

The default value is ReadOnly.

ActIntentKey
The service provider key that is delivered to the consumer to be submitted in a subsequent modification operation.
SafeDepBoxAuditType
The element describing the safe deposit audit type. The canonical value is Access.

Custom_CType

Custom_CType is a complex CType element.

This element is optional.

MsgRsHdr_CType

MsgRsHdr_CType is a complex CType element. This is the default message response header.

Contains:

  • jXchangeHdr_CType
  • MsgRecInfoArray_AType

jXchangeHdr_CType

jXchangeHdr_CType is a complex CType element.

Simple Elements

The following simple elements are contained within this complex.

AuditUsrId
The user ID that the consumer would like written in the audit as performing the requested service. It varies, but it could be the same as the user ID. It is not used to authenticate. It is used to audit the Soap Header Fault.
AuditWsId
The workstation ID that the consumer would like written in the audit as performing the requested service for the Soap Header Fault. It varies, but it could be the same as the user ID.
AuthenUsrId
The user ID which the consumer would like the service provider to authenticate with for the Soap Header Fault. It is a user ID that the provider understands.

This element deprecates in accordance with XSD contract tenets. Effective date: 2017–01–01. The new complex element for user authentication credentials was added to both the Search Message Request Header SrchMsgRqHdr_CType and the Message Request Header MsgRqHdr_CType. AuthenUsrId is ignored by the service providers when the authentication user credentials AuthenUsrCred_CType package is delivered. The expectation is that the password credentials and the user name token are provided in the authentication user credential complex element in accordance with the standards established by WS-Security.

BusCorrelId
The correlation identification as related to business functions and activities.
ConsumerName
The name of the service consumer (business name) for the Soap Header Fault.
ConsumerProd
The name of the product which is consuming the service (business product name) for the Soap Header Fault.
InstEnv
An identification provided by the consumer that defines the environment in which the institution is operating. Canonical values are:
  • Prod
InstRtId
The identification of the entity of the submitted message. A financial institution entity uses the routing transit or nine-digit number assigned to financial institutions for routing as assigned by the American Bankers Association. Any leading zeros must be provided for a complete routing and transit number. A non-financial institution entity should use a mutually agreed upon identification that must contain at least one non-integer character. The canonical value is JHA.

The element is required in all message requests.

jXLogTrackingId
An identification provided by jXchange to be able to trace the request and response of a message from the third-party gateway, internal gateway, and service provider for the Soap Header Fault.
JxVer
Contains the version jXchange is running for the Soap Header Fault.
ValidConsmName
The consumer name that can be validated by enterprise governance. The canonical values are managed in a consumer/product enterprise table. The canonical value is: JHA.
ValidConsmProd
The consumer product name that can be validated by enterprise governance. The canonical values are managed in a consumer/product enterprise table.
WorkflowCorrelId
The correlation identification as related to workflow functions and activities.
jXchangeHdr_CType Deprecation Details
AuthenUsrId
The user ID which the consumer would like the service provider to authenticate with for the Soap Header Fault. It is a user ID that the provider understands.

This element deprecates in accordance with XSD contract tenets. Effective date: 2017–01–01. The new complex element for user authentication credentials was added to both the Search Message Request Header SrchMsgRqHdr_CType and the Message Request Header MsgRqHdr_CType. AuthenUsrId is ignored by the service providers when the authentication user credentials AuthenUsrCred_CType package is delivered. The expectation is that the password credentials and the user name token are provided in the authentication user credential complex element in accordance with the standards established by WS-Security.

MsgRecInfoArray_AType

MsgRecInfoArray_AType is an array AType element. This is an array of messages that can be returned in a response.

Contains:

  • MsgRec_CType
MsgRec_CType

MsgRec_CType is a complex CType element.

Simple Elements

The following simple elements are contained within this complex.

ErrCat
The Soap Header Fault error category.
ErrCode
The Soap Header Fault error code.
ErrDesc
The Soap Header Fault error description.
ErrElem
The Soap Header Fault when an error or fault occurs. This optional element contains the element which is causing the error condition.
ErrElemVal
The Soap Header Fault when an error or fault occurs. This optional element contains the value of the element which is causing the error condition.
ErrLoc
The Soap Header Fault error location. This is typically the program that generated the error condition.

SafeDepAuditInqArray_AType

SafeDepAuditInqArray_AType is an array AType element. This is an array of safe deposit inquiry audit records.

Contains:

  • SafeDepAuditInqRec_CType

SafeDepAuditInqRec_CType

SafeDepAuditInqRec_CType is a complex CType element.

Simple Elements

Contains:

  • SafeDepAuditInqInfo references SafeDepAuditInfo_CType

The following simple elements are contained within this complex.

AuditUsrId
The user ID that the consumer would like written in the audit as performing the requested service. It varies, but it could be the same as the user ID. It is not used to authenticate. It is used to audit the Soap Header Fault.
SafeDepSigVerifyDesc
The description of the signature verification.
SafeDepAuditInqInfo

SafeDepAuditInfo_CType is a complex CType element.

SafeDepAuditInqInfo references SafeDepAuditInfo_CType.

Contains:

  • PersonName_CType
  • RmkArray references Rmk_AType
Simple Elements

The following simple elements are contained within this complex.

AuditTimeDt
The date and timestamp access was granted. The date and time are expressed in ISO 8601 time format and contain either Zulu time or local time and the UTC offset. The format is [-]CCYY-MM-DDThh:mm:ss[Z|(+|-)hh:mm]. Valid values include:
  • 2001-10-26T21:32:52
  • 2001-10-26T19:32:52Z
  • 2001-10-26T19:32:52+00:00
  • -2001-10-26T21:32:52
  • 2001-10-26T21:32:52.12679

The following examples all represent the same moment:

  • 18:30Z
  • 22:30+04
  • 1130-0700
  • 15:00-3:30

See http://books.xmlschemata.org/relaxng/ch19-77049.html for additional reference.

EmpName
The employee name.
SafeDepSigVerifyCode
The signature verification code.
PersonName_CType

PersonName_CType is a complex CType element. It contains name information. This complex is optional.

Contains:

  • X_PersonName
Simple Elements

The following simple elements are contained within this complex.

ComName
The common name. This is the full text line name like John Doe.
FirstName
The first name.
LastName
The last name.
MiddleName
The middle name.
X_PersonName_CType

x_PersonName_CType is a complex CType element.

Simple Elements

The following simple elements are contained within this complex.

AbbName
An abbreviated individual's or entity's name.
LegalName
Used by entities like trusts, or businesses in the case where an individual is doing business as a company, or when the legal name is different than the ComName.
NameSuffix
The name suffix. For examples, Jr. or MD.
SalName
A full text line name which is used in mailings. For example, Mr. and Mrs. John Doe.
TitlePrefix
The title prefix. Examples: Mr. or Mrs.
RmkArray

Rmk_AType is an array AType element. This is an array of application or user remarks in free form text.

RmkArray references Rmk_AType

Contains:

  • RmkInfo_CType
RmkInfo_CType

RmkInfo_CType is a complex CType element.

Simple Elements

The following simple elements are contained within this complex.

Rmk
Application or user remarks free-form text.
Have a Question?
Have a how-to question? Seeing a weird error? Get help on StackOverflow.
Register for the Digital Toolkit Meetup where we answer technical Q&A from the audience.
Last updated Mon Jan 24 2022