Developer Programs

Learn

Docs
Important notification about upcoming changes to the DMZ environment. Please read.

Check Risk Inquiry

Enterprise SOAP API > API by Reference > Fraud Services > Check Risk Inquiry

Check Risk Inquiry

Check Risk Inquiry is a jXchange service designed to allow a consumer to obtain advance notification of potentially high-risk transactions.

Message Flow

In jXchange, the Check Risk Inquiry service uses a typical exchange of MType messages to obtain advance notification of potentially high-risk transactions. These could include paper or electronic Automated Clearing House (ACH) transactions against draftable accounts (such as checking, money market, and other draftable savings accounts) or non-draftable accounts, which have no check-writing privileges.

Primary Request

The third-party consumer forwards the ChkRiskInqRq_MType message to the service provider. The message contains the following simple elements.

  • Amt
  • BirthDt
  • BrCode
  • ChkNum
  • HomePhoneNum
  • ProcCntlId
  • TaxId
  • TellerNum
  • TrnAcctId
  • TrnChanType
  • TrnInstRtId
  • WorkPhoneNum

Primary Response

The service provider returns the ChkRiskInqRs_MType message to the third-party consumer. The message contains an echo of the requested simple elements.

Check Risk Inquiry Behavior

The ChkRiskInqRq_MType request message requires the TrnInstRtId, TrnAcctId, and TrnChanType simple elements.

The TrnChanType element has the following canonical values:

  • RDC - Remote Deposit Capture
  • ConsmRDC - Consumer Remote Deposit Capture
  • MobRDC - Mobile Remote Deposit Capture
  • BusRDC - Business Remote Deposit Capture
  • BrTellerId - Branch/Teller Deposit Item
  • ATM - ATM Deposit Item
  • Mail - Mail/Lockbox Deposit Item
  • ACH - ACH Electronic Deposit
  • CorrReDep - Correspondent Redeposited Item

The ChkRiskInqRq_MType request message includes the BrCode, TellerNum, Amt, ChkNum, and ProcCntlId as optional elements. The ChkRiskInqRq_MType request message includes elements designated to provide the item's account holder demographic information. Identity-to-account matching is performed using these elements. The item's account owner information enables consumers to confirm an account owner or authorized user by inquiring against account owner data contributed to a National Shared Database.

The ChkRiskInqRq_MType request message account owner's demographic information includes the PersonName_CType, Addr_CType, and IdVerify_CType complexes and the HomePhoneNum, WorkPhoneNum, TaxId, and BirthDt elements.

The ChkRiskInqRs_MType response message echoes the requested elements and encapsulates the ChkRiskInqRsRec_CType complex, which contains the elements to convey the risk as related to an item.

The TrnRiskStatArray_AType array encapsulates the elements specific to the risk related to the item. The array is a matched pair array with the TrnRiskStatType element behaving as a key for the matched pair array. The TrnRiskStatType element's canonical values are:

  • Prim - Primary
  • Secd - Secondary
  • Addl - Additional
  • Score

The TrnRiskStatRsnArray_AType array is encapsulated by the TrnRiskStatRec_CType complex and provides the reasons that a risk score/status was returned. The TrnRiskStatRsnArray_AType array is a matched pair array with the TrnRiskStatRsnCode element, which behaves as a key for the matched pair array.

The IdRiskMatchArray_AType array encapsulates the elements specific to the status of matching the account holder's demographic information. The array is a matched pair array with the IdRiskMatchType element, which behaves as a key for the matched pair array. The IdRiskMatchType element's canonical values are:

  • FullName - Full Name
  • LastName - Last Name
  • MiddleName - Middle Name
  • TitlePrefix - Title
  • NameSuffix - Name Suffix
  • ComName - Common Name
  • FullAddr - Full Address (all address components)
  • Addr - Address
  • City - City
  • StateCode - State Abbreviation
  • PostalCode - Zip/Postal Code
  • HomePhoneNum - Home Phone Number
  • WorkPhoneNum - Work Phone Number
  • TaxId - Tax Identification or Social Security Number
  • BirthDt - Birth Date
  • IdVerifyCode - Identification Verification Code
  • IdVerifyVal - Identification Verification Value
  • IdIssueBy - Identification Issuer

