Amend a KYB payload before submission

Partially updates a KYB payload. The body is deep-merged into the stored payload: a provided field updates only that field at any nesting depth, leaving its siblings untouched, so you can amend one edd declaration without resending the other. Arrays are replaced wholesale — sending uboDeclaration, a UBO’s nested document, or cardAuthorities swaps the whole list, dropping any entry absent from the new array. Because arrays are never merged entry by entry, each beneficial owner you send must be complete: a partially-populated owner is rejected with every gap listed, not merged over the one already stored. Unknown top-level keys and an empty body are rejected. Because an omitted key is left alone, an optional field cannot be cleared once set. Every change is stored as a new submission, preserving history. Rejected with 409 once the KYB has been submitted and is no longer editable.

Sending uboDeclaration replaces the beneficial owners. POST /ukyb accepts one submission per entity, so this is the only way to change the set afterwards. The replace is destructive: the existing owners’ individual entities are retired and rebuilt, so any identity documents already uploaded against their old entityId values are discarded. The response carries uboEntities with the new ids — upload each owner’s documents against those. Omit uboDeclaration and the owners are left untouched, and uboEntities is absent from the response.

registeredAddress and principalPlaceOfBusinessAddress are merged field by field, not replaced. Sending { "registeredAddress": { "country": "USA" } } updates only country and leaves line1, city and any other already-stored fields as they were — so changing a country without also resending the fields that depend on it (e.g. postalCode, state) can leave the stored address internally inconsistent. Send the complete address object when changing anything about it.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
uuid
required

The unique identifier (UUID) of the business entity.

Body Params

Any subset of the KYB payload. At least one key is required.

string
length between 1 and 200

Full legal registered name, exactly as shown on the Certificate of Incorporation.

string
enum

Controlled list of legal entity forms.

string
length between 1 and 100

Government-issued business registration number.

uboDeclaration
array of objects
length between 1 and 50

Ultimate Beneficial Owners with 25%+ ownership or control. At least one entry is required — an empty array is rejected. Supplying this field replaces the whole set; omit it on a PATCH to leave the existing owners untouched.

uboDeclaration
registeredAddress
object

The address on record with the company registrar (the Certificate of Incorporation address).

principalPlaceOfBusinessAddress
object

Where the business actually trades. May differ from registeredAddress.

uri
length ≤ 500

Optional business website URL.

validEmailDomains
array of strings
length between 1 and 10

Email domains whose employees may be issued cards for this business. Required — at least one, at most 10. Each entry must be a bare domain name such as acme.example: no scheme, path, @ or whitespace. Values are normalised (lowercased, a leading www. removed) and de-duplicated, so the stored list may be shorter than the one submitted. Supplying this field replaces the whole list.

validEmailDomains
string
enum

Controlled business-classification code.

date

Date the business was incorporated (YYYY-MM-DD). Must not be in the future.

ddq
object

Optional Due Diligence Questionnaire, submitted in the same call.

edd
object

Optional Enhanced Due Diligence declarations, submitted in the same call.

Responses

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json