> ## 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.

# Lookup User Accounts

> List bank account numbers (NUBAN) linked to a BVN or mobile number. Use to discover accounts for verification or lending.

Use with the BVN Number or the Mobile Number

### Request

```http [GET] theme={null}
{{baseUrl}}/api/v1/kyc/accounts
```

### Header

| Header        | Type   | Description                                                                                         |
| ------------- | ------ | --------------------------------------------------------------------------------------------------- |
| AppId         | string | Create an app to get your app ID on dashboard [here](https://app.dojah.io/developers/configuration) |
| Authorization | string | Private/secret key. Use `<key>` not `Bearer <key>`                                                  |

### Query parameter

| Parameter      | Type   | Description               | Required |
| -------------- | ------ | ------------------------- | -------- |
| mobile\_number | string | Mobile Number of Customer | required |
| bvn            | string | BVN Number of Customer    | required |

### Sample response

```json Response theme={null}
{
    "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

| Field                              | Type   | Description                                              |
| ---------------------------------- | ------ | -------------------------------------------------------- |
| entity                             | object | Contains the account lookup response data                |
| entity.banks                       | array  | List of bank accounts linked to the BVN or mobile number |
| entity.banks\[].accountDescription | string | Masked account number for the linked bank account        |
| entity.banks\[].bankName           | string | Name of the bank where the account is held               |
| entity.banks\[].bankCode           | string | CBN bank code identifying the bank                       |
| entity.banks\[].mobile\_number     | string | Mobile number associated with the bank account           |
| entity.bvn                         | string | Bank Verification Number linked to the accounts          |
| entity.mobile\_number              | string | Mobile number used for the lookup                        |

### Test Credentials for Sandbox

Kindly use this Test details in sandbox Environment

mobile\_number = `08137877844`

BVN = `22271325557`