The IdRiskMatchStatType element provides the status of the match for the canonical values of the IdRiskMatchType. The IdRiskMatchStatType element's canonical values are:

  • Match
  • NoMatch
  • PartMatch - Partial Match
  • Unknown

ChkRiskInqRq_MType

ChkRiskInqRq_MType is a message MType element.

Contains:

  • Addr_CType
  • IdVerify_CType
  • IncXtendElem_AType
  • MsgRqHdr_CType
  • PersonName_CType

Simple Elements

The following simple elements are contained within this message.

Amt
The amount or quantity.
BirthDt
The date of birth.
BrCode
The branch code.
ChkNum
The numbers or characters assigned to monetary drafts, often times referred to as the serial number.
HomePhoneNum
The phone number.
MonstrInstrType
Does the check represent a monetary instrument like money order, cashier's check, or treasury check? Canonical values are:
  • True
  • False
ProcCntlId
The Processing Control Identification is located in position 44 on a MICR gauge. This field was designed for banks to build a degree of intelligence into the MICR line.
TaxId
The tax identifier. It includes the MaskVal, Rstr, and SrchType attributes.
TellerNum
The numbers or characters that designate the teller who initiated the transaction.
TrnAcctId
The number or character that identifies an account record.
TrnChanType
The channel used for transaction acceptance. Canonical values are:
  • ACH
  • ATM
  • BrTellerId
  • BusRDC
  • ConsmRDC
  • CorrReDep
  • Mail
  • MobRDC
  • RDC
TrnInstRtId
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.

TrnRcptId
The receipt provided for a successful transaction entry.
WorkPhoneNum
The phone number.

Addr_CType

Addr_CType is a complex CType element containing address information. This element is optional.

Contains:

  • FreeFormAddr_AType

Simple Elements

The following simple elements are contained within this complex.

BusAddr
Answers the question: Is this a business address? Y states it is a business address.
City
The city name.
Cntry
The country name.
CntryType
The country abbreviation from ISO 3166.
County
The county name.
DlvryPt
The delivery point added to the zip.
FornAddr
Is this a foreign address? Y states it is a foreign address.
InvAddr
Is this address invalid? Y states mail has been returned from this address.
PostalCode
The postal code or ZIP code.
StateCode
The 2 alpha long code which represents a state. For example, MO.
StateProv
The state or province or region.
StreetAddr1
The street address.
StreetAddr2
The second line of street address.
StreetAddr3
The third line of street address.

FreeFormAddr_AType

FreeFormAddr_AType is an array AType element. This is an array of free form address lines 1–11 in a printable/usable form.

Contains:

  • AddrLineInfo_CType
AddrLineInfo_CType

AddrLineInfo_CType is a complex CType element.

Simple Elements

The following simple elements are contained within this complex.

AddrLine
Free form element of address lines 1 - 11 in a printable/usable form, generally not separated.

IdVerify_CType

IdVerify_CType is a complex CType element. This element contains basic identification verification information and is optional.

Simple Elements

The following simple elements are contained within this complex.

IdIssueBy
The individual that issued the identification value IdVerifyId.
IdVerifyBy
The individual that verified the authenticity of the identification value IdVerifyId.
IdVerifyCode
The identification code that is used to authenticate the customer.
IdVerifyDesc
The description of the identification code that is used to authenticate the customer.
IdVerifyVal
The identification value that is used to authenticate the customer.

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.

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
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 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.

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.

ChkRiskInqRs_MType

ChkRiskInqRs_MType is a message MType element.

Contains:

  • Addr_CType
  • ChkRiskInqRsRec_CType
  • ChkRiskInqSumRec_CType
  • IdVerify_CType
  • MsgRsHdr_CType
  • PersonName_CType
  • TrnRiskStatSumArray references TrnRiskStatArray_AType
  • x_ChkRiskAuxInqRec_CType

Simple Elements

The following simple elements are contained within this message.

Amt
The amount or quantity.
BirthDt
The date of birth.
BrCode
The branch code.
ChkNum
The numbers or characters assigned to monetary drafts, often times referred to as the serial number.
HomePhoneNum
The phone number.
MonstrInstrType
Does the check represent a monetary instrument like money order, cashier's check, or treasury check? Canonical values are:
  • True
  • False
