Update Customer

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

Update mutable fields on an existing customer. At least one of contact, profile, status, reference_id or domain_status must be provided.

Updatable Fields

FieldTypeDescription
profile.labelstringOptional label for the account
profile.is_pepbooleanWhether the customer is a Politically Exposed Person (PEP)
contact.emailstringCustomer's email address
contact.cellphonestringCustomer's phone number
statusstringAccount status. Use closed to close, active to reactivate.
reference_idstringYour unique identifier for this customer
domain_statusstringYour own pause on the customer. Use blocked to pause, active to resume.

Notes:

  • To close the customer account, the status should be set to closed. Before closing the account, the customer must not have any pending orders or balances in any cryptocurrency. If the customer still has funds, the account will transition to closing status, indicating the customer must withdraw their funds before the account can be fully closed.
  • To reactivate the customer account, the status should be set to active.
  • To pause the customer, set domain_status to blocked: every product is disabled until you set it back to active. Orders created before the pause can still be confirmed, incoming deposits wait until you resume, and a send to the customer with destination type lirium_customer is rejected with destination_unable_to_receive. When pausing or resuming changes which products are enabled, you receive the Customer product changed webhook; a customer whose products are all already disabled (for example, on a Lirium hold) gets none. The pause is independent of status (returned as state on the Customer): resuming does not lift a hold or ban set by Lirium, and Lirium lifting one does not resume a customer you paused.
Path Params
string
required
Body Params
profile
object
contact
object
string
string
string
enum

Pause (blocked) or resume (active) the customer's operations. Independent of status.

Allowed:
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