POST
/
customers
/
add
curl --request POST \
  --url https://waas-staging.embedly.ng/api/v1/customers/add \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "id": "<string>",
  "organizationId": "<string>",
  "firstName": "<string>",
  "lastName": "<string>",
  "middleName": "<string>",
  "emailAddress": "<string>",
  "mobileNumber": "<string>",
  "dob": "<string>",
  "customerTypeId": "<string>",
  "countryId": "<string>",
  "alias": "<string>"
}'
{
    "statuscode": "00",
    "message": "Customer successfully profiled",
    "data": {
      "customerId": "7100987614",
    }
    "errors": [],
}

​
Create Customer

Use this endpoint to create profile for an individual.

​
Additional Information

  • To successfully create a customer profile on Embedly, the customer’s BVN (Bank Verification Number) or NIN (National Identity Number) must be provided. This ensures the customer is KYCed for Tier 1 account creation.

  • Optionally, you can provide both the customer’s BVN (Bank Verification Number) and NIN (National Identification Number). Supplying both identifiers enables KYC up to Tier 2.

It is standard practice to save the returned customerId once you have successfully created a customer. This reduces the number of api calls you have to make to embedly to perform certain actions thereby improving the speed of your application

​
Request Parameters

​
id
string
required
​
organizationId
string
required
​
firstName
string
required

The first name of the individual. Example: John

​
lastName
string
required

The last name of the individual. Example: Doe

​
middleName
string
required

The middle name of the individual. Example: Michael

​
emailAddress
string
required

The individual’s email address. Example: john.doe@example.com

​
mobileNumber
string
required

The individual’s phone number. Example: 08012345678

​
dob
string
required

The individual’s date of birth in YYYY-MM-DD format. Example: 1980-01-01

​
customerTypeId
string
required

The type of customer. (Must be a UUID) Example: f671da57-e281-4b40-965f-a96f4205405e The value should be gotten from the get customer types endpoint in the customer utils section

​
countryId
string
required

The unique identifier of the customer’s nationality. (Must be a UUID) Example: f671da57-e281-4b40-965f-a96f4205405e The value should be gotten from the get countries endpoint in the customer utils section

​
alias
string
{
    "statuscode": "00",
    "message": "Customer successfully profiled",
    "data": {
      "customerId": "7100987614",
    }
    "errors": [],
}