Skip to main content
PUT
Updates fields on an existing customer. Only the provided fields are modified; omitted fields remain unchanged. Fields not listed below, such as externalId, are ignored.
The walletAddress and status fields change the record only, never the registry. A new wallet address replaces the primary outright. The old primary is dropped rather than kept as a linked wallet. The record’s status, verifiedAt and kycHash stay as they were. Sending null removes the primary.These fields can still reach the registry later. When the instance switches identity registers, each verified record that holds a kycHash is queued for registration on the new register, with that kycHash, under its current primary.To swap primaries and keep the old one, use Add Wallet and then Promote Wallet.

Path Parameters

string
required
Customer ID.

Body Parameters

string
Updated display name.
string
ISO 3166-1 alpha-2, alpha-3 or numeric code, stored as alpha-3. null or an empty string clears it.
string
The same values as on Create Customer: a preset or the key of one of your custom verification profiles, in any letter case, stored as the profile spells it. null, an empty string, or the record’s current type in another letter case leaves the type as it is, also when that profile is disabled. Moving the record onto a disabled profile is refused with INVALID_INVESTOR_TYPE. Anything else, a number included, is refused with INVALID_INVESTOR_TYPE.
string
Replaces the primary wallet. Stored checksummed. Read the warning above before sending it.
string
pending, active, verified, revoked or rejected, in any letter case, stored in lowercase. Any other value, null included, is refused with INVALID_STATUS. It is not checked against the registry. Setting revoked on a record that was not revoked also stamps revokedAt.A verified status set here marks the record only. It does not count as a verification completed on your instance, so a lending market priced from a live market price still refuses a professional client whose status was set this way with NOT_VERIFIED, unless one of its wallets is admitted to a professional profile. See Client of record.
object
Updated metadata. Replaces existing metadata entirely. The platform keeps idLinks here, the ID links created for this customer, and on an ERC-3643 register also onchainId and onchainIdTxHash. Carry all three over. Without idLinks, an older ID link no longer finds this customer when it completes, and can create a second record or be refused. Without the ONCHAINID fields, registering a wallet that is not yet on the register plans a new ONCHAINID deployment instead of reusing the one already deployed.
string
A base64 data URL of a PNG, JPEG, WEBP or GIF image, up to 250,000 characters. Stored as metadata.avatarUrl. null or an empty string removes it.
string[]
Replaces the list. Up to 20 strings of up to 200 characters each, trimmed, with blank entries dropped and duplicates removed ignoring case. null empties it.
string
Company records only. Normalised as on Create Customer. null or an empty string clears it.
string
Individual records only. The ID of a company record on your instance that is not archived. null or an empty string unlinks it.
string
Accepted only when it matches the record’s current type. A different value is refused with TYPE_IMMUTABLE.
When country or investorType is sent, the resulting pair is checked. A country on the blocked-country list of the profile that investorType names is refused with COUNTRY_BLOCKED.

Response Fields

boolean
Request status
object
The updated customer record, with the fields listed on Get Customer other than its linked wallets, company links, Sumsub applicant record and audit entries.

Error Codes