​
🤖 Create a Customer

To add a new customer to your system, use the create customer endpoint.

Body

​
firstname
string
required

The customer’s first name. It must match the customer’s government-issued identification for KYC purposes.

​
lastname
string
required

The customer’s last name or surname. It must match the customer’s government-issued identification for KYC purposes.

​
middlename
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.

​
country
string
default: "NG"required

The country of the customer’s residence or operation. Use ISO 3166-1 alpha-2 country codes.

​
email
string
required

The customer’s email address.

Request Body

Provide necessary details to set up a new card.

Request Body
{
  "firstname": "user",
  "lastname": "user",
  "middlename": "user",
  "country": "user",
  "email": "[email protected]"
}

​
🔍 Get Customer Details

Retrieve detailed information of a specific customer with their unique identifier using the get customer endpoint.

Path Parameters

​
id
string
required

The unique identifier of the customer to retrieve.

​
🔍 Get All Customers

Retrieve a comprehensive list of all customers in your system using the get all customers endpoint.

Query Parameters

​
page
string
default: 1required

The page to return.

​
limit
string
default: 10required

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.

Parameters

​
id
string
required

The unique identifier of the customer to retrieve.

Body

  • tier enum (ONE, TWO, FULL) :
    • The amount to fund in the smallest currency unit.
  • information object :
    • bvn string : customer bvn (Nigeria)
    • ssnit string : customer ssnit (Ghana)
    • state string : customer state
    • city string : customer city
    • country string : customer country
    • address string : customer address
    • postal_code string : customer address postal code
    • date_of_birth string : customer date of birth
  • document object :
    • document_type enum (NIN, PASSPORT, DRIVERS_LICENSE)
    • document_number number : customer document number
    • document url : customer document url
    • passport url : customer passport photograph url
Request Body
{
	"tier": "FULL",
	"information": {
		"bvn": "12345678901",
		"state": "Lagos",
		"city": "Ikeja",
		"country": "Nigeria",
		"address": "No 1, Ikeja",
		"postal_code": "100001"
	},
	"document": {
		"document_type": "PASSPORT",
		"document_number": "A1234567",
		"document": "https://example.com/document.jpg",
		"passport": "https://example.com/passport.jpg"
	}
}

​
Blacklist Customer

Blacklist customer from performing any action using the post.

Parameters

​
id
string
required

The unique identifier of the customer to blacklist.

Was this page helpful?

OverviewOverview