Skip to main content
PUT
Update KYC Personal Details

Authorizations

x-api-key
string
header
default:lhgfaslk21490FAScVPkdsb53F9dNkfHG4faZSG5vfjndfcfgdssdgsdHF4663
required

API key of the application. Only valid together with the x-user-key header — the pair is an alternative to OAuth bearer authentication, never sent alongside it. The pair is granted the same permissions the operation's OAuth scopes describe.

Demo credential for trying the API from these docs: lhgfaslk21490FAScVPkdsb53F9dNkfHG4faZSG5vfjndfcfgdssdgsdHF4663

x-user-key
string
header
default:eyJlYW4iOiJVbnJlZ2lzdGVyZWRBcHBsaWNhdGlvbiIsImVrIjoiOE5sZ2cwcW5EUVdROUFNWGpXT2lmOWktZnpidG5KcUlqWGJ3WHJZZkpZcldrbG90ZEhvLVBjSWhQaU8xU1ZtMW84aU1WZGZqN2xWNzFjLXFxLmcybXE1dnh4Q1hUT25xaWRUaTFlcEhmVk1fIn0_
required

User-specific authentication key. Only valid together with the x-api-key header — the pair is an alternative to OAuth bearer authentication, never sent alongside it.

Demo credential for trying the API from these docs: eyJlYW4iOiJVbnJlZ2lzdGVyZWRBcHBsaWNhdGlvbiIsImVrIjoiOE5sZ2cwcW5EUVdROUFNWGpXT2lmOWktZnpidG5KcUlqWGJ3WHJZZkpZcldrbG90ZEhvLVBjSWhQaU8xU1ZtMW84aU1WZGZqN2xWNzFjLXFxLmcybXE1dnh4Q1hUT25xaWRUaTFlcEhmVk1fIn0_

Headers

x-request-id
string<uuid>
required

A unique request identifier.

Example:

"33f4e5af-764c-4624-9d1e-fbbed9bd13ce"

Body

application/json

Partial-update payload for KYC personal details. Any subset of these fields may be supplied; omitted fields are left unchanged. The gcid is taken from the authenticated session and is not accepted in the body.

firstName
string

The user's first name.

middleName
string | null

The user's middle name (optional).

lastName
string

The user's last name.

gender
integer

Gender code. Values: 0=Unspecified, 1=Male, 2=Female, 3=Other.

dateOfBirth
string<date>

The user's date of birth (ISO 8601, YYYY-MM-DD).

placeOfBirthCountry
string

ISO 3166-1 alpha-2 country code of the user's place of birth.

Example:

"US"

citizenshipCountry
string

ISO 3166-1 alpha-2 country code of the user's primary citizenship.

Example:

"US"

personalIdentification
object

A personal identification document (e.g. national ID, passport).

taxIds
object[]

Tax identifications for the user. Supports multiple jurisdictions. When supplied, this replaces the full set of tax identifications on the user record and takes precedence over the deprecated single taxId/taxIdCountry fields. At most one entry may be flagged primary; at most 10 entries; one entry per country.

taxId
string
deprecated

Deprecated. Use taxIds[]. Accepted only when taxIds[] is absent. Retained for backward compatibility.

taxIdCountry
string
deprecated

Deprecated. Use taxIds[]. ISO 3166-1 alpha-2 country code of the deprecated single tax identification. Retained for backward compatibility.

Example:

"DE"

additionalCitizenship
object

A secondary citizenship held by the user.

Response

KYC personal details updated successfully. Returns the full personal-details record after the update.

Full KYC personal-details record for the authenticated user.

gcid
integer<int64>

The user's global customer identifier.

firstName
string

The user's first name.

middleName
string | null

The user's middle name (optional).

lastName
string

The user's last name.

gender
integer

Gender code. Values: 0=Unspecified, 1=Male, 2=Female, 3=Other.

dateOfBirth
string<date>

The user's date of birth (ISO 8601, YYYY-MM-DD).

placeOfBirthCountry
string

ISO 3166-1 alpha-2 country code of the user's place of birth.

Example:

"US"

citizenshipCountry
string

ISO 3166-1 alpha-2 country code of the user's primary citizenship.

Example:

"US"

personalIdentification
object

A personal identification document (e.g. national ID, passport).

taxIds
object[]

All tax identifications held by the user, one entry per issuing country.

taxId
string
deprecated

Deprecated. Use taxIds[]. Mirrors the primary tax identification number. Retained for backward compatibility.

taxIdCountry
string
deprecated

Deprecated. Use taxIds[]. ISO 3166-1 alpha-2 country code of the primary tax identification. Retained for backward compatibility.

Example:

"DE"

additionalCitizenship
object

A secondary citizenship held by the user.