v5

latestOpenAPI 3.1.02026-07-262421791.5 MB

profile

Update an identification document

Update an existing identification document on a personal profile. Not applicable to business profiles.

This endpoint performs a full replacement of the document details. Any fields not provided in the request body will be set to null on the stored document. Partners must provide all fields they wish to retain.

Only partners with a KYC partner onboarding model are permitted to use this endpoint. Non-KYC partners will receive a 400 error.

put/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

clientIdstring required

The partner's client ID.

firstNamestring

Person first name in document.

lastNamestring

Person last name in document.

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.

sex'MALE' | 'FEMALE'

Sex as stated in the document.

placeOfBirthstring

Place of birth as stated in the document.

Example request

{
  "clientId": "mercury",
  "firstName": "Oliver",
  "lastName": "Wilson",
  "type": "IDENTITY_CARD",
  "uniqueIdentifier": "AA299822313",
  "issueDate": "2017-12-31",
  "issuerCountry": "EE",
  "expiryDate": "2027-12-31",
  "sex": "MALE",
  "placeOfBirth": "London"
}

Response

Identification document updated successfully.

errorMessagestring nullable

successboolean

Example response

{
  "success": true
}