Ctrl K
Create Customer
POST/api/v1/customers
Creates a new customer (individual or business) and automatically generates a default wallet. No webhook is sent; use the response to confirm success. A reserve_virtual_account.success webhook is sent for the default wallet's virtual account.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| string | Yes | Unique customer email. | |
| name | string | Yes | Customer name. |
| phone | string | Yes | Unique customer phone number. |
| bvn | string | Yes | Customer BVN. |
| id_type | string | Yes | Government ID type: "international_passport", "nin", "voter_card", "driver_license". |
| id_number | string | Yes | ID number for the type. |
| third_party_identifier | string | No | Your internal user ID. |
1
Request Example
(cURL)
curl -X POST "https://api.piggyvest.business/api/v1/customers" \\-H "Authorization: Bearer YOUR_SECRET_KEY" \\-H "Content-Type: application/json" \\-d '{ "email": "myuser@gmail.com", "name": "John Champion", "phone": "08122299933", "bvn": "22112200222", "id_type": "nin", "id_number": "08123490456", "third_party_identifier": "71521345-802f-4934-82bb-e0c8f8ff1e9d"}'2
Success Response(200)
(JSON)
{ "status": true, "message": "Customer created successfully", "data": { "customer_id": "905f18f2-858a-4522-9e38-1f5d18bad423", "wallet_id": "023f843a-be7e-494a-bc5d-9f49f4cc640f" }}3
Error Response(400)
(JSON)
{ "status": false, "message": "An error occurred creating customer"}