Image Match Verification

info

The Image Match Verification API is used to compare the image uploaded and the image on the clients BVN to determine a match.

1.0 Authorization

This API requires an access token. To get more info on how to generate this access token, click on Generating Access Token

2.0 Base Url

All requests to the Image Match Verification API must be done using the web API URL below.

Test Environment: https://api-devapps.vfdbank.systems/vtech-kyc/api/v2/kyc

Live Environment: https://api-apps.vfdbank.systems/vtech-kyc/api/v2/kyc

3.0 How To Use The Image Match Verification API

1. The developer should call the Image Match Verification API

3.1 Image Match Verification

API Context : /image/match

This endpoint confirms if the image uploaded matches what is on the user's bvn.

API METHOD: POST

REQUEST HEADERS

Key	Value
AccessToken	{{token}}

Sample Request

{
    "base64Image":"/9j/4AAQSkZJRgABAQEASABIAAD/4S/SRXhpZgAATU0AKgAAAAgACwALAAIAAAAmAAAIngESA.....",
    "bvn":"22222222252"
}

note

Ensure the image uploaded is in .jpg, .jpeg or .png format.

Request Field Description

Field	Description	Status
base64Image	Image to evaluate, encoded in base64	Mandatory
bvn	22222222252	Mandatory

Sample Responses

{   
    "status": "00",
    "message": "Successful",
    "data":{
        "responseMessage": "Matched image",
        "similarityScore": 99.96447,
        "isMatch": true,
        "bvn": "22222222252"
    }
}

  {
    "status": "00",
    "message": "Successful",
    "data":{
        "responseMessage": "Mismatch facial image",
        "similarityScore": 1.3912822,
        "isMatch": false,
        "bvn": "22222222252"
    }
}