Register Card User
https://sandboxapi.onbrails.com/api/v1/virtualcards/registercarduser (opens in a new tab)
You need to onboard a card user before issuing cards for them.p
Body Parameters
| Parameter | type | Required |
|---|---|---|
| customerEmail | string | ✅ |
| idNumber (ID number of the customer's KYC document) | string | ✅ |
idType (type of ID e.g BVN, NIN, PASSPORT ) | string | ✅ |
| firstName | string | ✅ |
| lastName | string | ✅ |
| phoneNumber (Customer's phone number ) | string | ✅ |
| city (Customer's city address ) | string | ✅ |
| state (Customer's state address ) | string | ✅ |
| zipCode (Customer's zipcode ) | string | ✅ |
| line1 (Customer's line1 address ) | string | ✅ |
| houseName (Customer's house name ) | string | ✅ |
| bvn (BVN number, required if customer is Nigerian ) | string | ✅ |
| userPhoto | string | ✅ |
dateOfBirth yyyy-mm-dd | date | Required if customer is Ghanaian |
Request
Virtual Cards/Register card user [POST]
curl --request POST \
--url https://sandboxapi.onbrails.com/api/v1/virtualcards/registercarduser \
--header 'Authorization: Bearer YOUR_SECRET_KEY' \
--header 'accept: application/json' \
--header 'content-type: application/json' \
--data '
{
"customerEmail": "string",
"idNumber": "string",
"idType": "string",
"firstName": "string",
"lastName": "string",
"phoneNumber": "string",
"city": "string",
"state": "string",
"country": "string",
"zipCode": "string",
"line1": "string",
"houseName": "string",
"idImage": "string",
"bvn": "string",
"userPhoto": "string",
"dateOfBirth": "2024-06-28"
}
'