patch
https://api.lirium-sandbox.com/v1/customers/
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
Update mutable fields on an existing customer. At least one of contact, profile, status, reference_id or domain_status must be provided.
Updatable Fields
| Field | Type | Description |
|---|---|---|
profile.label | string | Optional label for the account |
profile.is_pep | boolean | Whether the customer is a Politically Exposed Person (PEP) |
contact.email | string | Customer's email address |
contact.cellphone | string | Customer's phone number |
status | string | Account status. Use closed to close, active to reactivate. |
reference_id | string | Your unique identifier for this customer |
domain_status | string | Your own pause on the customer. Use blocked to pause, active to resume. |
Notes:
- To close the customer account, the
statusshould be set toclosed. 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 toclosingstatus, indicating the customer must withdraw their funds before the account can be fully closed. - To reactivate the customer account, the
statusshould be set toactive. - To pause the customer, set
domain_statustoblocked: every product is disabled until you set it back toactive. Orders created before the pause can still be confirmed, incoming deposits wait until you resume, and a send to the customer with destination typelirium_customeris rejected withdestination_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 ofstatus(returned asstateon the Customer): resuming does not lift a hold or ban set by Lirium, and Lirium lifting one does not resume a customer you paused.
