Validation Services

Entity Validation parameters

This page provides information on the required fields for Entity and Document Validation. All required fields must be included for a request to be successful, while optional (or non-required) fields add extra functionality.

Tip

This page serves as an overview of required fields. For detailed JSON specifications when constructing a request, refer to the API specification.

Validation Services assigned values

The following table provides details on the predefined values assigned to the API header and messages for Validation Services.

Assigned parameters
Object	Field	Description
API Header	`x-client-id`	A unique identifier assigned to a client during the onboarding process.
API Header	`x-program-id`	A unique identifier assigned to a Validation Services product during onboarding.
API Header	`x-program-id-type`	A unique identifier assigned to a specific Validation Services product selection. The default value is “AVS” for program-id-type. It indicates the processing settings selected for the product and is 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 numeric 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.

Values you can assign

The following table lists the required fields you must include in your request to perform successful validation.

Required fields

Assignable required parameters
Field	Description
`requestId`	To detect duplicate requests, 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, such as account owner name validation.
`entity`	Indicates an individual or a business. This information can be validated on its own or in combination with account validation.
`organization.name`	Indicates the organization’s name. This is a required field when authenticating an organization.
`individual.firstName`	Indicates the individual’s first name. This is a required field when authenticating an individual.
`individual.lastName`	Indicates the individual’s last name. This is a required field when authenticating an individual.

Optional Fields

The following table lists the optional fields you can include in your request to provide additional information or functionality.

Assignable optional parameters
Field	Description
`individual.additionalLastName`	The individual’s additional last name.
`individual.middleName`	The individual’s middle name or initial. If included, use 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.
`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 name within a town or city.
`postalAddress.townName`	The town or city name.
`postalAddress.countrySubDvsn`	The state or province name.
`postalAddress.country`	The ISO country code.
`postalAddress.postalCode`	The zip or postal code. Only numeric values.
`postalAddress.county`	The county name.
`postalAddress.homePhone`	The home phone number, including area or country code
`postalAddress.workPhone`	The work phone number, including area or country code.
`postalAddress.email`	The email address.
`phoneNumbers.dateOfBirth`	The date of birth in YYYYMMDD format.
`identification.type2`	The personal ID type.
`identification.Id1`	The first identification ID of the individual. It can be personal ID, SSN, driver’s license, or passport number.
`identification.issuer2`	The state or place that issued the first identification ID.
`identification.type2`	The individual's personal ID type.
`identification.Id2`	The second identification ID. It can be personal ID, SSN, driver’s license, or passport number.
`identification.issuer2`	The state or place that issued the first identification ID.
`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 an amount is provided.
`amount.checkSerialNo`	A unique serial number used to verify a check.

Results messages

The following table explains the result fields returned by Validation Services, along with their descriptions.

Result messages
Field	Description
`ResultCollection`	Indicates which Validation Service feature is providing the response: individualID, businessID, individualScreening, businessScreening, individualDoc, error.
`code`	A four-digit code used to trace the service and provider associated with the response.
`message`	Summary validation response based on your configuration: Pass, Fail, Needs Review, No Information Found, Clear, or Potential-Hit.

Redirect URL

The following table lists the redirect URL fields required for document validation sessions.

Redirect URL
Field	Description
`accessToken`	An IDAnywhere access token used for authorization.
`sessionToken`	A unique ID tied to the SSO session.
`redirectUrl`	The URL to which users are redirected after a successful document validation session.

Validation provider response details

The following table lists the details of the response returned by the validation provider

Provider response details
Field	Description
`provider`	The name of the vendor system providing the response:
`Details.providerResponse`	The structure that contains provider-specific response details.

For more information about Entity Validation, see Overview.

Next steps

Learn more about the available resources.