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 or reference_id 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 |
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.
