Create a customer
curl --request POST \
--url https://{host}/v1/customers \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--header 'X-Api-Key: <api-key>' \
--data '
{
"first_name": "Adaeze",
"last_name": "Okafor",
"phone_number": "+2348012345678",
"date_of_birth": "1994-03-21",
"middle_name": "Chioma",
"email": "adaeze.okafor@example.com",
"customer_type": "individual",
"alias": "Mama Ada"
}
'const options = {
method: 'POST',
headers: {
'Idempotency-Key': '<idempotency-key>',
'X-Api-Key': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
first_name: 'Adaeze',
last_name: 'Okafor',
phone_number: '+2348012345678',
date_of_birth: '1994-03-21',
middle_name: 'Chioma',
email: 'adaeze.okafor@example.com',
customer_type: 'individual',
alias: 'Mama Ada'
})
};
fetch('https://{host}/v1/customers', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://{host}/v1/customers"
payload = {
"first_name": "Adaeze",
"last_name": "Okafor",
"phone_number": "+2348012345678",
"date_of_birth": "1994-03-21",
"middle_name": "Chioma",
"email": "adaeze.okafor@example.com",
"customer_type": "individual",
"alias": "Mama Ada"
}
headers = {
"Idempotency-Key": "<idempotency-key>",
"X-Api-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"success": true,
"message": "<string>",
"request_id": "01a1775167aa7693a7acd8df7b596118",
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"business_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"customer_type": "individual",
"first_name": "Adaeze",
"last_name": "Okafor",
"phone_number": "+2348012345678",
"date_of_birth": "1994-03-21",
"mode": "<string>",
"status": "<string>",
"kyc_tier": 123,
"kyc_status": "<string>",
"date_created": "2023-11-07T05:31:56Z",
"date_updated": "2023-11-07T05:31:56Z",
"middle_name": "Chioma",
"email": "adaeze.okafor@example.com",
"address": {
"line1": "12 Allen Avenue",
"city": "Ikeja",
"state": "Lagos",
"country": "NG",
"landmark": "Opposite the filling station"
},
"alias": "Mama Ada",
"deactivated_at": "2023-11-07T05:31:56Z",
"deactivation_reason": "<string>",
"deactivated_by": "<string>"
},
"code": "13"
}{
"success": true,
"message": "<string>",
"request_id": "01a1775167aa7693a7acd8df7b596118",
"data": {
"fields": {}
},
"code": "13"
}{
"success": true,
"message": "<string>",
"request_id": "01a1775167aa7693a7acd8df7b596118",
"data": null,
"code": "13"
}Customers
Create a customer
Creates a customer. A retry with the same Idempotency-Key and body returns the same customer.
Required permission: feature:CUSTOMERS, customers:write
POST
/
v1
/
customers
Create a customer
curl --request POST \
--url https://{host}/v1/customers \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--header 'X-Api-Key: <api-key>' \
--data '
{
"first_name": "Adaeze",
"last_name": "Okafor",
"phone_number": "+2348012345678",
"date_of_birth": "1994-03-21",
"middle_name": "Chioma",
"email": "adaeze.okafor@example.com",
"customer_type": "individual",
"alias": "Mama Ada"
}
'const options = {
method: 'POST',
headers: {
'Idempotency-Key': '<idempotency-key>',
'X-Api-Key': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
first_name: 'Adaeze',
last_name: 'Okafor',
phone_number: '+2348012345678',
date_of_birth: '1994-03-21',
middle_name: 'Chioma',
email: 'adaeze.okafor@example.com',
customer_type: 'individual',
alias: 'Mama Ada'
})
};
fetch('https://{host}/v1/customers', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://{host}/v1/customers"
payload = {
"first_name": "Adaeze",
"last_name": "Okafor",
"phone_number": "+2348012345678",
"date_of_birth": "1994-03-21",
"middle_name": "Chioma",
"email": "adaeze.okafor@example.com",
"customer_type": "individual",
"alias": "Mama Ada"
}
headers = {
"Idempotency-Key": "<idempotency-key>",
"X-Api-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"success": true,
"message": "<string>",
"request_id": "01a1775167aa7693a7acd8df7b596118",
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"business_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"customer_type": "individual",
"first_name": "Adaeze",
"last_name": "Okafor",
"phone_number": "+2348012345678",
"date_of_birth": "1994-03-21",
"mode": "<string>",
"status": "<string>",
"kyc_tier": 123,
"kyc_status": "<string>",
"date_created": "2023-11-07T05:31:56Z",
"date_updated": "2023-11-07T05:31:56Z",
"middle_name": "Chioma",
"email": "adaeze.okafor@example.com",
"address": {
"line1": "12 Allen Avenue",
"city": "Ikeja",
"state": "Lagos",
"country": "NG",
"landmark": "Opposite the filling station"
},
"alias": "Mama Ada",
"deactivated_at": "2023-11-07T05:31:56Z",
"deactivation_reason": "<string>",
"deactivated_by": "<string>"
},
"code": "13"
}{
"success": true,
"message": "<string>",
"request_id": "01a1775167aa7693a7acd8df7b596118",
"data": {
"fields": {}
},
"code": "13"
}{
"success": true,
"message": "<string>",
"request_id": "01a1775167aa7693a7acd8df7b596118",
"data": null,
"code": "13"
}Authorizations
Headers
Body
application/json