Address Search
This service contains the following breakdown of request and response elements:
Primary Request
The request for address information from a consumer contains a standard message header and a customer ID and/or an account ID. The initial request can also contain additional optional address classification information received from a previous message exchange such as AddrCat1, AddrCat2, or AddrKey. If AddrCat1/AddrCat2 information is received in the first request, it is used to filter response options. If a specific address key is sent in the primary request, the corresponding address is returned in the primary response, increasing response time.
Primary Response
All available listed addresses are returned to the consumer in the
AddrSrchRs_MType
message. Within the response message, each
returned address is defined with a separate instance of each of the following
complexes:
AddrInfo_CType
AddrSrchRec_CType
StmtAddrInfoSrch_CType
If a consumer or account ID was submitted in the request, only the addresses pertaining to that ID is returned.
The response after a request for a specific address contains the standard message header and the
Addr_Info
complex containing simple elements populated with
address information, such as street address, state, country, ZIP code, etc.
AddrSrchRq_MType
AddrSrchRq_MType
is a message
MType
element. This is a major complex used for address
request messaging.
Contains:
AccountId_CType
AddrKeyInfo_CType
Custom_CType
SrchMsgRqHdr_CType
Simple Elements
The following simple elements are contained within this message.
- CustId
- The identifier attached to a customer.
AccountId_CType
AccountId_CType
is a complex
CType
element. This element contains the incoming account
identification information and any restrictions.
Simple Elements
The following simple elements are contained within this complex.
- AcctId
- The number or character that identifies an account record.
- AcctType
- The number or character that categorizes the AcctId.
- Rstr
- The level of restrictions that can exist at a parent and/or child node. Canonical
values are:
- Hid
- NoAccess
- NoAccessPart
- ReadOnly
- ReadOnlyPart
- ReadWrite
- ReadWritePart
AddrKeyInfo_CType
AddrKeyInfo_CType
is a complex
CType
element containing address key information. This
element is optional.
Simple Elements
The following simple elements are contained within this complex.
- AddrCatUse
- Address category type. Canonical values are:
- Acct - Account
- Cust - Customer
- IRSRpt - IRS Reporting
- Not - Notice
- Pmt - Payments (Distributions or interest checks)
- Seasonal
- Stmt - Statement
- AddrCat2Use
- Address category 2 type
- Cat=Not has
- AdvOfCr
- Bil
- CrBack
- EOYTax
- InsufFunds
- IRAMat
- OD
- PastDue
- RateChg
- RtnItems
- TeleTrf
- Cat=Pmt has
- EscrwRefund
- Int
- IRADistr
- XMAS
- Cat1=Stmt has
- Escrw
- IRAPeriodic
- LOC
- Periodic
Canonical values are:
- AdvOfCr
- All
- Bil
- CrBack
- EOYTax
- Escrw
- EscrwRefund
- Exc
- InsufFunds
- Int
- IRADistr
- IRAMat
- IRAPeriodic
- IRS
- LOC
- OD
- PastDue
- Periodic
- Phys
- RateChg
- RtnItems
- Seasonal
- TeleTrf
- XMAS
- Cat=Not has
- AddrKey
- Unique key string which points to an address.
- DupAddrCat2Use
- Controls if the address being added or modified represents a duplicate address and not
a replaced address for the
AddrCat2Use
element.
Custom_CType
Custom_CType
is a complex CType
element.
This element is optional.
SrchMsgRqHdr_CType
SrchMsgRqHdr_CType
is a complex
CType
element. This is a
standard request message 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.
- Cursor
- The state information that allows the next call to understand where it left off when returning multiple records and allowing a subsequent call to retrieve more records.
- MaxRec
- The maximum number of records when multiple records are returned.
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 HeaderMsgRqHdr_CType
. AuthenUsrId is ignored by the service providers when the authentication user credentialsAuthenUsrCred_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 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
- AuthenUserId
- This element deprecates in three years in accordance with XSD contract tenets.
Effective date: 2012–01–01. The new complex element for user authentication credentials
was added to 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 credentialsAuthenUsrCred_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 byWS-Security
.
AddrSrchRs_MType
AddrSrchRs_MType
is a message
MType
element used for address messaging
response.
Contains:
AddrSrchRecArray_AType
Custom_CType
SrchMsgRsHdr_CType
AddrSrchRecArray_AType
AddrSrchRecArray_AType
is an
array AType
element. This is an array of responses for an
address search.
Contains:
AddrSrchRec_CType
AddrSrchRec_CType
AddrSrchRec_CType
is a complex
CType
element used to define an address. This element is
optional.
Contains:
AccountId_CType
AddrInfo_CType
AddrKeyInfo_CType
Simple Elements
The following simple elements are contained within this complex.
- CustId
- The identifier attached to a customer.
AccountId_CType
AccountId_CType
is a complex
CType
element. This element contains the incoming account
identification information and any restrictions.
Simple Elements
The following simple elements are contained within this complex.
- AcctId
- The number or character that identifies an account record.
- AcctType
- The number or character that categorizes the AcctId.
- Rstr
- The level of restrictions that can exist at a parent and/or child node. Canonical
values are:
- Hid
- NoAccess
- NoAccessPart
- ReadOnly
- ReadOnlyPart
- ReadWrite
- ReadWritePart
AddrKeyInfo_CType
AddrKeyInfo_CType
is a complex
CType
element containing address key information. This
element is optional.
Simple Elements
The following simple elements are contained within this complex.
- AddrCatUse
- Address category type. Canonical values are:
- Acct - Account
- Cust - Customer
- IRSRpt - IRS Reporting
- Not - Notice
- Pmt - Payments (Distributions or interest checks)
- Seasonal
- Stmt - Statement
- AddrCat2Use
- Address category 2 type
- Cat=Not has
- AdvOfCr
- Bil
- CrBack
- EOYTax
- InsufFunds
- IRAMat
- OD
- PastDue
- RateChg
- RtnItems
- TeleTrf
- Cat=Pmt has
- EscrwRefund
- Int
- IRADistr
- XMAS
- Cat1=Stmt has
- Escrw
- IRAPeriodic
- LOC
- Periodic
Canonical values are:
- AdvOfCr
- All
- Bil
- CrBack
- EOYTax
- Escrw
- EscrwRefund
- Exc
- InsufFunds
- Int
- IRADistr
- IRAMat
- IRAPeriodic
- IRS
- LOC
- OD
- PastDue
- Periodic
- Phys
- RateChg
- RtnItems
- Seasonal
- TeleTrf
- XMAS
- Cat=Not has
- AddrKey
- Unique key string which points to an address.
- DupAddrCat2Use
- Controls if the address being added or modified represents a duplicate address and not
a replaced address for the
AddrCat2Use
element.
Custom_CType
Custom_CType
is a complex CType
element.
This element is optional.
SrchMsgRsHdr_CType
SrchMsgRsHdr_CType
is a complex
CType
element. It searches specific message response
headers.
Contains:
jXchangeHdr_CType
MsgRecInfoArray_AType
Simple Elements
The following simple elements are contained within this complex.
- Cursor
- The state information that allows the next call to understand where it left off when returning multiple records and allowing a subsequent call to retrieve more records.
- MoreRec
- Indicates if there are more records that could be returned. Canonical values are:
- false
- true
- SentRec
- The number of records sent in the response.
- TotRec
- Indicates the total records the request selected, which could be larger than
MaxRec.
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 HeaderMsgRqHdr_CType
. AuthenUsrId is ignored by the service providers when the authentication user credentialsAuthenUsrCred_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 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
- AuthenUserId
- This element deprecates in three years in accordance with XSD contract tenets.
Effective date: 2012–01–01. The new complex element for user authentication credentials
was added to 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 credentialsAuthenUsrCred_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 byWS-Security
.