VerifyMe API
  • Welcome
  • general
    • Getting Started
    • Introduction
    • Authentication
    • About Verifications
  • Identity verifications
    • Bank Verification Number (BVN)
    • Corporate Affairs Commission
    • Drivers License
    • Identity Biometrics
    • BVN Identity Matching
    • Virtual NIN (vNIN)
    • National Identification Number(NIN)
    • Tax Identification Number
    • Voters Card
  • Address Verification
  • Submit Address Verification
  • Get Address Verification By ID
  • Get Address Verifications
  • Cancel Address Verification
  • Fetch an Address By Identity
  • Business Verification
    • Submit Business Verification
    • Get Business Verification By ID
    • Get Business Verifications
    • Cancel Business Verification
  • Guarantor Verification
    • Submit Guarantor Verification
    • Get Guarantor Verifications
    • Get Guarantor Verification By ID
    • Cancel Guarantor Verification
  • employment Verification
    • Submit Employment History Verification
    • Get Employment History Verifications
    • Get Employment History Verification By ID
    • Cancel Employment History Verification
  • Property Verification
    • Submit Property Verification
  • Liveness Verification
  • LOCATION
    • Get Countries
    • Get Country By ID
    • Get State By ID
    • Get State For Country
    • Get Lga By Country
    • Get Lga By State
    • Get Lga By ID
  • Bank
    • Get Banks
    • Get Account Details
  • BVN NUBAN
    • Get Nuban Banks
    • Get BVN details by NUBAN
  • webhooks
    • About Webhooks
    • Verified Address
    • Verified Guarantor
    • Verified Employment History
    • Verified Property
  • Product statuses
  • Error Status Codes
  • Glossary
  • Widget Services
    • VerifyMe Liveness Widget
    • Requery Liveness Verification
Powered by GitBook
On this page

Was this helpful?

  1. Identity verifications

BVN Identity Matching

BVN Identity Boolean matching

Please note that when using your test key, Our test persona is John Doe and his BVN is 10000000001. Hence all matching done with your test keys with details other than our Test Persona would simulate a failed identity matching.

John Doe's matching test

ID_SAMPLE = {
    idNumber: '10000000001',
    firstname: 'John',
    lastname: 'Doe',
    dob: '04-04-1944',
    gender: 'male',
    email: 'johndoe@test.ng',
    phone: '+2348000000001'
}
{
    "firstname": "JOHN",
    "lastname": "Doe",
    "phone": "+2348000000001",
    "dob": "04-04-1944",
    "gender": "female",
    "email": "johndoe@test.ng"
}
curl --location --request POST 'https://vapi.verifyme.ng/v1/verifications/identities/bvn/10000000001/match' \
--header 'Authorization: Bearer {your secret key}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "firstname": "JOHN",
    "lastname": "DOe",
    "phone": "+2348000000001",
    "dob": "04-04-1944",
    "gender": "female",
    "email": "johndoe@test.ng"
}
'

Identity Matching

POST https://vapi.verifyme.ng/v1/verifications/identities/bvn/:ref/match

Use this endpoint to match data supplied to bvn verified data

Path Parameters

Name
Type
Description

ref*

string

BVN number

Headers

Name
Type
Description

Authorization*

string

Authorization Header

Request Body

Name
Type
Description

firstname

string

First name

emailAddress

string

Email address

phoneNumber

String

Phone number

dob

String

Date of birth

lastname

String

Last name

gender

String

Gender

{
    "status": "success",
    "data": {
        "bvn": "10000000001",
        "fieldMatches": {
            "firstname": true,
            "lastname": true,
            "dob": true,
            "gender": false,
            "phoneNumber": true,
            "emailAddress": true
        }
    }
}
{
    "statusCode": 401,
    "error": "Unauthorized"
}
{
    "code":"NOT_FOUND_ERROR",
    "message":"BVN provided is not found. Please provide a valid bvn"
}
PreviousIdentity BiometricsNextVirtual NIN (vNIN)

Last updated 2 years ago

Was this helpful?