Skip to content

API contractThe partner API contract is published, and the API is open.Read the contract

ProductsIdentity / KYCAvailable at launch

Check a BVN. Keep nothing you do not need.

Send a BVN with the details your user gave you and learn whether each one matches — a result you can act on, never their personal data.

How it works

One call. A match for each detail.

  1. Step 1: Send what your user told you

    Their BVN, first and last name, and date of birth if you have it, with your own reference for that person and an Idempotency-Key.

  2. Step 2: Read the result

    Whether the BVN exists, and whether each detail matches it — with a confidence score where the check gives one. Nothing else comes back.

  3. Step 3: Look it up later

    Every check carries our reference and yours. Look it up by our reference at any time. A person whose details all matched can then place crypto orders.

The call

One call, in the published contract.

POST /v1/partner/identity/bvn
curl https://api.vertexbridge.io/v1/partner/identity/bvn \  -H "X-API-Key: $VERTEXBRIDGE_API_KEY" \  -H "Idempotency-Key: $(uuidgen)" \  -H "Content-Type: application/json" \  -d '{ "bvn": "'"$BVN"'", "first_name": "'"$FIRST_NAME"'", "last_name": "'"$LAST_NAME"'",        "date_of_birth": "'"$DATE_OF_BIRTH"'", "customer_reference": "user_8812",        "your_reference": "kyc-attempt-42" }'

The BVN is 11 digits. The date of birth is optional and written YYYY-MM-DD. Look a check up later with GET /v1/partner/identity/bvn/{reference}. Use a new Idempotency-Key for each check, and the same one for every retry of it.

Data minimised by design

Built to know as little as it can

These are other people’s identities. You need a lawful basis to check one, and to give the person the notice the law requires — see our terms.

  • A result, not a record

    No name, date of birth, phone, photo or address comes back, and none of what you send is kept. The BVN is not stored either; only its last four digits are returned.

  • You pay for an answer

    A check is charged to your balance only when it produces an answer. A BVN that does not exist, or a check we could not run, costs you nothing.

  • Indeterminate, not a guess

    If a check gets no clear answer, it is indeterminate and you are not charged. Ask again with a new Idempotency-Key if you still need one.

  • Yours alone

    Each check is recorded against your reference for that person. Another platform’s reference answers exactly as if it did not exist.

Every field is in the API reference, how retries work in Idempotency, and what a passed check unlocks in Crypto Rails.

Add identity checks to your platform.

Identity checks are enabled per account. Tell us your volumes and we will set up your account and agree your rates.