Skip to main content
The Customers API stores the customer identity used by cards, collections, and KYC workflows. Create the customer first, keep the returned ID, and use that ID for later product and verification requests.

​
🤖 Create a Customer

To add a new customer to your system, use the create customer endpoint. Body
​
string
required
The customer’s first name. It must match the customer’s government-issued identification for KYC purposes.
​
string
required
The customer’s last name or surname. It must match the customer’s government-issued identification for KYC purposes.
​
string
required
The customer’s middle name or initial. This can be used for additional verification and should match the customer’s government-issued identification if provided.
​
string
required
The customer’s country of residence. Use an ISO 3166-1 alpha-2 code such as NG, GH, GB, US, or BR. The KYC request must use the same country.
​
string
required
The customer’s email address.
Request Body Provide the customer’s identity details. Use the returned customer ID in later card, collection, and KYC requests.
Request Body

​
🔍 Get Customer Details

Retrieve detailed information about a specific customer with their unique identifier using the get customer endpoint. Path Parameters
​
string
required
The unique identifier of the customer to retrieve.

​
🔍 Get All Customers

Retrieve a paginated list of customers in your system using the get all customers endpoint. Query Parameters
​
integer
The page to return.
​
integer
The maximum number of results to return.

​
Perform KYC for a Customer

Conduct Know Your Customer (KYC) checks to verify the identity of your customers using the customer KYC endpoint.
Customer KYC is required before issuing a DEFAULT USD collection account for a customer. After KYC is submitted, create a USD collection with currency set to USD and include the required additional_information payload.
Parameters
​
string
required
The unique identifier of the customer whose KYC you are submitting.
Body
  • tier enum (ONE, TWO, FULL) :
    • The KYC tier to request.
  • information object :
    • bvn string : required for customers in Nigeria
    • ssnit string : accepted for customers in Ghana
    • bank_identifier string : required outside Nigeria when ssnit is not supplied
    • bank_identifier_type string : the country-specific identifier type, for example NINO, CPF, SSN, or TIN
    • state string : customer state
    • city string : customer city
    • country string : ISO 3166-1 alpha-2 country code; must match the customer profile
    • address string : customer address
    • postal_code string : customer address postal code
    • date_of_birth string : customer date of birth
    • phone_number string : customer phone number; use E.164 format outside Nigeria and Ghana
  • document object :
    • document_type enum (NIN, PASSPORT, NATIONAL_ID, DRIVERS_LICENSE, VOTERS_CARD, GHANA_CARD)
    • document_number string : customer document number
    • document url : customer document url
    • passport url : customer passport photograph url
Identity fields are country-aware. Nigeria requires bvn. Ghana accepts ssnit, or bank_identifier with bank_identifier_type. Every other country requires bank_identifier and bank_identifier_type. The verified address is retained as the customer’s issuance address for supported products, so submit the customer’s real residential address rather than a default address.
ONE submits the information object. TWO submits the document object and requires an existing Tier 1 record. FULL submits both objects in one request.
Request Body

​
Blacklist Customer

Blacklist a customer from performing actions using the blacklist customer endpoint. Parameters
​
string
required
The unique identifier of the customer to blacklist.

​
Update Customer

Update a customer’s email address or phone number with the update customer endpoint.
​
string
required
The unique identifier of the customer to update.
​
string
The customer’s updated email address.
​
string
The customer’s updated phone number.

​
Delete Customer

Delete a customer with the delete customer endpoint when the customer should no longer remain in the business account.
​
string
required
The unique identifier of the customer to delete.