BVN Validation Request

AUTHORIZATION

Authorization: IP Check and Header authorization/bearer token.

The authorization details will be shared privately.

After obtaining the BVN from the user, send the request payload to the Netapps BVN validation API.

Request Method: POST

Request URL:

👍

https://bvn-validation.netapps.ng/api/v1/request

Request Payload: RAW POST DATA, Content-Type: application/json

{ 
  "callbackURL" : "example.com/bvn-validation", 
  "scope": ["profile"],
  "payload": [ 
    { 
      "bvn": "21234123456", 
     	"phone": "07034477723", 
     	"email": "[email protected]" },
    {	
      "bvn": "21234123457", 
      "phone": "07034477723", 
      "email": "[email protected]" 
    },
    {	
      "bvn": "2123412347", 
      "phone": "07034477723", 
      "email": "[email protected]" 
    },
    {...}, 
   ] 
}

Response: Content-Type: application/json

Success Response Body:

{ 
  "flag" : true, 
  "auth" : true, 
  "msg" : "Request submitted", 
  "data" : {
    "ref" : "a76ce6Tz11Pq",
    "invalidRecords": [
    	{	
      "bvn": "2123412347", 
      "phone": "07034477723", 
      "email": "[email protected]" 
    }
    ]
  }
}

Success Response Description:

The response is a JSON response and contains the following data:

flag (Bool): This is the state of the submitted request.

auth (Bool): This is the status of the submitted request

msg (String): This is the returned message.

data (Object). The data is an Object containing the ref (String) of the request

Error Response Body:

{ 
  "flag" : false,
  "auth" : false,
  "msg" : "Not authorized",
  "data" : {}
}

Error Response Description:

Possible cause of error:

  1. Failed authentication,
  2. Server downtime