Skip to content
Join the waitlist
VerathYour digital identity. Reimagined.

Verath API docs

Introduction

The Verath KYC API checks Nigerian identity numbers (NIN, vNIN and BVN), matches faces, screens names against sanctions lists and sends verification links, through one API key. When a source goes down, Verath answers from the next one, so your onboarding keeps working.

Base URL

Every call goes to the same address, with test and live calls told apart by the key:

https://api.verath.io

Requests and responses are JSON over HTTPS. Amounts are in kobo (₦1 = 100 kobo). Times are ISO 8601 in UTC.

Your first call

Create a business account, open Developers in the console and create a test key (vk_test_…). Then check the sandbox NIN:

curl -X POST https://api.verath.io/v1/kyc/nin/basic \
  -H "Authorization: Bearer $VERATH_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: onb_cust_1042" \
  -d '{"nin":"70000000006","first_name":"Ngozi","last_name":"Lagbaja","dob":"1994-05-14","purpose":"KYC-ONB","customer_ref":"cust_1042"}'

You get back whether the number exists and whether each detail matches. See Reading a result.

How Verath works

  • Match-first. You get per-field match results, not the person’s record. Businesses approved for records also get record fields once, when the source allows it.
  • Outage-proof. If no source answers, the check is pending and retried for up to 72 hours. You get a webhook when it finishes. Pending and failed checks are never billed.
  • No full numbers kept. Verath stores the last digits of an ID number, never the whole number.
  • Purpose on every check. Each call records why you’re checking, for your audit trail and the person’s.

Guides

AuthenticationAPI keys, test and live mode, idempotency and rate limits.Reading a resultMatch-first results: found, match_result, match scores, route and cost.Sandbox and test dataTest numbers, the test person, simulated outages and test selfies.WebhooksPending checks, verification.completed, verification.failed, wallet.low_balance and signatures.ErrorsError codes, what they mean and what to do.Going liveCompany review, live keys, funding the wallet and switching products on.

API reference

The same reference as an OpenAPI 3.1 file, for Postman, Insomnia or code generators: openapi.json.