Create a new customer on our platform

POST 
/v1/customers

Create a new customer

Creates a new customer which can be subsequently used to place an order for a product. Insurance regulation requires that KYC be done, thus a lot of fields would be mandato

Optional KYC parameters

The following parameters may be omitted

• bvn
• proof_of_address

When the above parameters are absent, the customer will get an email notification with instructions to provide them.

Request

multipart/form-data

Body

Details of customers to be created

oneOf

CustomerIndividual

ref string

Your unique identifier for the customer as it exists on your database. This would be used to identify this customer in all other operations.

first_name stringrequired

last_name stringrequired

middle_name string

sex string

Possible values: [M, F]

Must be either M or F

birth_date daterequired

Customer's date of birth e.g 1990-10-10

email emailrequired

Customer's email address. This need not be unique if the ref is provided.

phone stringrequired

Customer's phone number.

bvn string

occupation string

id_card binaryrequired

ID card of the customer

id_type stringrequired

Possible values: [driversLicense, internationalPassport, votersCard, nimc]

type of ID

id_expiry daterequired

expiry date of the ID

id_number stringrequired

Number of the ID

city stringrequired

residential_address stringrequired

This is required to be able to purchase credit life products

state stringrequired

nationality string

country stringrequired

next_of_kin_name string

This is required to be able to purchase credit life products The name of customer's next of kin

next_of_kin_phone string

This is required to be able to purchase credit life products Phone number of next of kin

proof_of_address object

The proof of the customer's address as part of required KYC. The type can be any string describing what type of document it is. The url should be a publicly accessible file at the time of making this request as it would be copied and stored for insurers to view.

type string

The type of proof of address e.g Electricity bill

url url

A publicly available URL to the customer's proof of address file

customerBusiness

ref string

Your unique identifier for the customer as it exists on your database. This would be used to identify this customer in all other operations.

business_name stringrequired

email emailrequired

Customer's email address. This need not be unique if the ref is provided.

description stringrequired

Customer's business description.

phone stringrequired

Customer's phone number.

residential_address stringrequired

Address of the business

country stringrequired

Country of the business address

state stringrequired

State of the business address

city stringrequired

City of the business address

registration_number stringrequired

Customer's business registration number

tin stringrequired

Customer's Tax Identification Number (TIN)

registration_certificate binaryrequired

Customer's proof of business registration

customer_type stringrequired

Default value: business

Customer's type can be individual or business, this field differentiate between individual and business account

birth_date daterequired

DoB of director whose ID is provided

id_card binaryrequired

ID card of one director

id_type stringrequired

Possible values: [driversLicense, internationalPassport, votersCard, nimc]

type of ID

id_expiry daterequired

expiry date of the ID

id_number stringrequired

Number of the ID

memart binary

Customer's memart

Responses

201

Created

application/json

Schema

Schema

ref stringrequired

Unique identifier for the customer on your system

email stringrequired

The customer's email address

phone string
first_name stringrequired
last_name stringrequired

Example (from schema)

{
  "ref": "string",
  "email": "string",
  "phone": "408-867-5309",
  "first_name": "Jane",
  "last_name": "Doe"
}

422

Unprocessable Content

application/json

Schema

Schema

message string
errors object
ref string[]
email string[]

Example (from schema)

{
  "message": "The given data was invalid",
  "errors": {
    "ref": [
      "The ref is required"
    ],
    "email": [
      "The email field is required"
    ]
  }
}

Loading...