Sign in

v1

latestOpenAPI 3.1.02026-07-26490367.2 KB

Create Customer

Creates a new customer.

post/customers

Request body

type'individual' | 'company' required

This is the customer type.

namestring required

The customer's full name.

phoneNumberstring required

Customer's mobile phone number in international format.

emailAddressstring

Customer's email address.

status'active' | 'inactive' required

This is the initial status of the customer.

Example request

{
  "type": "individual",
  "name": "Jane Smith",
  "phoneNumber": "+2348012345678",
  "emailAddress": "jane.smith@example.com",
  "individual": {
    "firstName": "Jane",
    "lastName": "Smith",
    "otherNames": "Maria",
    "dob": "1985-05-15",
    "identity": {
      "type": "PASSPORT",
      "number": "A12345678"
    },
    "documents": {
      "idFrontUrl": "https://your-bucket.s3.amazonaws.com/<businessId>/customers/<customerId>/passport-front.jpg",
      "idBackUrl": "https://your-bucket.s3.amazonaws.com/<businessId>/customers/<customerId>/passport-back.jpg"
    }
  },
  "status": "active",
  "billingAddress": {
    "line1": "42 Corporate Tower, Marina",
    "line2": "Floor 8",
    "city": "Lagos",
    "state": "Lagos",
    "postalCode": "100221",
    "country": "Nigeria"
  }
}

Response

Customer created successfully.

statusCodeinteger

Status code of the response. 200 indicates a successful request.

messagestring

Human-readable description of the result.