Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.dojah.io/llms.txt

Use this file to discover all available pages before exploring further.

Use with the BVN Number or the Mobile Number

​
Request

[GET]
{{baseUrl}}/api/v1/kyc/accounts
HeaderTypeDescription
AppIdstringCreate an app to get your app ID on dashboard here
AuthorizationstringPrivate/secret key. Use <key> not Bearer <key>

​
Query parameter

ParameterTypeDescriptionRequired
mobile_numberstringMobile Number of Customerrequired
bvnstringBVN Number of Customerrequired

​
Sample response

Response
{
    "entity": {
        "banks": [
            {
                "accountDescription": "221****095",
                "bankName": "Zenith Bank",
                "bankCode": "057",
                "mobile_number": "2348137877844"
            },
            {
                "account_description": "999****260",
                "bankName": "Access Bank Nigeria Plc",
                "bankCode": "044",
                "mobile_number": "2348137877844"
            },
            {
                "accountDescription": "131****617",
                "bankName": "Access Bank Nigeria Plc",
                "bankCode": "044",
                "mobile_number": "2348137877844"
            },
            {
                "accountDescription": "304XXXX407",
                "bankName": "FBN",
                "bankCode": "011",
                "mobile_number": "2348137877844"
            }
        ],
      "bvn": "2*****25557",
      "mobile_number": "0*****77844"
    }

}

​
Response Fields

FieldTypeDescription
entityobjectContains the account lookup response data
entity.banksarrayList of bank accounts linked to the BVN or mobile number
entity.banks[].accountDescriptionstringMasked account number for the linked bank account
entity.banks[].bankNamestringName of the bank where the account is held
entity.banks[].bankCodestringCBN bank code identifying the bank
entity.banks[].mobile_numberstringMobile number associated with the bank account
entity.bvnstringBank Verification Number linked to the accounts
entity.mobile_numberstringMobile number used for the lookup

​
Test Credentials for Sandbox

Kindly use this Test details in sandbox Environment mobile_number = 08137877844 BVN = 22271325557