List customers
Lists your individual and business customers, newest first. Associated persons are not listed. Get their business to see them. Unknown or invalid filters are ignored.
Query Parameters
Page number, from 1
Items per page. There is no maximum, so page through large sets.
Filter by customer status. active is the only status set today.
Filter by customer type
Possible values: individual, business
Search first name, last name, email and customer ID. It does not search the business name.
Filter by the status of the customer's basic KYC record
Possible values: not_started, initiating, pending, completed, failed
Responses
| Status | Description |
|---|---|
200 |
A page of customers |
500 |
The list could not be read |
200 response
ubo is an associated person of a business.
Possible values: individual, business, ubo
ISO 3166-2 code, such as NG-LA or US-FL. It must belong to country.
ISO 3166-1 alpha-2 code in upper case, such as NG.
KYC records, one per level. Read the basic record's status to know whether the customer is verified. The create response may not include them. Get the customer to read them.
KYC level. basic is the level every flow checks. intermediate exists for every customer, but no developer route starts it.
Possible values: basic, intermediate
not_started, then pending while under review, then completed or failed. initiating appears briefly while card KYC starts.
Possible values: not_started, initiating, pending, completed, failed
The latest hosted verification link, once one was issued
Reason text when verification failed
The persons of a business. Returned when you get one business, not in the list. Each person's id is the ID to use for their own KYC.
ubo is an associated person of a business.
Possible values: individual, business, ubo
ISO 3166-2 code, such as NG-LA or US-FL. It must belong to country.
ISO 3166-1 alpha-2 code in upper case, such as NG.
KYC records, one per level. Read the basic record's status to know whether the customer is verified. The create response may not include them. Get the customer to read them.
KYC level. basic is the level every flow checks. intermediate exists for every customer, but no developer route starts it.
Possible values: basic, intermediate
not_started, then pending while under review, then completed or failed. initiating appears briefly while card KYC starts.
Possible values: not_started, initiating, pending, completed, failed
The latest hosted verification link, once one was issued
Reason text when verification failed
The persons of a business. Returned when you get one business, not in the list. Each person's id is the ID to use for their own KYC.
ubo is an associated person of a business.
Possible values: individual, business, ubo
KYC records, one per level. Read the basic record's status to know whether the customer is verified. The create response may not include them. Get the customer to read them.
The persons of a business. Returned when you get one business, not in the list. Each person's id is the ID to use for their own KYC.
Six-digit code set from business_industry. 999999 when there is no match.
Time the customer was created, in RFC 3339 format.
Six-digit code set from business_industry. 999999 when there is no match.
Time the customer was created, in RFC 3339 format.
Six-digit code set from business_industry. 999999 when there is no match.
Time the customer was created, in RFC 3339 format.
500 response
{
"data": null,
"error": "failed to retrieve customers: database error"
}
Authorization
- ApiKeyAuth