Create Client

Creates a client (customer) profile only. Unlike POST /core/account no savings product is supplied, so no savings account or NUBAN is opened.

POST /core/client

Request Body

Field Name	Type	Required	Description
clientType	string	true	`PERSON` or `BUSINESS` (upper case).
firstname	string	true (PERSON)	Client's first name.
middlename	string	false	Client's middle name.
lastname	string	true (PERSON)	Client's last name.
fullName	string	true (BUSINESS)	Registered name of the business.
email	string	false	Client's email address.
mobileNo	string	true	Client's mobile phone number (max 50 characters).
bvn	string	true*	Bank Verification Number. *Either `bvn` or `nin` must be supplied.
nin	string	true*	National Identity Number. *Either `bvn` or `nin` must be supplied.
dateOfBirth	string	false	Date of birth, format DD-MM-YYYY.
genderId	integer	false	Id of a gender from `GET /core/genders`.
address	string	false	Address line. Required when address capture is enabled for your account.
addressTypeId	integer	false	Address type id; the configured default is used when omitted or 0.
stateId	integer	false	State/province id for the address.
registrationNumber	string	false	Incorporation number (BUSINESS).
officeId	integer	false	Office id; the configured default office is used when omitted.
active	boolean	false	Defaults to true.
emailNotification	boolean	false	Email alerts on or off.
smsNotification	boolean	false	SMS alerts on or off.
clientActivationFeePaid	boolean	false	Whether the activation fee has already been paid.

Response

Field Name	Type	Description
clientId	integer	Unique identifier of the new client.
firstname	string	Echo of the first name (PERSON).
middlename	string	Echo of the middle name, if sent.
lastname	string	Echo of the last name (PERSON).
email	string	Echo of the email address.
mobileNo	string	Echo of the mobile number.
subLedgerActivated	boolean	Always false for a newly created client.

Request

Authorization

OAuth 2.0

Client Credentials

Add the parameter

Authorization

to Headers，whose value is to concatenate the Token after the Bearer.

Example:

Authorization: Bearer ********************

Token URL: {{tpGatewayHostUrl}}/security/authenticate

Body Params application/json

Example

{
  "clientType": "PERSON",
  "firstname": "Ada",
  "lastname": "Obi",
  "email": "ada.obi@example.com",
  "mobileNo": "08012345678",
  "bvn": "22222222222",
  "dateOfBirth": "15-03-1990",
  "genderId": 1
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Success

application/json

Success

Bodyapplication/json

Example

{
  "firstname": "Ada",
  "lastname": "Obi",
  "email": "ada.obi@example.com",
  "mobileNo": "08012345678",
  "clientId": 101,
  "subLedgerActivated": false
}

🟠400| Source | Error | When |

🟠401| Source | Error | When |

🟠403| Source | Error | When |

🟠404| Source | Error | When |

🔴500| Source | Error | When |

Create Client

Create Client#

Request Body#

Response#

Request

Request Code Samples

Responses

Create Client

Request Body

Response