ProcCntlId
The Processing Control Identification is located in position 44 on a MICR gauge. This field was designed for banks to build a degree of intelligence into the MICR line.
TaxId
The tax identifier. It includes the MaskVal, Rstr, and SrchType attributes.
TellerNum
The numbers or characters that designate the teller who initiated the transaction.
TrnAcctId
The number or character that identifies an account record.
TrnChanType
The channel used for transaction acceptance. Canonical values are:
  • ACH
  • ATM
  • BrTellerId
  • BusRDC
  • ConsmRDC
  • CorrReDep
  • Mail
  • MobRDC
  • RDC
TrnInstRtId
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.

TrnRcptId
The receipt provided for a successful transaction entry.
WorkPhoneNum
The phone number.

Addr_CType

Addr_CType is a complex CType element containing address information. This element is optional.

Contains:

  • FreeFormAddr_AType

Simple Elements

The following simple elements are contained within this complex.

BusAddr
Answers the question: Is this a business address? Y states it is a business address.
City
The city name.
Cntry
The country name.
CntryType
The country abbreviation from ISO 3166.
County
The county name.
DlvryPt
The delivery point added to the zip.
FornAddr
Is this a foreign address? Y states it is a foreign address.
InvAddr
Is this address invalid? Y states mail has been returned from this address.
PostalCode
The postal code or ZIP code.
StateCode
The 2 alpha long code which represents a state. For example, MO.
StateProv
The state or province or region.
StreetAddr1
The street address.
StreetAddr2
The second line of street address.
StreetAddr3
The third line of street address.

FreeFormAddr_AType

FreeFormAddr_AType is an array AType element. This is an array of free form address lines 1–11 in a printable/usable form.

Contains:

  • AddrLineInfo_CType
AddrLineInfo_CType

AddrLineInfo_CType is a complex CType element.

Simple Elements

The following simple elements are contained within this complex.

AddrLine
Free form element of address lines 1 - 11 in a printable/usable form, generally not separated.

ChkRiskInqRsRec_CType

ChkRiskInqRsRec_CType is a complex CType element.

Contains:

  • IdRiskMatchArray_AType
  • TrnRiskStatArray_AType

Simple Elements

The following simple elements are contained within this complex.

ChkHasAlerts
The check submitted has alerts that should be considered. Canonical values are:
  • false
  • true
ChkHoldAmt
The minimum amount that should be placed on hold for a check.
ChkHoldDays
The number of days hold placed on a check.
ChkNumEnd
The numbers or characters that designate an ending point for check number selections.
ChkNumStart
The numbers or characters that designate a starting point for check number selections.
ChkRiskAbbCode
A code for the abbreviated description for check risk inquiry.
ChkRiskAbbDesc
A description of the code for the abbreviated description for check risk inquiry.
ChkRiskActDesc
A descriptive action or steps that should be taken for a specific check item.
ChkRiskPrvdType
The check risk provider. Canonical values are:
  • AFS
  • EarlyWarn
ClsDt
The closing date.
IdRiskMatchScore
The overall score of the account ownership matching.
LastRetTrnMoYr
The last month and year transactions were returned for a specific account.
LastRiskRptDt
The date that the account was last reported to a risk provider.
OpenDt
The date opened.
RetRsnCode
The code that describes the reason an account/draft item was returned.
RetRsnDesc
The description of the code that describes the reason an account/draft item was returned.
RetTrnCnt
The number of transactions returned for a specific account.
StopChkAmt
The amount or quantity.
StopChkExpDt
The expiration date.
TrnDsptPend
Answers the question: Is a consumer disputing a transaction? Canonical values are:
  • false
  • true
TrnRiskRcptId
A receipt identifier provided by the transaction risk provider.

IdRiskMatchArray_AType

IdRiskMatchArray_AType is an array AType element. This is an array of identity risk statues.

Contains:

  • IdRiskMatchRec_CType
IdRiskMatchRec_CType

IdRiskMatchRec_CType is a complex CType element.

Simple Elements

The following simple elements are contained within this complex.

IdRiskMatchType
The type of the identity match. Canonical values are:
  • Addr
  • BirthDt
  • City
  • ComName
  • FullAddr
  • FullName
  • HomePhoneNum
  • IdIssueBy
  • IdVerifyVal
  • IdVerifyCode
  • LastName
  • MiddleName
  • NameSuffix
  • PostalCode
  • StateCode
  • TaxId
  • TitlePrefix
  • WorkPhoneNum
