Skip to content
HitchPay API Docs

Identity

Overview

Look up a Nigerian BVN or NIN and get the identity record back in the response. Each successful lookup is a paid, per-call product billed to your merchant wallet. BVN and NIN are priced separately.

/v1/identity

All Identity Verification endpoints live under this base path.

Important: This is a standalone identity-lookup product. It is not the same as Customer KYC, which attaches verifications to a stored customer and gates account issuance. Use this section when you only need to resolve a BVN/NIN and read back the details — see the Customer Enrollment & KYC section instead if you're verifying a customer for account or card issuance.

Use this section to

  • Look up a BVN or NIN and get the identity details back directly, without creating a customer
  • Test the full request/response in the sandbox before spending a real lookup

Response format

Success

{
  "status": "success",
  "message": "...",
  "data": { }
}

Error

{
  "status": "error",
  "code": "ERROR_CODE",
  "message": "..."
}

Pricing

Product Charged when
bvn-verification A BVN lookup returns a record
nin-verification A NIN lookup returns a record

Prices are set per merchant/platform and can change without an API change. The price applied to a call is echoed back as fee in the response. If a product isn't currently priced/enabled, the endpoint returns SERVICE_UNAVAILABLE and nothing is charged.

Billing guarantee: you are only charged when verified: true is returned. On any failure the wallet is left whole; a debit, if it happened, is refunded automatically.

Questions? Email [email protected]. Also on GitBook.