BVN Basic Lookup
Verify a BVN number and retrieve basic identity data (name, date of birth, gender, phone). Requires a valid Idempotency-Key header for live-mode API keys to prevent duplicate charges.
/v1/bvn/basicAuthorization
api-key In: header
Header Parameters
Optional. Trace ID propagated to Prembly for end-to-end log correlation.
Required for live-mode keys. Unique key identifying this request attempt.
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
curl -X POST "https://example.com/v1/bvn/basic" \ -H "Content-Type: application/json" \ -d '{ "number": "22222222222", "consentGranted": true, "consentReference": "CONSENT-REF-2024-001" }'{ "success": true, "statusCode": 200, "message": "Request processed successfully", "timestamp": "2025-10-20T16:30:00.000Z", "path": "/v1/auth/register", "data": { "verificationStatus": "VERIFIED", "referenceId": {}, "verificationId": {}, "charged": true, "chargeAmount": 0, "verificationData": { "firstName": {}, "lastName": {}, "middleName": {}, "dateOfBirth": {}, "phoneNumber1": {} } }}Unique Phone Verification — resolve a phone number to an identity
Resolves a Nigerian mobile number to the identity behind it. Requires an active Unique Phone Verification subscription — this is a separate billable service from Enhanced Phone Lookup, not a tier of it. A result already held from an earlier verification is served from storage and charged at the same price; `source` tells you which you received, and `verifiedAt` is the age of the underlying provider lookup so you can judge freshness yourself. Unlike Enhanced Phone Lookup there is no NIMC fallback: if the number cannot be resolved, the request is refunded rather than retried elsewhere.
BVN Advance Lookup
Verify a BVN and retrieve the full biographic record (address, state of origin, LGA, marital status, etc.). Requires a valid Idempotency-Key header for live-mode keys.