IdRiskMatchStatType
The status of the identity match. Canonical values are:
  • Match
  • NoMatch
  • PartMatch
  • Unknown

TrnRiskStatArray_AType

TrnRiskStatArray_AType is an array AType element. This is an array of transaction risk statues.

Contains:

  • TrnRiskStatRec_CType
TrnRiskStatRec_CType

TrnRiskStatRec_CType is a complex CType element.

Contains:

  • TrnRiskStatRsnArray_AType
Simple Elements

The following simple elements are contained within this complex.

TrnRiskColStat
The risk of not collecting for an item. Canonical values are:
  • High
  • Low
  • Med
  • None
TrnRiskSrcDesc
The source description of the transaction risk state.
TrnRiskStatCode
The transaction risk status code.
TrnRiskStatDesc
The description of the transaction risk status code.
TrnRiskStatPrevCode
The transaction risk status code.
TrnRiskStatType
The transaction risk statues type. Canonical values are:
  • Addl
  • Prim
  • RecomActn
  • Score
  • Secd
TrnRiskStatRsnArray_AType

TrnRiskStatRsnArray_AType is an array AType element. This is an array of reasons for the transaction risk statues.

Contains:

  • TrnRiskStatRsnRec_CType
TrnRiskStatRsnRec_CType

TrnRiskStatRsnRec_CType is a complex CType element.

Simple Elements

The following simple elements are contained within this complex.

TrnRiskStatRsnCode
The transaction risk status reason code.
TrnRiskStatRsnDesc
The description of the transaction risk status reason code.

ChkRiskInqSumRec_CType

ChkRiskInqSumRec_CType is a complex CType element.

Contains:

  • TrnRiskStatArray_AType

Simple Elements

The following simple elements are contained within this complex.

ChkHasAlerts
The check submitted has alerts that should be considered. Canonical values are:
  • false
  • true
ChkHoldAmt
The minimum amount that should be placed on hold for a check.
ChkHoldDays
The number of days hold placed on a check.
ChkRiskAbbCode
A code for the abbreviated description for check risk inquiry.
ChkRiskAbbDesc
A description of the code for the abbreviated description for check risk inquiry.
ChkRiskActDesc
A descriptive action or steps that should be taken for a specific check item.
TrnRcptId
The receipt provided for a successful transaction entry.

IdVerify_CType

IdVerify_CType is a complex CType element. This element contains basic identification verification information and is optional.

Simple Elements

The following simple elements are contained within this complex.

IdIssueBy
The individual that issued the identification value IdVerifyId.
IdVerifyBy
The individual that verified the authenticity of the identification value IdVerifyId.
IdVerifyCode
The identification code that is used to authenticate the customer.
IdVerifyDesc
The description of the identification code that is used to authenticate the customer.
IdVerifyVal
The identification value that is used to authenticate the customer.

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
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 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.

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.

TrnRiskStatSumArray

TrnRiskStatArray_AType is an array AType element. This is an array of transaction risk statues.

TrnRiskStatSumArray references TrnRiskStatArray_AType.

Contains:

  • TrnRiskStatRec_CType

TrnRiskStatRec_CType

TrnRiskStatRec_CType is a complex CType element.

Contains:

  • TrnRiskStatRsnArray_AType
Simple Elements

The following simple elements are contained within this complex.

TrnRiskColStat
The risk of not collecting for an item. Canonical values are:
  • High
  • Low
  • Med
  • None
TrnRiskSrcDesc
The source description of the transaction risk state.
TrnRiskStatCode
The transaction risk status code.
TrnRiskStatDesc
The description of the transaction risk status code.
TrnRiskStatPrevCode
The transaction risk status code.
TrnRiskStatType
The transaction risk statues type. Canonical values are:
  • Addl
  • Prim
  • RecomActn
  • Score
  • Secd
TrnRiskStatRsnArray_AType

TrnRiskStatRsnArray_AType is an array AType element. This is an array of reasons for the transaction risk statues.

Contains:

  • TrnRiskStatRsnRec_CType
TrnRiskStatRsnRec_CType

TrnRiskStatRsnRec_CType is a complex CType element.

Simple Elements

The following simple elements are contained within this complex.

