Get a customer
Returns one customer with its KYC records, and for a business its associated persons. It also returns an associated person by its own id. Send no query parameters.
Path Parameters
Responses
| Status | Description |
|---|---|
200 |
Customer details |
400 |
Invalid ID, or the customer is not in your tenant |
200 response
A customer. Empty fields are left out, so a business has no first_name and an individual has no business_name.
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
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.
Six-digit code set from business_industry. 999999 when there is no match.
Time the customer was created, in RFC 3339 format.
400 response
{
"data": null,
"error": "failed to retrieve customer: customer not found"
}
{
"data": null,
"error": "invalid customer ID: invalid UUID length: 5"
}
Authorization
- ApiKeyAuth