POST /v1/customer_partners/{{customer_partner_id}}/customers
The Register Customer endpoint is used to create customer profiles on your integration.
Registering Businesses
The
rc_numberfield is an optional parameter. However, when registering a business the parameter becomes compulsory
Payload
This is the payload required to register a customer. See guide here for how to make requests.
{
"business_name": "B54",
"unique_id_type": "bvn",
"unique_id": "123456780",
"first_name": "John",
"last_name": "Doe",
"other_names": "Smith",
"mother_maiden_name": "Jane",
"gender": "male",
"date_of_birth":"YYYY-MM-DD",
"street": "12 Olaniyi street ",
"city": "Ikeja",
"state": "Lagos",
"country": "Nigeria",
"email": "[email protected]",
"contact_number": "08000000007",
"nin": "1234567890",
"photo_id_type": "NIN slip",
"occupation": "Software Developer",
"office_street": "229 Herbert Macaulay",
"office_city": "Yaba",
"office_state": "Lagos",
"office_country": "Nigeria",
"address": "229 Herbert Macaulay Yaba Lagos Nigeria",
"next_of_kin": "Arowojobe Stone Jeremiah",
"nin_slip": "fileData",
"proof_of_residence": "fileData",
"international_passport": "fileData",
"utility_slip": "fileData",
"drivers_license": "fileData"
}
The payload object
payload objectCompulsory Fields
first_name string
This is the first name of the customer.
last_name string
This is the last name of the customer.
contact_number string
This is the contact (phone) number of the customer.
unique_id_type string
This is the primary type of identifying and verifying the user's bio-information. For this use case, the value is always bvn.
unique_id string
This is the ID number that corresponds with the unique_id_type
Optional Fields
emailstring
This is the email address of the customer.rc_numberstring
This is the rc_number used for registering business
genderstring
This is the gender of the customer. It must either be `male` or `female`date_of_birthstring
This is the date of birth of the customer. The format of the date must be in this format: `YYYY-MM-DD`addressstring
This is the address of the customer to be registered.ninstring
This is the customer's National Identification Number (NIN).photo_id_typestring
This is the type of photo identification to be used. Its value can be `NIN slip`, `International passport` or `Drivers license`. The options selected here will determine which of the files will be uploaded.next_of_kinstring
This is the name of the next of kin of the customer.proof_of_residencestring
This is the file(image or document) of the customer's proof of residence.utility_slipstring
This is the file(image or document)of the customer's utility slip.business_namestring
This is the business name of the customer if they have a business.other_namesstring
This can include other names of the customer if applicable.mother_maiden_namestring
This is the customer's mother's maiden name.marital_statusstring
This is the marital status of the customer. It must be either `single` or `married`occupationstring
This is the occupation of the customer.nin_slipfile
This is the file(image or document) of the customer's NIN slip.international_passportfile
This is the file(image or document) of the customer's international passport.drivers_licensefile
This is the file(image or document) of the customer's driver's license.office_streetstring
This is the street on which the customer's office is located.office_citystring
This is the city in which the customer's office is located.office_statestring
This is the state in which the customer's office is located.office_countrystring
This is the country in which the customer's office is located.office_citystring
This is the city in which the customer's office is located.Response
This is expected response if the request is completed successfully.
{
"status": "success",
"message": "Customer created successfully",
"data": {
"customer": {
"business_name": "Chronos software solutions",
"unique_id": "1234567890",
"unique_id_type": "bvn",
"first_name": "John",
"last_name": "Doe",
"other_names": "Smith",
"mother_maiden_name": "Jane",
"gender": "male",
"marital_status": "single",
"street": "12 Olaniyi street ",
"city": "Ikeja",
"state": "Lagos",
"country": "Nigeria",
"email": "[email protected]",
"contact_number": "08000000007",
"occupation": "Software Developer",
"office_street": "229 Herbert Macaulay ",
"office_city": "Yaba",
"office_state": "Lagos",
"office_country": "Nigeria",
"proof_of_residence": "https://res.cloudinary.com/yakusoku-suru/image/upload/v1629125530/Documents/laxf9iwt7gj18akhac7q.pdf",
"international_passport": "https://res.cloudinary.com/yakusoku-suru/image/upload/v1629125537/Documents/byn9bweddorfvw8xryen.pdf",
"utility_slip": "https://res.cloudinary.com/yakusoku-suru/image/upload/v1629125539/Documents/firgc2rjoeblm7wv4odr.pdf",
"drivers_license": "https://res.cloudinary.com/yakusoku-suru/image/upload/v1629125547/Documents/nrxzgva6dx2dlv237tjn.pdf",
"created_at": "2021-08-16T14:52:30.000Z",
"updated_at": "2021-08-16T14:52:30.000Z",
"id": "qwercgtgtj7654"
},
"customerPartner": {
"customer": "qwercgtgtj7654",
"partner": "gdndjde68e9edi9",
"created_at": "2021-08-16T14:52:30.000Z",
"updated_at": "2021-08-16T14:52:30.000Z",
"id": "ooub865eu6ed9"
}
}
}
The response object
response objectstatus string
This is the status of the request. It can be either success or error
message string
This is a message describing the outcome of the request sent to the server.
data object
customer object
business_name string
This is the business name of the customer if they have a business.
unique_id_type string
This is the primary type of identifying and verifying the user's bio-information.
unique_id string
This is the ID that corresponds with the unique_id_type
first_name string
This is the first name of the customer.
last_name string
This is the last name of the customer.
other_names string
This can include other names of the customer if applicable.
mother_maiden_name string
This is the customer's mother's maiden name.
gender string
This is the gender of the customer. It must either be male or female
marital_status string
This is the marital status of the customer. It must be single, married or divorced
street string
This is the street on which the customer resides.
city string
This is the city in which the customer resides.
state string
This is the state in which the customer resides.
country string
This is the country in which the customer resides.
email string
This is the email address of the customer.
contact_number string
This is the contact (phone) number of the customer.
occupation string
This is the occupation of the customer.
office_street string
This is the street on which the customer's office is situated.
office_city string
This is the city in which the customer's office is situated.
office_state string
This is the state in which the customer's office is situated.
office_country string
This is the country in which the customer's office is situated.
proof_of_residence string
This is the link to the image of the customer's proof of residence.
international_passport string
This is the link to the image of the customer's international passport.
utility_slip string
This is the link to the image of the customer's utility slip.
drivers_license string
This is the link to the image of the customer's driver's license.
id int
This is the ID of the customer.
metadata string
This includes the created_at and updated_at timestamps sent in a DateTime format.
customer_partner object
customer int
This is the ID of the customer.
partner int
This is the ID of the partner whom this customer belongs to.
metadata string
This includes the created_at and updated_at timestamps sent in a DateTime format.