TrnRiskStatRsnCode
The transaction risk status reason code.
TrnRiskStatRsnDesc
The description of the transaction risk status reason code.

x_ChkRiskAuxInqRec_CType

x_ChkRiskAuxInqRec_CType is a complex CType element.

Contains:

  • ChkRiskAlertArray_AType
  • TrnRiskStatArray_AType

Simple Elements

The following simple elements are contained within this complex.

AcctStat
The account status.
ChkHasAlerts
The check submitted has alerts that should be considered. Canonical values are:
  • false
  • true
ChkRiskAbbCode
A code for the abbreviated description for check risk inquiry.
ChkRiskAbbDesc
A description of the code for the abbreviated description for check risk inquiry.
ChkHoldAmt
The minimum amount that should be placed on hold for a check.
ChkHoldDays
The number of days hold placed on a check.
ChkRiskActDesc
A descriptive action or steps that should be taken for a specific check item.
ChkRiskPrvdType
The check risk provider. Canonical values are:
  • AFS
  • EarlyWarn
ClsDt
The closing date.
CrtStatTimeDt
The date and time stamp of the status creation. Expressed in ISO 8601 time format and contains either Zulu time or local time and the UTC offset. Format: [-]CCYY-MM-DDThh:mm:ss[Z|(+|-)hh:mm] Valid values include:
  • 2001-10-26T21:32:52
  • 2001-10-26T21:32:52+02:00
  • 2001-10-26T19:32:52Z
  • 2001-10-26T19:32:52+00:00
  • 2001-10-26T21:32:52
  • 2001-10-26T21:32:52.12679

Examples of the same moment:

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

See http://books.xmlschemata.org/relaxng/ch19-77049.html or http://en.wikipedia.org/wiki/ISO_8601 for further reference.

LastStatTimeDt
The date and time stamp the last time the status changed. Expressed in ISO 8601 time format and contains either Zulu time or local time and the UTC offset. Format: [-]CCYY-MM-DDThh:mm:ss[Z|(+|-)hh:mm] Valid values include:
  • 2001-10-26T21:32:52
  • 2001-10-26T21:32:52+02:00
  • 2001-10-26T19:32:52Z
  • 2001-10-26T19:32:52+00:00
  • 2001-10-26T21:32:52
  • 2001-10-26T21:32:52.12679

Examples of the same moment:

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

See http://books.xmlschemata.org/relaxng/ch19-77049.html or http://en.wikipedia.org/wiki/ISO_8601 for further reference.

OpenDt
The date opened.
TrnRcptId
The receipt provided for a successful transaction entry.

ChkRiskAlertArray_AType

ChkRiskAlertArray_AType is an array AType element. This is an array of check risk alerts.

Contains:

  • ChkRiskAlertRec_CType
ChkRiskAlertRec_CType

ChkRiskAlertRec_CType is a complex CType element.

Contains:

  • ChkSignerAddr references Addr_CType
  • ChkSignerName references PersonName_CType
  • TrnRiskStatArray_AType
Simple Elements

The following simple elements are contained within this complex.

AlrtCrtTimeDt
The date and time an alert event occurred. This is expressed in ISO 8601 time format and should 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.

Amt
The amount or quantity.
ChkRiskActDesc
A descriptive action or steps that should be taken for a specific check item.
ChkNum
The numbers or characters assigned to monetary drafts, often times referred to as the serial number.
LastRiskRptTimeDt
The date and time stamp of the last reporting for an alert. Expressed in ISO 8601 time format and contains either Zulu time or local time and the UTC offset. Format: [-]CCYY-MM-DDThh:mm:ss[Z|(+|-)hh:mm] Valid values include:
  • 2001-10-26T21:32:52
  • 2001-10-26T21:32:52+02:00
  • 2001-10-26T19:32:52Z
  • 2001-10-26T19:32:52+00:00
  • 2001-10-26T21:32:52
  • 2001-10-26T21:32:52.12679

Examples of the same moment:

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

See http://books.xmlschemata.org/relaxng/ch19-77049.htmlor http://en.wikipedia.org/wiki/ISO_8601 for further reference.

MonstrInstrType
Does the check represent a monetary instrument like money order, cashier's check, or treasury check? Canonical values are:
  • True
  • False
PrivAlrtType
Is the alert specific private? Canonical values are:
  • True
  • False
