Skip to main content
PATCH
curl

Authorizations

API-Key
string
header
required

Your public API key. Identifies the partner making the request.

API-Sign
string
header
required

HMAC signature over the request, computed with your private key.

API-Timestamp
string
header
required

Time the request was signed, as Unix milliseconds. Included in the request signature. Requests signed too far from the server's time are rejected.

Path Parameters

user_id
string
required

Globally unique public identifier for a user.

Required string length: 14 - 42

Body

application/json

Changes to the user's verification profile.

full_name
object | null

Complete legal name replacement. Empty objects leave the stored name unchanged, and null deletes it.

residence
object | null

Sparse residential address changes. Empty objects leave the address unchanged, and null deletes the entire address.

birth
object | null

Sparse birth detail changes. Empty objects leave birth details unchanged, and null deletes all stored birth details.

client_identifier
object | null

Complete identifier replacement. concat requires a value and calculation time; passport, national ID and tax ID require a value only; unknown carries neither. Empty objects leave the stored identifier unchanged.

phone
string | null

Contact phone number. Null deletes the stored number.

Maximum string length: 16
Pattern: ^(\+?[1-9][0-9]{1,14})?$
occupation
string | null

Occupational category. Null deletes the stored occupation.

Pattern: ^(agriculture|business_management|computers_and_it|construction|education|finance|government|healthcare|hospitality|manufacturing|marketing|media|other|science|self_employed|student|transportation|unemployed|employed)?$
employer_name
string | null

Employer name. Null deletes the stored employer.

Maximum string length: 256
nationalities
string[] | null

Replacement nationalities. Null deletes all stored nationalities.

Pattern: ^[A-Z]{2}$
tax_ids
object[] | null

Replacement tax identifiers, with one identifier per issuing country. Null deletes all stored tax identifiers.

Response

Profile update accepted.

data
enum<string>
required

Result of the profile update.

Available options:
success