The Customer resource represents the banking partner's customer / user.
A customer resource has the following properties
| Field | Description | Type / Values | Notes |
|---|---|---|---|
| id | Lirium's unique Identification for the Customer | string | |
| created_at | Creation timestamp. | timestamp | |
| reference_id | Banking Partner's unique Identification for the order. | string | Up to 64 characters long. Case sensitive |
| state | Entity's state | string enum | prospect |active | closed | banned | inactive_with_balance | dormant |
| profile | Profile information such as name and address | object | See the request and response examples for details |
| profile.national_id_type | string | passport | driver_license| national_id| other | |
| contact.email | string | ||
| contact.cellphone | string | ||
| products | Available products for the customer | object | Example{ "code": "crypto_buy_sell", "active": "true", "enabled": true } |
| data_requiements | Data requirements from KYC and/or products | object | Example{ "id":"document_id_back", "created":"2020-09-01T11:28:59+00:00", "type":"document", "document_type":"id_back", "status":"pending_submission", "last_updated_at":"2020-09-01T11:28:59+00:00" } |
NEW Customer Status will be updated on August 30th
Customer Status
We are implementing an improvement to better handle customer statuses.
Customers are now initially created with a status of prospect. They will remain in this status as long as they have no activity.
Once a customer places their first order, their status changes to active.
If a customer does not place any new orders within 30 days, their status will change according to their balance:
• If they have a balance: inactive_with_balance
• If they have no balance: dormant
It is important to note that all of these statuses allow the customer to operate normally. Therefore, a customer in any of the following statuses is fully enabled to transact:
• prospect
• active
• inactive_with_balance
• dormant
Existing customers will be updated according to this new status management logic.