Product
Query bvn
Query BVN Information
Interface Information
- Endpoint:
/order/third/facade/merchant/server/queryBvn - Method:
POST - Description: Query merchant BVN (Bank Verification Number) information
- Encryption: Both request and response must be encrypted
Request Parameters
Content-Type: application/json
| Parameter | Type | Required | Description | Example Value |
|---|---|---|---|---|
| merchantCode | String | Yes | Merchant code | MERCHANT001 |
| data | Object | Yes | Request data | {"bvn": "12345678901"} |
| timestamp | Long | Yes | Timestamp | 1714567890000 |
| sign | String | Yes | Signature | signature |
Response Parameters
Content-Type: application/json
{ "code": "100000", "message": "SUCCESS", "data": { "result": { "bvn": "12345678901", "firstname": "John", "lastname": "Doe", "middlename": "Michael", "birthdate": "1990-01-01", "phone": "08012345678", "phone2": "08012345679", "gender": "Male", "residentialAddress": "123 Lagos Street", "stateOfOrigin": "Lagos", "lgaOfOrigin": "Ikeja", "nationality": "Nigerian", "nin": "1234567890123", "email": "[email protected]", "photo": "base64_encoded_photo_string" } }, "merchantCode": "MERCHANT001" }
Response Field Description
| Field | Type | Description |
|---|---|---|
| result | Object | BVN verification result |
| result.bvn | Long | BVN number |
| result.firstname | String | First name |
| result.lastname | String | Last name |
| result.middlename | String | Middle name |
| result.birthdate | String | Date of birth |
| result.phone | String | Phone number |
| result.phone2 | String | Alternative phone number |
| result.gender | String | Gender |
| result.residentialAddress | String | Residential address |
| result.stateOfOrigin | String | State of origin |
| result.lgaOfOrigin | String | Local government area of origin |
| result.nationality | String | Nationality |
| result.nin | String | National Identification Number |
| result.email | String | Email address |
| result.photo | String | BVN photo (Base64 encoded) |
Response Field Description
| Field | Type | Description |
|---|---|---|
| result | Object | NIN verification result |
| result.nin | String | NIN number |
| result.firstname | String | First name |
| result.lastname | String | Last name |
| result.middlename | String | Middle name |
| result.birthdate | String | Date of birth |
| result.phone | String | Phone number |
| result.gender | String | Gender |
| result.photo | String | NIN photo (Base64 encoded) |
| result.residence | Object | Residence information |
| result.residence.address1 | String | Address line 1 |
| result.residence.lga | String | Local government area |
| result.residence.state | String | State |
General Notes
- Encryption: All interfaces require encryption for both request and response
- Signature Verification: All interfaces require signature verification to ensure request authenticity
- Timestamp Format: Timestamps use millisecond precision (Unix timestamp in milliseconds)
- Request/Response Format: All data is transmitted in JSON format