Identification Request Elements

The following table details the elements in your requests to the Paysafe Identity Verification API.

Element Child Element Required Type Description
merchantRefNum Required

String

Max= 50

This is your own request ID, for your reference purposes. This should be unique for each request.
profile Required
firstName Required

String

Max= 50

This is the business owner's first name.
middleName Optional

String

Max= 50

This is the business owner's middle name.
lastName Required

String

Max= 50

This is the business owner's last name.
ssn Conditional

String

Max = 15

This is the business owner's Social Security Number or Social Insurance Number.

The ssn field is required for U.S. merchants only.

email Optional

String

Max = 255

This is the business owner's email address.
locale Optional String

For Canadian merchants, this specifies whether to get responses in English or French. Possible values are:

  • en-CA (English)
  • fr-CA (French)
billingDetails Required
Child Elements of billingDetails
apartment Optional

String

Max = 50

This is the business owner's apartment number, if applicable.
street Required

String

Max = 255

This is the business owner's street name and number.
street2 Optional

String

Max = 255

This is the second line of the business owner's street address.
city Required

String

Max = 255

This is the city in which the business owner lives.
zip Required

String

Max = 15

This is the business owner's zip/postal code.
state Required

String

Max = 2

This is the state or province in which the business owner lives. See ISO Codes for the correct codes to use.

country Required

String

Max = 2

This is the country in which the business owner lives. See ISO Codes for the correct codes to use.
phone Optional

String

Max = 15

This is the business owner’s phone number.

Do not include spaces, hyphens, or parentheses.

dateOfBirth Conditional The dateOfBirth fields are required for Canadian merchants.
Child Elements of dateOfBirth
day Conditional

Int

Min = 1

Max = 31

This is the day of the business owner's birth. Required if dateOfBirth provided.
month Conditional

Int

Min = 1

Max = 12

This is the month of the business owner's birth. Required if dateOfBirth provided.
year Conditional

Int

Total = 4

Min = 1900

This is the year of the business owner's birth. Required if dateOfBirth provided.
customerIp Optional

String

Max = 15

This is the business owner's incoming IP address.

When sending Identification Verification request to the Production (Live) environment for a U.S. merchant application, do not use letters that have accents. For example, if the value for firstName is "André", enter it as "Andre".

Identification Request Response Elements

The following table details the elements in your responses from the Paysafe Identity Verification API.

Element Child Element Required Type Description
id Required

String

Max = 36

This is the ID assigned to the initial request, returned in the response.
status Required Enum

This is the status of the request. Possible values are:

  • PASS
  • FAIL
gatewayRawResponse Optional String This is a Base64-encoded string that is returned only by some providers, depending on your configuration with Paysafe.
questionSetId Optional String This is the ID of the question set for you to present to business owner.
questionType Optional Enum

This is the type of question(s) to be posed to the business owner. Possible values are:

  • CHALLENGE
questions Optional String This consists of the number and text of each question to be posed to the business owner, along with the possible answers for each question.
links Required
rel Required String

In the response, this is the link type that allows different endpoints to be targeted depending on the end state of the transaction.

href Required String

In the response, this is the URI of the resource. Where the value for rel is followupquestions, the value for href is the complete endpoint to which you send the PUT for the Challenge Question request.

For example, it will look like this:
https://api.test.paysafe.com/identity/v1/accounts/1001000000/identifications/1645333/challengeQuestions/655555

Did you find this page useful?