Create Customer
curl --request POST \
--url https://carbonapistagingsecure.getcarbon.co/baas/api/v1/customers \
--header 'Content-Type: application/json' \
--header 'apikey: <api-key>' \
--header 'x-carbon-key: <x-carbon-key>' \
--data '
{
"first_name": "Provide first name",
"last_name": "Provide last name",
"email": "Provide email",
"phone": "Provide phone number",
"dob": "Provide date of birth",
"gender": "Provide gender",
"street": "Provide street address",
"city": "Provide city",
"state": "Provide state",
"country": "Provide country",
"bvn": "Provide BVN",
"nin": "Provide NIN"
}
'const options = {
method: 'POST',
headers: {
'x-carbon-key': '<x-carbon-key>',
apikey: '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
first_name: 'Provide first name',
last_name: 'Provide last name',
email: 'Provide email',
phone: 'Provide phone number',
dob: 'Provide date of birth',
gender: 'Provide gender',
street: 'Provide street address',
city: 'Provide city',
state: 'Provide state',
country: 'Provide country',
bvn: 'Provide BVN',
nin: 'Provide NIN'
})
};
fetch('https://carbonapistagingsecure.getcarbon.co/baas/api/v1/customers', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://carbonapistagingsecure.getcarbon.co/baas/api/v1/customers",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'first_name' => 'Provide first name',
'last_name' => 'Provide last name',
'email' => 'Provide email',
'phone' => 'Provide phone number',
'dob' => 'Provide date of birth',
'gender' => 'Provide gender',
'street' => 'Provide street address',
'city' => 'Provide city',
'state' => 'Provide state',
'country' => 'Provide country',
'bvn' => 'Provide BVN',
'nin' => 'Provide NIN'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"apikey: <api-key>",
"x-carbon-key: <x-carbon-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}import requests
url = "https://carbonapistagingsecure.getcarbon.co/baas/api/v1/customers"
payload = {
"first_name": "Provide first name",
"last_name": "Provide last name",
"email": "Provide email",
"phone": "Provide phone number",
"dob": "Provide date of birth",
"gender": "Provide gender",
"street": "Provide street address",
"city": "Provide city",
"state": "Provide state",
"country": "Provide country",
"bvn": "Provide BVN",
"nin": "Provide NIN"
}
headers = {
"x-carbon-key": "<x-carbon-key>",
"apikey": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)require 'uri'
require 'net/http'
url = URI("https://carbonapistagingsecure.getcarbon.co/baas/api/v1/customers")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-carbon-key"] = '<x-carbon-key>'
request["apikey"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"first_name\": \"Provide first name\",\n \"last_name\": \"Provide last name\",\n \"email\": \"Provide email\",\n \"phone\": \"Provide phone number\",\n \"dob\": \"Provide date of birth\",\n \"gender\": \"Provide gender\",\n \"street\": \"Provide street address\",\n \"city\": \"Provide city\",\n \"state\": \"Provide state\",\n \"country\": \"Provide country\",\n \"bvn\": \"Provide BVN\",\n \"nin\": \"Provide NIN\"\n}"
response = http.request(request)
puts response.read_bodypackage main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://carbonapistagingsecure.getcarbon.co/baas/api/v1/customers"
payload := strings.NewReader("{\n \"first_name\": \"Provide first name\",\n \"last_name\": \"Provide last name\",\n \"email\": \"Provide email\",\n \"phone\": \"Provide phone number\",\n \"dob\": \"Provide date of birth\",\n \"gender\": \"Provide gender\",\n \"street\": \"Provide street address\",\n \"city\": \"Provide city\",\n \"state\": \"Provide state\",\n \"country\": \"Provide country\",\n \"bvn\": \"Provide BVN\",\n \"nin\": \"Provide NIN\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-carbon-key", "<x-carbon-key>")
req.Header.Add("apikey", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}{
"status": "success",
"message": "Customer created successfully",
"data": {
"id": "e128cc08-a43a-4db3-a27d-64bbcba0a0f2",
"first_name": "ola",
"last_name": "ajayi",
"email": "ola@yahoo.com",
"phone": "08071000030",
"gender": "MALE",
"dob": "1990-01-01T00:00:00.000Z",
"nin": "11111111111",
"bvn": "11111111111",
"address": {
"street": "NO 1 LAGOS ROAD",
"city": "IKEJA",
"state": "LAGOS STATE",
"country": "NIGERIA"
},
"is_business": false,
"business_name": null,
"mode": "sandbox",
"created_at": "2024-03-07T10:12:34.000Z",
"updated_at": "2024-03-07T10:12:34.000Z"
}
}{
"status": "failed",
"message": "bad request",
"errors": [
{
"msg": "Request body cannot be empty"
}
]
}Customers
Create Customer
Create a new customer with detailed information.
POST
/
v1
/
customers
Create Customer
curl --request POST \
--url https://carbonapistagingsecure.getcarbon.co/baas/api/v1/customers \
--header 'Content-Type: application/json' \
--header 'apikey: <api-key>' \
--header 'x-carbon-key: <x-carbon-key>' \
--data '
{
"first_name": "Provide first name",
"last_name": "Provide last name",
"email": "Provide email",
"phone": "Provide phone number",
"dob": "Provide date of birth",
"gender": "Provide gender",
"street": "Provide street address",
"city": "Provide city",
"state": "Provide state",
"country": "Provide country",
"bvn": "Provide BVN",
"nin": "Provide NIN"
}
'const options = {
method: 'POST',
headers: {
'x-carbon-key': '<x-carbon-key>',
apikey: '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
first_name: 'Provide first name',
last_name: 'Provide last name',
email: 'Provide email',
phone: 'Provide phone number',
dob: 'Provide date of birth',
gender: 'Provide gender',
street: 'Provide street address',
city: 'Provide city',
state: 'Provide state',
country: 'Provide country',
bvn: 'Provide BVN',
nin: 'Provide NIN'
})
};
fetch('https://carbonapistagingsecure.getcarbon.co/baas/api/v1/customers', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://carbonapistagingsecure.getcarbon.co/baas/api/v1/customers",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'first_name' => 'Provide first name',
'last_name' => 'Provide last name',
'email' => 'Provide email',
'phone' => 'Provide phone number',
'dob' => 'Provide date of birth',
'gender' => 'Provide gender',
'street' => 'Provide street address',
'city' => 'Provide city',
'state' => 'Provide state',
'country' => 'Provide country',
'bvn' => 'Provide BVN',
'nin' => 'Provide NIN'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"apikey: <api-key>",
"x-carbon-key: <x-carbon-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}import requests
url = "https://carbonapistagingsecure.getcarbon.co/baas/api/v1/customers"
payload = {
"first_name": "Provide first name",
"last_name": "Provide last name",
"email": "Provide email",
"phone": "Provide phone number",
"dob": "Provide date of birth",
"gender": "Provide gender",
"street": "Provide street address",
"city": "Provide city",
"state": "Provide state",
"country": "Provide country",
"bvn": "Provide BVN",
"nin": "Provide NIN"
}
headers = {
"x-carbon-key": "<x-carbon-key>",
"apikey": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)require 'uri'
require 'net/http'
url = URI("https://carbonapistagingsecure.getcarbon.co/baas/api/v1/customers")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-carbon-key"] = '<x-carbon-key>'
request["apikey"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"first_name\": \"Provide first name\",\n \"last_name\": \"Provide last name\",\n \"email\": \"Provide email\",\n \"phone\": \"Provide phone number\",\n \"dob\": \"Provide date of birth\",\n \"gender\": \"Provide gender\",\n \"street\": \"Provide street address\",\n \"city\": \"Provide city\",\n \"state\": \"Provide state\",\n \"country\": \"Provide country\",\n \"bvn\": \"Provide BVN\",\n \"nin\": \"Provide NIN\"\n}"
response = http.request(request)
puts response.read_bodypackage main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://carbonapistagingsecure.getcarbon.co/baas/api/v1/customers"
payload := strings.NewReader("{\n \"first_name\": \"Provide first name\",\n \"last_name\": \"Provide last name\",\n \"email\": \"Provide email\",\n \"phone\": \"Provide phone number\",\n \"dob\": \"Provide date of birth\",\n \"gender\": \"Provide gender\",\n \"street\": \"Provide street address\",\n \"city\": \"Provide city\",\n \"state\": \"Provide state\",\n \"country\": \"Provide country\",\n \"bvn\": \"Provide BVN\",\n \"nin\": \"Provide NIN\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-carbon-key", "<x-carbon-key>")
req.Header.Add("apikey", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}{
"status": "success",
"message": "Customer created successfully",
"data": {
"id": "e128cc08-a43a-4db3-a27d-64bbcba0a0f2",
"first_name": "ola",
"last_name": "ajayi",
"email": "ola@yahoo.com",
"phone": "08071000030",
"gender": "MALE",
"dob": "1990-01-01T00:00:00.000Z",
"nin": "11111111111",
"bvn": "11111111111",
"address": {
"street": "NO 1 LAGOS ROAD",
"city": "IKEJA",
"state": "LAGOS STATE",
"country": "NIGERIA"
},
"is_business": false,
"business_name": null,
"mode": "sandbox",
"created_at": "2024-03-07T10:12:34.000Z",
"updated_at": "2024-03-07T10:12:34.000Z"
}
}{
"status": "failed",
"message": "bad request",
"errors": [
{
"msg": "Request body cannot be empty"
}
]
}Overview
This endpoint allows you to create a new customer by providing their details such as name, email, phone, and more.Request
Method:POSTURL:
/v1/customers
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
x-carbon-key | Header | string | Yes | API key for authentication. |
Request Body
{
"first_name": "Provide first name",
"last_name": "Provide last name",
"email": "Provide email",
"phone": "Provide phone number",
"dob": "Provide date of birth",
"gender": "Provide gender",
"street": "Provide street address",
"city": "Provide city",
"state": "Provide state",
"country": "Provide country",
"bvn": "Provide BVN",
"nin": "Provide NIN"
}
Response
Status Code:200 OKContent-Type:
application/json
Example Response
{
"status": "success",
"message": "Customer created successfully",
"data": {
"id": "e128cc08-a43a-4db3-a27d-64bbcba0a0f2",
"first_name": "Ola",
"last_name": "Ajayi",
"email": "ola@yahoo.com",
"phone": "08071000030",
"gender": "MALE",
"dob": "1990-01-01T00:00:00.000Z",
"nin": "11111111111",
"bvn": "11111111111",
"address": {
"street": "NO 1 LAGOS ROAD",
"city": "Lagos",
"state": "Lagos",
"country": "Nigeria"
},
"is_business": false,
"business_name": null,
"mode": "sandbox",
"created_at": "2024-03-07T10:12:34.000Z",
"updated_at": "2024-03-07T10:12:34.000Z"
}
}
Authorizations
Provide your API key in the 'apikey' header.
Headers
Body
application/json
Provide the required values for the request body.
Provide first name
Provide last name
Provide email
Provide phone number
Provide date of birth
Provide gender
Provide street address
Provide city
Provide state
Provide country
Provide BVN
Provide NIN
Response
OK
The response is of type object.
⌘I