TrnAcctId
The number or character that identifies an account record.
TrnInstRtId
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.

ChkSignerAddr

Addr_CType is a complex CType element containing address information. This element is optional.

ChkSignerAddr references Addr_CType.

Contains:

  • FreeFormAddr_AType
Simple Elements

The following simple elements are contained within this complex.

BusAddr
Answers the question: Is this a business address? Y states it is a business address.
City
The city name.
Cntry
The country name.
CntryType
The country abbreviation from ISO 3166.
County
The county name.
DlvryPt
The delivery point added to the zip.
FornAddr
Is this a foreign address? Y states it is a foreign address.
InvAddr
Is this address invalid? Y states mail has been returned from this address.
PostalCode
The postal code or ZIP code.
StateCode
The 2 alpha long code which represents a state. For example, MO.
StateProv
The state or province or region.
StreetAddr1
The street address.
StreetAddr2
The second line of street address.
StreetAddr3
The third line of street address.
FreeFormAddr_AType

FreeFormAddr_AType is an array AType element. This is an array of free form address lines 1–11 in a printable/usable form.

Contains:

  • AddrLineInfo_CType
AddrLineInfo_CType

AddrLineInfo_CType is a complex CType element.

Simple Elements

The following simple elements are contained within this complex.

AddrLine
Free form element of address lines 1 - 11 in a printable/usable form, generally not separated.
ChkSignerName

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

ChkSignerName references PersonName_CType.

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.
TrnRiskStatArray_AType

TrnRiskStatArray_AType is an array AType element. This is an array of transaction risk statues.

Contains:

  • TrnRiskStatRec_CType
TrnRiskStatRec_CType

TrnRiskStatRec_CType is a complex CType element.

Contains:

  • TrnRiskStatRsnArray_AType
Simple Elements

The following simple elements are contained within this complex.

TrnRiskColStat
The risk of not collecting for an item. Canonical values are:
  • High
  • Low
  • Med
  • None
TrnRiskSrcDesc
The source description of the transaction risk state.
TrnRiskStatCode
The transaction risk status code.
TrnRiskStatDesc
The description of the transaction risk status code.
TrnRiskStatPrevCode
The transaction risk status code.
TrnRiskStatType
The transaction risk statues type. Canonical values are:
  • Addl
  • Prim
  • RecomActn
  • Score
  • Secd
TrnRiskStatRsnArray_AType

TrnRiskStatRsnArray_AType is an array AType element. This is an array of reasons for the transaction risk statues.

Contains:

  • TrnRiskStatRsnRec_CType
TrnRiskStatRsnRec_CType

TrnRiskStatRsnRec_CType is a complex CType element.

Simple Elements

The following simple elements are contained within this complex.

TrnRiskStatRsnCode
The transaction risk status reason code.
TrnRiskStatRsnDesc
The description of the transaction risk status reason code.

TrnRiskStatArray_AType

TrnRiskStatArray_AType is an array AType element. This is an array of transaction risk statues.

Contains:

  • TrnRiskStatRec_CType
TrnRiskStatRec_CType

TrnRiskStatRec_CType is a complex CType element.

Contains:

  • TrnRiskStatRsnArray_AType
Simple Elements

The following simple elements are contained within this complex.

TrnRiskColStat
The risk of not collecting for an item. Canonical values are:
  • High
  • Low
  • Med
  • None
TrnRiskSrcDesc
The source description of the transaction risk state.
TrnRiskStatCode
The transaction risk status code.
TrnRiskStatDesc
The description of the transaction risk status code.
TrnRiskStatPrevCode
The transaction risk status code.
TrnRiskStatType
The transaction risk statues type. Canonical values are:
  • Addl
  • Prim
  • RecomActn
  • Score
  • Secd
TrnRiskStatRsnArray_AType

TrnRiskStatRsnArray_AType is an array AType element. This is an array of reasons for the transaction risk statues.

Contains:

  • TrnRiskStatRsnRec_CType
TrnRiskStatRsnRec_CType

TrnRiskStatRsnRec_CType is a complex CType element.

Simple Elements

The following simple elements are contained within this complex.

TrnRiskStatRsnCode
The transaction risk status reason code.
TrnRiskStatRsnDesc
The description of the transaction risk status reason code.

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