Name Inquiry By Account
Endpoint
GET /api/v1/inquiry/bank-code/{SORT_CODE}/account/{ACCOUNT_NUMBER} |
Request
Request Path Variable Description
# | Path Variable Name | Data Type | Required | Description |
---|---|---|---|---|
1 | SORT_CODE | Integer | True | This must be a valid bank’s CBN code. |
2 | ACCOUNT_NUMBER | Integer | True | This must be a valid account number of any Nigerian bank. |
Sample Request
/api/v1/inquiry/bank/058/account/0987654321 |
Header
Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJhdWQiOlsiY2FyZGxlc3Mtc2VydmljZSIsImNyZWRpdC1zY29yZS1zZXJ2aWNlIiwiaW5jb2duaXRvIiwiaXN3LWNvbGxlY3Rpb25zIiwiaXN3LWNvcmUiLCJpc3ctbGVuZGluZy1zZXJ2aWNlIiwiaXN3LXBheW1lbnRnYXRld2F5IiwicGFzc3BvcnQiLCJwYXltZW50LXNlcnZpY2UiLCJwcm9qZWN0LXgtbWVyY2hhbnQiLCJwd20iLCJ2YXVsdCJdLCJtZXJjaGFudF9jb2RlIjoiTVgxODciLCJwcm9kdWN0aW9uX3BheW1lbnRfY29kZSI6IjAwMTY0NjM5ODU0IiwicmVxdWVzdG9yX2lkIjoiMDAxMTc2MTQ5OTIiLCJzY29wZSI6WyJwcm9maWxlIl0sImp0aSI6IjY5NWZlYWQyLWMwZjgtNDNlMS04YzgxLTUzM2Y2NjUyYWI2YSIsInBheWFibGVfaWQiOiIyMzI0IiwiY2xpZW50X2lkIjoiSUtJQTk2MTRCODIwNjRENjMyRTlCNjQxOERGMzU4QTZBNEFFQTg0RDcyMTgiLCJwYXltZW50X2NvZGUiOiIwNDI1OTQxMzAyNDYifQ |
---|
Response
Response Body Description(Success)
# | Field Name | Data Type | Description |
---|---|---|---|
1 | responseCode | String | The Code representing the status of the processing of the request. It shows whether account inquiry was successful or not. |
2 | responseMessage | String | The Description of the Response Code from above. |
3 | bvn | String | The account holder’s Bank Verification Number(BVN) |
4 | accountNumber | String | The account holder’s account number. |
5 | accountName | String | The account holder’s account name. |
6 | bankCode | String | The bank’s CBN code. |
7 | firstName | String | The account holder’s first name |
8 | lastName | String | The account holder’s last name |
9 | dob | String | The account holder’s date of birth (Format: dd-MMM-yy) |
10 | phone | String | The account holder’s mobile phone number |
11 | residentialAddress | String | The account holder’s residential address |
Sample Response (Success)
{ “responseCode”: “00”, “responseMessage”: “Successful”, “bvn”: “12345678901”, “accountNumber”: “0987654321”, “accountName”: “JOHN JUNIOR DOE”, “bankCode”: “058”, “firstName”: “JOHN”, “lastName”: “DOE”, “dob”: ““01-Jan-70”, “phone”: “08012345678”, “residentialAddress”: “8 MARS FLAT,JOHNSON CRES. IKORODU ROAD LAGOS STATE” } |
Response Body Description(Failure)
# | Field Name | Data Type | Description |
---|---|---|---|
1 | responseCode | String | The Code representing the status of the processing of the request. It shows whether account inquiry was successful or not. |
2 | responseMessage | String | The Description of the Response Code from above. |
Sample Response(Failure)
{ “responseCode”: “10400”, “responseMessage”: “Invalid CBN Bank Code supplied” } |
Name Inquiry By BVN
Endpoint
GET /api/v1/inquiry/bvn/{BVN} |
Request
Request Path Variable Description
# | Path Variable Name | Data Type | Required | Description |
---|---|---|---|---|
1 | BVN | Integer | True | The account hollder’s Bank Verification Number(BVN) |
Sample Request
/api/v1/inquiry/bvn/12345678901 |
Header
Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJhdWQiOlsiY2FyZGxlc3Mtc2VydmljZSIsImNyZWRpdC1zY29yZS1zZXJ2aWNlIiwiaW5jb2duaXRvIiwiaXN3LWNvbGxlY3Rpb25zIiwiaXN3LWNvcmUiLCJpc3ctbGVuZGluZy1zZXJ2aWNlIiwiaXN3LXBheW1lbnRnYXRld2F5IiwicGFzc3BvcnQiLCJwYXltZW50LXNlcnZpY2UiLCJwcm9qZWN0LXgtbWVyY2hhbnQiLCJwd20iLCJ2YXVsdCJdLCJtZXJjaGFudF9jb2RlIjoiTVgxODciLCJwcm9kdWN0aW9uX3BheW1lbnRfY29kZSI6IjAwMTY0NjM5ODU0IiwicmVxdWVzdG9yX2lkIjoiMDAxMTc2MTQ5OTIiLCJzY29wZSI6WyJwcm9maWxlIl0sImp0aSI6IjY5NWZlYWQyLWMwZjgtNDNlMS04YzgxLTUzM2Y2NjUyYWI2YSIsInBheWFibGVfaWQiOiIyMzI0IiwiY2xpZW50X2lkIjoiSUtJQTk2MTRCODIwNjRENjMyRTlCNjQxOERGMzU4QTZBNEFFQTg0RDcyMTgiLCJwYXltZW50X2NvZGUiOiIwNDI1OTQxMzAyNDYifQ |
---|
Response
Response Body Description(Success)
# | Field Name | Data Type | Description |
---|---|---|---|
# | Field Name | Data Type | Description |
1 | responseCode | String | The Code representing the status of the processing of the request. It shows whether account inquiry was successful or not. |
2 | responseMessage | String | The Description of the Response Code from above. |
3 | bvn | String | The account holder’s Bank Verification Number(BVN) |
4 | firstName | String | The account holder’s first name |
5 | lastName | String | The account holder’s last name |
6 | dob | String | The account holder’s date of birth (Format: dd-MMM-yy) |
7 | phone | String | The account holder’s mobile phone number |
8 | residentialAddress | String | The account holder’s residential address |
Sample Response (Success)
{ “responseCode”: “00”, “responseMessage”: “Successful”, “bvn”: “12345678901”, “firstName”: “JOHN”, “lastName”: “DOE”, “dob”: ““01-Jan-70”, “phone”: “08012345678”, “residentialAddress”: “8 MARS FLAT,JOHNSON CRES. IKORODU ROAD LAGOS STATE” } |
Response Body Description(Failure)
# | Field Name | Data Type | Description |
---|---|---|---|
1 | responseCode | String | The Code representing the status of the processing of the request. It shows whether account inquiry was successful or not. |
2 | responseMessage | String | The Description of the Response Code from above. |
Sample Response(Failure)
{ “responseCode”: “10400”, “responseMessage”: “Invalid BVN Specified” } |