Customer details
Customers
Get Customer by ID
Retrieve full details of a single customer, including KYC document references and address.
GET
Customer details
Overview
GET /customers/{id} returns full details of a single customer in your company.
When to use it
- Display a customer profile in your dashboard.
- Check a customer’s status before issuing them a card.
- Reconcile a single customer record.
Prerequisites
- The customer must belong to your company.
Request
Headers
| Name | Required | Description |
|---|---|---|
Authorization | Yes | Bearer <access_token> |
Path parameters
| Name | Type | Description |
|---|---|---|
id | string | Customer ID (UUID). |
Response
200 — Success
Field reference
| Field | Type | Description |
|---|---|---|
id | string | Customer ID (UUID). |
first_name, last_name | string | As submitted at creation. |
email | string | Customer’s email address. Unique within your company. |
country | string | Full country name as submitted. |
street, city, state, postal_code | string | Postal address. |
phone_country_code | string | Dial code with + (e.g. +237). |
phone_number | string | Local subscriber number. |
type | string | The id_document_type submitted (NIN, PASSPORT, VOTERS_CARD, DRIVERS_LICENSE). |
number | string | The identification_number submitted. |
image | string | URL to the front of the ID document. Cartevo-hosted if you uploaded files; your own URL if you used /customers/enroll. |
photo | string | URL to the back of the ID document, when applicable. |
date_of_birth | string | ISO 8601. |
is_active | boolean | true for active customers; false if disabled by Cartevo. |
created_at / updated_at | string | ISO 8601 timestamps. |
Error responses
| Status | Trigger |
|---|---|
404 | Customer does not exist or belongs to another company. |
Code examples
cURL
Node.js (axios)
Related
GET /customers— list all customers.GET /customers/{id}/transactions— this customer’s transaction history.POST /cards— issue a card to this customer.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.