BVN Check API

Module ID

nga_bvn_check_api

info

What do these terms mean?

Module Description

Fetch details of a customer from BVN database

Module Inputs

• BVN Number

Module Configurations

No configurations are supported currently

Module Outputs

The following information is returned in the Results API

Success Scenario

{
  "moduleId": "nga_bvn_check_api",
  "moduleName":"Nigeria BVN Check",
  "apiResponse": {
    "status": "success",
    "statusCode": "200",
    "result": {
        "detail": "Verification Successful",
        "response_code": "00",
        "bvn_data": {
            "title": "Mr",
            "gender": "Male",
            "maritalStatus": "Single",
            "watchListed": "YES",
            "levelOfAccount": "Level 1 Account",
            "bvn": "54651333604",
            "firstName": "TEST",
            "middleName": "test",
            "lastName": "test",
            "dateOfBirth": "1999-12-21",
            "phoneNumber1": "09082838483",
            "phoneNumber2": "08028323323",
            "registrationDate": "2005-12-21",
            "enrollmentBank": "034",
            "enrollmentBranch": "YABA, Lagos",
            "email": "testt@test.com",
            "lgaOfOrigin": "yaba",
            "lgaOfResidence": "yaba",
            "nin": "12345567895",
            "nameOnCard": "test test",
            "nationality": "Nigeria",
            "residentialAddress": "yaba",
            "stateOfOrigin": "Lagos",
            "stateOfResidence": "Lagos",
            "photo": "base 64 string"
        }
    }
}
}

Understanding the Response

Key	Description	Values Possible
moduleId	ID of the module	nga_bvn_check_api
module	Name of the module that was setup in your workflow config	BVN Check API
apiResponse	The API results provided by HyperVerge's backend. If there were multiple attempts made by the user, this key will contain the latest attempt	JSON
previousAttempts	If there were multiple attempts made by the users, this array will contain the older attempts, sorted from latest to oldest	JSON Array

Failure Scenarios

Below is the response in Results API for a typical error scenario.

{
  "moduleId": "nga_bvn_check_api",
  "moduleName": "Nigeria BVN Check",
  "apiResponse": {
    "status": "success",
    "statusCode": "200",
    "result": {
        "detail": "Bank Verification failed",
        "response_code": "01",
        "message": "BVN not Found"
    }
  }
}