Skip to main content
PATCH
Changes a KYC source. Send any combination of the fields below. A field that is not sent stays as it is, and a call that changes nothing answers with the source unchanged.

What each change does

Unbinding a whitelist lifts the record requirement on it. From then on Set Whitelist Members lists any wallet on that list again, unless another source of your instance is still bound to it. Wallets already listed stay listed.
A removed source cannot be changed. Add a new source instead.

Path Parameters

string
required
The source id from List KYC Sources.

Body Parameters

string
1 to 80 characters: letters, digits, spaces and . , & ( ) ' _ -, starting with a letter or a digit. Unique among the sources of your instance that are not removed.
string
The verifier’s Ed25519 public key as 64 hex characters, with or without a 0x prefix.
string
The key of an enabled verification profile.
string[]
Up to 10 whitelist IDs. The list replaces the bound whitelists as a whole.
string
ACTIVE or PAUSED. Use Remove KYC Source to end a source for good.

Response Fields

object
A change is written to the customer audit log as KYC_SOURCE_UPDATED, naming the fields that changed. A new signing key is recorded with its fingerprint and the fingerprint of the key it replaced.

Error Codes