Skip to main content
POST
/
WaasCore
/
api
/
v2
/
customers
/
add
Create Customer (v2)
curl --request POST \
  --url https://waas-staging.embedly.ng/WaasCore/api/v2/customers/add \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "firstName": "<string>",
  "lastName": "<string>",
  "middleName": "<string>",
  "dob": "<string>",
  "customerTypeId": "<string>",
  "alias": "<string>",
  "countryId": "<string>",
  "city": "<string>",
  "address": "<string>",
  "mobileNumber": "<string>",
  "emailAddress": "<string>",
  "gender": "<string>",
  "maritalStatus": "<string>",
  "pepDeclaration": true,
  "employmentStatus": "<string>",
  "occupation": "<string>",
  "sourceOfFunds": "<string>",
  "passportUrl": "<string>",
  "mothersMaidenName": "<string>",
  "nextOfKin": {
    "surname": "<string>",
    "firstName": "<string>",
    "otherNames": "<string>",
    "relationship": "<string>",
    "mobileNumber": "<string>",
    "address": "<string>"
  }
}
'
import requests

url = "https://waas-staging.embedly.ng/WaasCore/api/v2/customers/add"

payload = {
    "firstName": "<string>",
    "lastName": "<string>",
    "middleName": "<string>",
    "dob": "<string>",
    "customerTypeId": "<string>",
    "alias": "<string>",
    "countryId": "<string>",
    "city": "<string>",
    "address": "<string>",
    "mobileNumber": "<string>",
    "emailAddress": "<string>",
    "gender": "<string>",
    "maritalStatus": "<string>",
    "pepDeclaration": True,
    "employmentStatus": "<string>",
    "occupation": "<string>",
    "sourceOfFunds": "<string>",
    "passportUrl": "<string>",
    "mothersMaidenName": "<string>",
    "nextOfKin": {
        "surname": "<string>",
        "firstName": "<string>",
        "otherNames": "<string>",
        "relationship": "<string>",
        "mobileNumber": "<string>",
        "address": "<string>"
    }
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    firstName: '<string>',
    lastName: '<string>',
    middleName: '<string>',
    dob: '<string>',
    customerTypeId: '<string>',
    alias: '<string>',
    countryId: '<string>',
    city: '<string>',
    address: '<string>',
    mobileNumber: '<string>',
    emailAddress: '<string>',
    gender: '<string>',
    maritalStatus: '<string>',
    pepDeclaration: true,
    employmentStatus: '<string>',
    occupation: '<string>',
    sourceOfFunds: '<string>',
    passportUrl: '<string>',
    mothersMaidenName: '<string>',
    nextOfKin: {
      surname: '<string>',
      firstName: '<string>',
      otherNames: '<string>',
      relationship: '<string>',
      mobileNumber: '<string>',
      address: '<string>'
    }
  })
};

