Sign in

v1

latestOpenAPI 3.0.22026-07-26128245430.3 KB
Customers

Update a single customer object

Updates to be made to the specified customer.

No fields are strictly required by the API. It is generally valid to provide any subset of data in a PUT request. For business customers, associated persons cannot be updated via PUT, and should instead be managed using v0/associated_persons.

put/customers/{customerID}

Request body

OR

Response

Successful customer object response

idstring

A UUID that uniquely identifies a resource

first_namestring
last_namestring
emailstring
status'active' | 'awaiting_questionnaire' | 'awaiting_ubo' | 'incomplete' | 'not_started' | 'offboarded' | 'paused' | 'rejected' | 'under_review'

offboarded: represents a customer's account that was internally reviewed and closed due to suspicious activity. paused: represents a customer's account that is currently under review because of activity on the platform.

future_requirements_duestring[]

Information about requirements that may be needed in the future for the customer (eg. enhanced KYC checks for high volume transactions etc.). Please consult our KYC guide on how to resolve each requirement.

requirements_duestring[]

KYC requirements still needed to be completed. Please consult our KYC guide on how to resolve each requirement.

created_atstring date-time

Time of creation of the customer

updated_atstring date-time

Time of last update of the customer

has_accepted_terms_of_serviceboolean

Whether the customer has accepted the terms of service.

client_reference_idstring

A client-provided reference ID that uniquely identifies a resource in the client's system