Create Customer
Endpoint
π Description
Creates a new customer associated with a business and submits their KYC (Know Your Customer) details for verification. This includes personal information, address, ID type and number, and uploads of identification and utility bill documents.
Request Headers
Authorization
Beaerer {Secrete_KEY}
api-key
{API_KEY}
Content-Type
application/json
Request Body
first_name
string
β
Customer's first name
last_name
string
β
Customer's last name
email
string
β
Valid email address
phone_number
string
β
Nigerian phone number (11 digits)
address
string
β
Residential address
state
string
β
State of residence
city
string
β
City of residence
postal_code
string
β
Postal code
date_of_birth
string
β
Must be at least 14 years old (YYYY-MM-DD
)
id_type
string
β
One of: bvn
, nin
id_number
string
β
ID number, validated based on id_type
id_card
file
β
JPEG, PNG, or PDF file (max: 5MB)
utility_bill
file
β
JPEG, PNG, or PDF file (max: 5MB)
businessId
string
β
The business ID this customer belongs to
π₯ Example Request (JSON)
// Some code
{
"first_name": "Jane",
"last_name": "Doe",
"email": "[email protected]",
"phone_number": "08012345678",
"address": "10 Market Street",
"state": "Lagos",
"city": "Ikeja",
"postal_code": "100001",
"date_of_birth": "2008-05-01",
"id_type": "bvn",
"id_number": "22123456789",
"businessId": "abc123"
}
β Successful Response
{
"status": true,
"message": "Customer created successfully",
"customer": {
"customer_name": "Jane Doe",
"customer_email": "[email protected]",
"customer_id": "9a4c73d7d8ff9..."
}
}
Last updated