fetch('https://waas-staging.embedly.ng/WaasCore/api/v2/customers/add', 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://waas-staging.embedly.ng/WaasCore/api/v2/customers/add",
  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([
    'firstName' => '<string>',
    'lastName' => '<string>',
    'middleName' => '<string>',
    'dob' => '<string>',
    'customerTypeId' => '<string>',
    'alias' => '<string>',
    'countryId' => '<string>',
    'city' => '<string>',
    'address' => '<string>',
    'mobileNumber' => '<string>',
    'emailAddress' => '<string>',
    'gender' => '<string>',
    'maritalStatus' => '<string>',
    'pepDeclaration' => true,
    'employmentStatus' => '<string>',
    'occupation' => '<string>',
    'sourceOfFunds' => '<string>',
    'passportUrl' => '<string>',
    'mothersMaidenName' => '<string>',
    'nextOfKin' => [
        'surname' => '<string>',
        'firstName' => '<string>',
        'otherNames' => '<string>',
        'relationship' => '<string>',
        'mobileNumber' => '<string>',
        'address' => '<string>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://waas-staging.embedly.ng/WaasCore/api/v2/customers/add"

	payload := strings.NewReader("{\n  \"firstName\": \"<string>\",\n  \"lastName\": \"<string>\",\n  \"middleName\": \"<string>\",\n  \"dob\": \"<string>\",\n  \"customerTypeId\": \"<string>\",\n  \"alias\": \"<string>\",\n  \"countryId\": \"<string>\",\n  \"city\": \"<string>\",\n  \"address\": \"<string>\",\n  \"mobileNumber\": \"<string>\",\n  \"emailAddress\": \"<string>\",\n  \"gender\": \"<string>\",\n  \"maritalStatus\": \"<string>\",\n  \"pepDeclaration\": true,\n  \"employmentStatus\": \"<string>\",\n  \"occupation\": \"<string>\",\n  \"sourceOfFunds\": \"<string>\",\n  \"passportUrl\": \"<string>\",\n  \"mothersMaidenName\": \"<string>\",\n  \"nextOfKin\": {\n    \"surname\": \"<string>\",\n    \"firstName\": \"<string>\",\n    \"otherNames\": \"<string>\",\n    \"relationship\": \"<string>\",\n    \"mobileNumber\": \"<string>\",\n    \"address\": \"<string>\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-api-key", "<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))

}
HttpResponse<String> response = Unirest.post("https://waas-staging.embedly.ng/WaasCore/api/v2/customers/add")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"firstName\": \"<string>\",\n  \"lastName\": \"<string>\",\n  \"middleName\": \"<string>\",\n  \"dob\": \"<string>\",\n  \"customerTypeId\": \"<string>\",\n  \"alias\": \"<string>\",\n  \"countryId\": \"<string>\",\n  \"city\": \"<string>\",\n  \"address\": \"<string>\",\n  \"mobileNumber\": \"<string>\",\n  \"emailAddress\": \"<string>\",\n  \"gender\": \"<string>\",\n  \"maritalStatus\": \"<string>\",\n  \"pepDeclaration\": true,\n  \"employmentStatus\": \"<string>\",\n  \"occupation\": \"<string>\",\n  \"sourceOfFunds\": \"<string>\",\n  \"passportUrl\": \"<string>\",\n  \"mothersMaidenName\": \"<string>\",\n  \"nextOfKin\": {\n    \"surname\": \"<string>\",\n    \"firstName\": \"<string>\",\n    \"otherNames\": \"<string>\",\n    \"relationship\": \"<string>\",\n    \"mobileNumber\": \"<string>\",\n    \"address\": \"<string>\"\n  }\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://waas-staging.embedly.ng/WaasCore/api/v2/customers/add")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"firstName\": \"<string>\",\n  \"lastName\": \"<string>\",\n  \"middleName\": \"<string>\",\n  \"dob\": \"<string>\",\n  \"customerTypeId\": \"<string>\",\n  \"alias\": \"<string>\",\n  \"countryId\": \"<string>\",\n  \"city\": \"<string>\",\n  \"address\": \"<string>\",\n  \"mobileNumber\": \"<string>\",\n  \"emailAddress\": \"<string>\",\n  \"gender\": \"<string>\",\n  \"maritalStatus\": \"<string>\",\n  \"pepDeclaration\": true,\n  \"employmentStatus\": \"<string>\",\n  \"occupation\": \"<string>\",\n  \"sourceOfFunds\": \"<string>\",\n  \"passportUrl\": \"<string>\",\n  \"mothersMaidenName\": \"<string>\",\n  \"nextOfKin\": {\n    \"surname\": \"<string>\",\n    \"firstName\": \"<string>\",\n    \"otherNames\": \"<string>\",\n    \"relationship\": \"<string>\",\n    \"mobileNumber\": \"<string>\",\n    \"address\": \"<string>\"\n  }\n}"

response = http.request(request)
puts response.read_body
{
  "data": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "firstName": "John",
    "middleName": null,
    "lastName": "Doe",
    "dob": "2000-01-15T00:00:00",
    "organizationId": "ecbf7606-30c3-11f0-a818-6045bd97b81d",
    "city": "Lagos",
    "address": "12 Example Street",
    "countryId": "9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d",
    "customerTypeId": "9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6e",
    "emailAddress": "john.doe@example.com",
    "mobileNumber": "08012345678",
    "customerTierId": 0,
    "gender": "Male",
    "occupation": "Engineer",
    "maritalStatus": "Single",
    "pepDeclaration": false,
    "employmentStatus": "Employed",
    "sourceOfFunds": "MonthlySalary",
    "passportUrl": "https://storage.example.com/passport.jpg",
    "mothersMaidenName": "Smith",
    "nextOfKin": {
      "surname": "Doe",
      "firstName": "Jane",
      "otherNames": null,
      "relationship": "Spouse",
      "mobileNumber": "08098765432",
      "address": "12 Example Street"
    }
  },
  "status": 201,
  "message": ""
}

{
  "data": null,
  "status": 400,
  "message": "employmentStatus is required"
}

{
  "data": null,
  "status": 404,
  "message": "Customer Type not found"
}

{
  "data": null,
  "status": 500,
  "message": "An unexpected error occurred"
}
Use this v2 endpoint to create an individual customer profile.

​
Request Parameters

​
firstName
string
required
Customer’s first name. Example: John
​
lastName
string
required
Customer’s last name. Example: Doe
​
middleName
string
Customer’s middle name.
​
dob
string
required
Must be greater than 18 years. Date of birth in ISO format. Example: 2000-01-15T00:00:00
​
customerTypeId
string
required
The customer’s type (UUID).
​
alias
string
Optional display name for the customer.
​
countryId
string
required
Customer’s nationality (UUID).
​
city
string
required
Customer’s residential city. Example: Lagos
​
address
string
required
Customer’s residential address. Example: 12 Example Street
​
mobileNumber
string
Customer’s phone number. Optional only for closed organisations. Example: 08012345678
​
emailAddress
string
required
Customer’s email. Optional only for closed organisations. Example: john.doe@example.com
​
gender
string
Customer’s gender. Example: Male
​
maritalStatus
string
Customer’s marital status. Example: Single
​
pepDeclaration
boolean
Politically Exposed Person declaration.
​
employmentStatus
string
Employment status. Example: Employed
​
occupation
string
Customer’s occupation. Example: Engineer
​
sourceOfFunds
string
Source of funds. Example: MonthlySalary
​
passportUrl
string
URL to customer’s passport photograph.
​
mothersMaidenName
string
Customer’s mother’s maiden name.
​
nextOfKin
object
Next of kin details.
{
  "data": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "firstName": "John",
    "middleName": null,
    "lastName": "Doe",
    "dob": "2000-01-15T00:00:00",
    "organizationId": "ecbf7606-30c3-11f0-a818-6045bd97b81d",
    "city": "Lagos",
    "address": "12 Example Street",
    "countryId": "9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d",
    "customerTypeId": "9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6e",
    "emailAddress": "john.doe@example.com",
    "mobileNumber": "08012345678",
    "customerTierId": 0,
    "gender": "Male",
    "occupation": "Engineer",
    "maritalStatus": "Single",
    "pepDeclaration": false,
    "employmentStatus": "Employed",
    "sourceOfFunds": "MonthlySalary",
    "passportUrl": "https://storage.example.com/passport.jpg",
    "mothersMaidenName": "Smith",
    "nextOfKin": {
      "surname": "Doe",
      "firstName": "Jane",
      "otherNames": null,
      "relationship": "Spouse",
      "mobileNumber": "08098765432",
      "address": "12 Example Street"
    }
  },
  "status": 201,
  "message": ""
}

{
  "data": null,
  "status": 400,
  "message": "employmentStatus is required"
}

{
  "data": null,
  "status": 404,
  "message": "Customer Type not found"
}

{
  "data": null,
  "status": 500,
  "message": "An unexpected error occurred"
}