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>"
  }
}
'
{
  "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": ""
}

Documentation Index

Fetch the complete documentation index at: https://developer.embedly.ng/llms.txt

Use this file to discover all available pages before exploring further.

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": ""
}