Queries

To perform a query, you must provide an <X-App-Wallet-Access-Token> Please, see the authentication section on how to obtain <X-App-Wallet-Access-Token>.

Query BVN

GET https://api.console.eyowo.com/v1/queries/bvn?bvn=

The endpoint validates BVN(s) and returns the BVN holder's details, such as name, date of birth, etc. The service cost at standard BVN charges of N35(Naira) per query.

Query Parameters

NameTypeDescription

bvn

number

valid BVN number for querying

Headers

NameTypeDescription

X-App-Key

string

X-App-Key

X-App-Wallet-Access-Token

string

X-App-Wallet-Access-Token

{
    "success": true,
    "data": {
        "firstName": "DELE",
        "surname": "AHMED",
        "mobileNumber": "07088605494",
        "middleName": "CHINEDU",
        "dateOfBirth": "23-Feb-84",
        "responseMessage": "SUCCESSFUL"
    }
}

Query Data Products

GET https://api.console.eyowo.com/v1/queries/data/:telco

The endpoint returns valid data products for the specified telco.

Query Parameters

NameTypeDescription

telco

number

telcos [mtn, 9mobile, airtel, glo]

Headers

NameTypeDescription

X-App-Key

string

X-App-Key

X-App-Wallet-Access-Token

string

X-App-Wallet-Access-Token

{
    "success": true,
    "data": {
        "products": [
            {
                "productId": "MTN-1-150MB",
                "denomination": 20000,
                "dataAmount": "150MB"
            },
            {
                "productId": "MTN-TEST-1-1GB",
                "denomination": 100000,
                "dataAmount": "1.0GB"
            },
            {
                "productId": "MTN-TEST-1-15GB",
                "denomination": 1000000,
                "dataAmount": "15.0GB"
            },
            {
                "productId": "EYOWO-TEST-1-100MB",
                "denomination": 10000,
                "dataAmount": "100MB"
            },
            {
                "productId": "MTN-1-60GB",
                "denomination": 5500000,
                "dataAmount": "60.0GB"
            }
        ]
    }
}

Last updated