Account Validation parameters

API Header

A unique identifier assigned to a client during the onboarding process.

API Header

x-program-id       

A unique identifier assigned to a Validation Service product during onboarding.

API Header

x-program-id-type       

A unique identifier assigned to a specific Validation Services product selection. The defaults values are “AVS” program-id-type. It indicates the processing settings selected for the product and will be provided during onboarding. This is an optional parameter.

Message

codes                                 

A unique numeric identifier that ties back to a specific validation result.

Message

message

A text explanation of the code.

Message

retry-count

Transaction returns may be retried depending on the status of the first attempt. The retry-count indicates which attempt is represented in the validation response results.

requestId

To detect duplicate request, each message sent via an API is unique and must include a unique requestId. You can resend the request if your system does not receive a response due to a timeout or an exception. To ensure that the message is not processed multiple times, use the same requestId to resend the message.  When the original request is processed, the original response message content is returned.

account

Identifies account validation without other information, like account owner name validation.

entity

Identifies an individual or business (organization) for identity verification. This information can be validated on its own or in combination with account validation.

transactions

If you select the challenge test option, the transaction identifiers are submitted as part of the micro-deposits validation.

context

A debit or deposit. 

transactions

The transaction objects include the validation amounts specified in the validation request.

currency

The currency used for validation. For U.S. ACH, the currency value is “USD”

accountNumber

A unique identifier assigned to a specific account. 

clearingSystemId

A unique identifier for the clearing system.

idType

The format of the financial institution identifier. Allowed values are “ABA”, “BIC”, or “SWIFT”

individual.firstName

The account holder's first name. This field is required to authenticate account ownership.

individual.lastName

The account holder's last name. This field is required to authenticate account ownership.

individual.additionalLastName

The account holder's additional last name.

individual.middleName

The account holder's middle name or initial. If included, include only a single letter without a period.

individual.namePrefix

A prefix or a title that precedes an account holder's name.

individual.nameSuffix

A suffix or a title that follows an account holder's name.

organization.name

The business name. This field is required to authenticate account ownership.

postalAddress.addressLine

The street address.

postalAddress.unitNumber

The suite or the unit number.

postalAddress.buildingNumber

The building number.

postalAddress.buildingName

The building name.

postalAddress.streetType

The street type.

postalAddress.streetName

The street name. 

postalAddress.suburb

The suburb or district within a town or a city. .

postalAddress.townName

The town or city name. 

postalAddress.countrySubDvsn

The country sub division's name. 

postalAddress.country

The ISO country code.

postalAddress.postalCode

The postal code. 

postalAddress.county

The country name. 

contactDetails.phoneNumbers

The type of phone number, either work or home. If including area or country code include only the numeric values.

contactDetails.email

The email address.

The account holder’s personal ID type such as SSN, driver’s license, or passport.

individual.identificationId1

The account holder’s personal ID number such as driver’s license or passport number.

individual.identificationIssuer1

The state or place where the personal ID was issued.

individual.identificationType2

The personal ID type such as SSN, driver’s license, or passport.

individual.identificationId2

The personal ID number such as driver’s license or passport number.

individual.identificationIssuer2

The state or place where the personal ID was issued.

transaction.context

The transaction type. The type of transaction determines if a credit offset is required.

transaction.processControlTransactionCode

The process control transaction code.

amount.amount

The payment amount.

amount.currency

The currency. This field is required if amount is selected.

amount.checkSerialNo

A unique serial number used to verify a check. 

ResultCollection

Indicates which Validation Service feature is providing the response: individualID, businessID, individualScreening, businessScreening, individualDoc, or error. 

code

A 4-digits number used to trace and identify the service and provider associated with the response.

message

The summary validation response based on your configuration: Pass, Fail, Needs Review, No Information Found, Clear, Potential-Hit.

provider

The name of the vendor system providing the response:

Details.providerResponse

The structure that contains specific response details.

11##

Information Found

Data provider was able to process this request.

12##

No Information Found

Data provider was unable to process this request.

0

RED

The account is linked to past activity that suggests a high risk of potential fraud or compromise. 
Action: Manually review or investigate the beneficiary

1-199

RED

The account is in a low-confidence score range.
Action: Manually review/investigate the beneficiary

200-599

AMBER

The account is in a medium-confidence score range.
Action: Perform selective review/investigation of the beneficiary

600-1000

GREEN

The account is in a high-confidence score range.

provider

The name of the vendor system providing the response:

Details.providerResponse