Skip to main content
POST
Error

Authorizations

Authorization
string
header
required

Secret API key. Use sk_test_... for sandbox data or sk_live_... for live data (after verification and live mode). Do not use pk_ keys.

Body

application/json

type (nin or bvn) and the 11-digit number.

type
enum<string>
required
Available options:
nin,
bvn
Example:

"bvn"

number
string
required

11-digit NIN or BVN. Not stored.

Example:

"12345678901"

Response

Request succeeded

success
boolean
Example:

true

data
object
meta
object