Get started
Errors
Every response — success or failure — uses the same envelope, so one parser handles everything.
The envelope
success is 1 when the call succeeded and 0 otherwise, message is human-readable, and data carries the payload (an empty object on errors).
{
"success": 0,
"message": "Invalid BVN number provided",
"data": {}
}Status codes
| Code | Meaning | What to do |
|---|---|---|
| 200 | OK | The request succeeded. |
| 201 | Created | The resource was created. |
| 400 | Bad request | Check the request shape against the reference. |
| 401 | Unauthorized | The credential is missing, wrong or revoked. |
| 402 | Insufficient balance | Top up the wallet before retrying. |
| 404 | Not found | The resource or route does not exist. |
| 422 | Validation failed | Fix the invalid or missing fields and retry. |
| 429 | Too many requests | Back off and retry with exponential delay. |
| 500 | Server error | Safe to retry; contact support if it persists. |