Customers Reference

The Customer resource represents the banking partner's customer or user.

Customer Properties

Field	Type	Description	Notes
`id`	string	Lirium's unique identification for the customer
`created_at`	timestamp	Creation timestamp
`reference_id`	string	Banking partner's unique identification for the customer	Up to 191 characters. Case insensitive
`state`	string enum	Entity's state	`active` \| `closing` \| `closed` \| `banned`
`profile`	object	Profile information such as name and address	See request and response examples
`profile.national_id_type`	string	Type of national identification document	`passport` \| `driver_license` \| `national_id`
`contact.email`	string	Customer email address
`contact.cellphone`	string	Customer phone number
`products`	object	Available products for the customer	See example below
`data_requirements`	object	Data requirements from KYC and/or products	See example below

Customer States

State	Description
`active`	Customer has passed KYC and can transact
`closing`	Customer account is in the process of being closed. The customer must withdraw their funds before the account is fully closed
`closed`	Customer account has been closed
`banned`	Customer has been banned from the platform

Products Example

{
  "code": "crypto_buy_sell",
  "active": true,
  "enabled": true
}

Data Requirements 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"
}

Data Requirement Statuses

Status	Description
`pending_submission`	Document or data has not yet been submitted
`pending_review`	Document or data is awaiting review
`approved`	Document or data has been approved
`rejected`	Document or data has been rejected