Create a new customer on our platform

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.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Details of customers to be created

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.

string
required
string
required
string
string
enum

Must be either M or F

Allowed:
date
required

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

string
required

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

string
required

Customer's phone number.

string
string
file
required

ID card of the customer

string
enum
required

type of ID

Allowed:
string
required

expiry date of the ID

string
required

Number of the ID

string
required
string
required

This is required to be able to purchase credit life products

string
required
string
string
required
string

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

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.

Responses

Language
Credentials
Bearer
API KEY from your account dashboard
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json