Skip to main content
POST
Full credit picture (TriCredit summary)

Authorizations

X-Numero-Api-Key
string
header
required

Your business API key (live_key_...). Issued on approval; managed in Dashboard β†’ Settings β†’ Developer.

X-Numero-Signature
string
header
required

Base64(HMAC-SHA256(publicApiKey, input)) over the raw request body (POST) or canonicalized query string (signed GET). Also send X-Numero-Signature-Version: v2. Required on money-movement / state-changing endpoints (marked πŸ”’).

The HMAC key is your Public Key as raw UTF-8 bytes β€” a SECRET despite the name, and a different value from the X-Numero-Api-Key authentication header. Signing with the API key will never produce a valid signature.

Body

application/json
bvn
string
required

The borrower's BVN β€” every credit bureau check is keyed by BVN.

idempotencyKey
string | null

Optional; makes a retry safe.

Response

Verification result

Canonical response envelope for the public surface. data on success, error on failure.

data
object
required

Shape varies by product; common fields shown.

error
object | null
required
meta
object
required