Sign in

v5

latestOpenAPI 3.1.02026-07-262421791.5 MB
profile

Create an identification document

Add an identification document to a personal profile. Not applicable to business profiles.

For SSN submissions, only type and uniqueIdentifier (9 digits, no letters or symbols) are required.

post/v1/profiles/{profileId}/verification-documents

Path parameters

profileIdinteger required

Profile ID.

Headers

X-External-Correlation-Idstring uuid

Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. Learn more.

Request body

firstNamestring

Person first name in document.

lastNamestring

Person last name in document.

type'DRIVERS_LICENCE' | 'IDENTITY_CARD' | 'GREEN_CARD' | 'MY_NUMBER' | 'PASSPORT' | 'SSN' | 'EMIRATES_EMPLOYER' | 'EMIRATES_PLACE_OF_BIRTH' | 'CPF_CNPJ' | 'FINANCIAL_CAPACITY_BR' | 'OTHER'

Document type.

uniqueIdentifierstring

Document number or value. Must be digits only when SSN or FINANCIAL_CAPACITY_BR.

issueDatestring

Document issue date.

issuerCountrystring

Issued by country code. For example "US".

issuerStatestring

Issued by state code. For example "NY".

expiryDatestring

Document expiry date.

nationalitystring

2 characters ISO country code.

employerNamestring

The name of the employer. Type must be EMIRATES_EMPLOYER.

employerCitystring

The city of the employer. Type must be EMIRATES_EMPLOYER.

employerCountrystring

2 characters ISO country code. Type must be EMIRATES_EMPLOYER.

birthCitystring

The city of birth of the customer.

birthCountrystring

2 characters ISO country code.

Example request

{
  "firstName": "Oliver",
  "lastName": "Wilson",
  "type": "IDENTITY_CARD",
  "uniqueIdentifier": "AA299822313",
  "issueDate": "2017-12-31",
  "issuerCountry": "EE",
  "expiryDate": "2027-12-31"
}

Response

Identification document created successfully.

errorMessagestring nullable
successboolean

Example response

{
  "success": true
}