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

Field
Type
Required
Description

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"
}

πŸ” Note: Files like id_card and utility_bill should be submitted as part of a multipart/form-data request.

βœ… Successful Response

{
  "status": true,
  "message": "Customer created successfully",
  "customer": {
    "customer_name": "Jane Doe",
    "customer_email": "[email protected]",
    "customer_id": "9a4c73d7d8ff9..."
  }
}

Last updated