FASB91 Search
FASB 91 Search is a jXchange service created to search for existing FASB 91 information on a Service Provider.
Message Flow
FASB 91 Search is contained
within MType
complexes exchanged between the Service
Provider and the Third Party Consumer.
Primary Request
The Third Party Consumer
forwards the FASB91SrchRq_MType
element containing
the consumer’s name, account number and type, customer ID, Tax ID,
the consumer’s Federal Tax ID number and/or the FASB 91 category.
Primary Response
The Service Provider returns
the FASB91SrchRs_MType
element to the Third Party
Consumer. The message contains the FASB91Cat
element
to reiterate the requested category, and the FASB91SrchRec_CType
complex to define the returned information.
FASB91SrchRq_MType
FASB91SrchRq_MType
is a message
MType
element.
Contains:
Custom_CType
IncXtendElemArray_AType
PersonName_CType
SrchMsgRqHdr_CType
Simple Elements
The following simple elements are contained within this message.
- CustId
- The identifier attached to a customer.
- FASB91AcctId
- The number or character that identifies an account record.
- FASB91AcctType
- The number or character that categorizes the AcctId.
- FASB91Cat
- The category of the type of FASB account. Canonical values are:
- Cost
- Fee
- TaxId
- The tax identifier. It includes the
MaskVal
,Rstr
, andSrchType
attributes.
Custom_CType
Custom_CType
is a complex CType
element.
This element is optional.
IncXtendElemArray_AType
IncXtendElemArray_AType
is an array
AType
element.
Contains:
IncXtendElemInfo_CType
IncXtendElemInfo_CType
IncXtendElemInfo_CType
is a complex
CType
element.
Simple Elements
The following simple elements are contained within this complex.
- XtendElem
- Included extended elements. The consumer would ask by name for x_ prefix elements to be included in the response.
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.
- 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.
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
.
FASB91SrchRs_MType
FASB91SrchRs_MType
is a message
MType
element.
Contains:
Custom_CType
FASB91RecArray_AType
SrchMsgRsHdr_CType
Simple Elements
The simple elements contained within this message are listed below.
- FASB91Cat
- The category of the type of FASB account. Canonical values are:
- Cost
- Fee
Custom_CType
Custom_CType
is a complex CType
element.
This element is optional.
FASB91SrchRecArray_AType
FASB91SrchRecArray_AType
is an
array AType
element. This is an array of responses for a
FASB 91 search.
Contains:
FASB91SrchRec_CType
FASB91SrchRec_CType
FASB91SrchRec_CType
is a complex
CType
element.
Contains:
CustomFASB91SrchRec
referencesCustom_CType
FASB91InfoRec_CType
PersonName_CType
Simple Elements
The simple elements contained within this complex are listed below.
- CustId
- The identifier attached to a customer.
- FASB91AcctId
- The number or character that identifies an account record.
- FASB91AcctType
- The number or character that categorizes the AcctId.
- FASB91AmrtzDesc
- The description of the code that identifies the type of amortization method to be used.
- FASB91AmrtzSoldDesc
- The description of the code that identifies if the FASB record should continue to be amortized after the sale of the loan on the secondary market.
- FASB91BrDesc
- A description of the branch name. It includes the
Rstr
attribute. - FASB91GLProdDesc
- The GL product code provided for bank use in reporting the account to a specific GL product code.
- FASB91GroupDesc
- The code that is used to group loans of different types for general ledger reporting purposes. It may also be used to group customer accounts together.
- FASB91Key
- This element is returned in search/inquiry requests and is needed to modify or delete a FASB record.
- FASB91OddDayDesc
- The description of the code that defines the behavior of the first payment odd days accrual.
- FASB91ProdDesc
- Description of the type of account.
- FASB91TypeDesc
- The description of the code that identifies the type of FASB record.
- TaxId
- The tax identifier. It includes the
MaskVal
,Rstr
, andSrchType
attributes.
CustomFASB91SrchRec
Custom_CType
is a complex CType
element.
CustomFASB91SrchRec
references Custom_CType
.
This element is optional.
FASB91InfoRec_CType
FASB91InfoRec_CType
is a complex
CType
element.
Simple Elements
The simple elements contained within this complex are listed below.
- FASB91AmrtzCode
- The code that identifies the type of amortization method to be used.
- FASB91AmrtzSoldCode
- The code that identifies if the FASB record should continue to be amortized after the sale of the loan on the secondary market.
- FASB91AmrtzTerm
- The amount of time the FASB record should be amortized.
- FASB91AmrtzTermUnit
- The time unit to amortize the FASB record. Canonical values are:
- Days
- Months
- NA
- SemiMonthly
- Years
- FASB91AutoChg
- The FASB record should automatically be aligned with the corresponding loan account record.
- FASB91BrCode
- The branch code.
- FASB91CustId
- The identifier attached to a customer.
- FASB91Fee
- The gross amount of fees collected.
- FASB91FirstPmtDt
- The first payment date.
- FASB91GLCostCtr
- The GL cost center provided for bank use in reporting the account to a specific GL cost center.
- FASB91GLProdCode
- The GL product code provided for bank use in reporting the account to a specific GL product code.
- FASB91GroupCode
- Used to group loans of different types for general ledger reporting purposes. It may also be used to group customer accounts together.
- FASB91IntRate
- The interest rate.
- FASB91LastMainDt
- The last maintenance date.
- FASB91LOC
- The FASB91 record for a line of credit.
- FASB91MatDt
- The amortization maturity date which can differ from the loan maturity date.
- FASB91NxtProcDt
- The date that references when the FASB record should be processed.
- FASB91OddDayCode
- The code that defines the behavior of the first payment odd days accrual.
- FASB91OrigDt
- The original loan date for FASB calculations.
- FASB91PmtDayOfMonth
- The day of month for payment. This code is only required if the payment due date is the 29th of the month.
- FASB91Proceed
- The original amount of the FASB record.
- FASB91RptFee
- The amount of fees reported for the FASB record.
- FASB91SemiDay1
- The day of month for first semi-monthly payment.
- FASB91SemiDay2
- The day of month for second semi-monthly payment.
- FASB91TypeCode
- The code that identifies the type of FASB record.
- FASB91Yield
- The FASB yield for interest yield calculations.
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
.