Customers
Customers are verified end consumers of your organization. Create a Customer with BVN, phone, and email.
Use the Customers API whenever you need a verified end consumer identity under your merchant organization.
Create Customer POST/customers
Creates a verified Organization Customer by BVN, or returns the existing Customer for the same organization and BVN.
Request Body
- Name
bvn- Type
- string
- Description
Bank Verification Number. Must be exactly 11 digits.
- Name
phone- Type
- string
- Description
Customer phone in international format with country code only.
- Name
email- Type
- string
- Description
Customer email address.
Names and profile fields are filled from the BVN identity fetch — do not send first_name / last_name.
Phone must be international with country code only (for example +2348012345678). Response BVN is masked.
Creation is idempotent on organization plus BVN.
curl https://api.aellaapp.com/customers \
-X POST \
-H "Content-Type: application/json" \
-d '{"bvn":"22122212221","phone":"+2348012345678","email":"john.doe@example.com"}' \
-H "Authorization: Bearer {token}"
Response
{
"success": true,
"message": "Customer created successfully",
"data": {
"id": "cust-uuid",
"bvn": "22*****221",
"first_name": "John",
"last_name": "Doe",
"gender": "Male",
"date_of_birth": "1990-01-01",
"phone": "+2348012345678",
"email": "john.doe@example.com",
"created_at": "2026-07-27T10:00:00.000Z"
},
"status": 200
}
Get Customer GET/customers/{customerId}
Fetches a Customer owned by the authenticated merchant's organization. Response BVN is masked. Internal platform user linkage is not exposed.
Path Parameters
- Name
customerId- Type
- string
- Description
Customer id returned from Create Customer.
curl https://api.aellaapp.com/customers/cust-uuid \
-H "Authorization: Bearer {token}"
Response
{
"success": true,
"message": "Customer retrieved successfully",
"data": {
"id": "cust-uuid",
"bvn": "22*****221",
"first_name": "John",
"last_name": "Doe",
"gender": "Male",
"date_of_birth": "1990-01-01",
"phone": "+2348012345678",
"email": "john.doe@example.com",
"created_at": "2026-07-27T10:00:00.000Z"
},
"status": 200
}