> ## 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 BVN: Bank Verification Number Details

> Retrieve identity and account details for a Nigerian Bank Verification Number. Returns name, phone, DOB, and linked account information from the BVN registry.

## BVN Basic

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

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

| Parameter | Type   | Description | Required |
| --------- | ------ | ----------- | -------- |
| bvn \*    | string | A valid bvn | required |

### Sample response

```json Response theme={null}
{
  "entity": {
        "bvn": "2*****234567",
        "first_name": "JOHN",
        "last_name": "MUSA",
        "middle_name": "DOE",
        "gender": "Male",
        "date_of_birth": "1997-05-16",
        "phone_number1": "08012345678",
        "image": "BASE 64 IMAGE",
        "phone_number2": "08012345678"
    }
}
```

### Response Fields

| Field                  | Type   | Description                                 |
| ---------------------- | ------ | ------------------------------------------- |
| entity                 | object | Contains the BVN holder's identity details  |
| entity.bvn             | string | Bank Verification Number                    |
| entity.first\_name     | string | First name of the BVN holder                |
| entity.last\_name      | string | Last name of the BVN holder                 |
| entity.middle\_name    | string | Middle name of the BVN holder               |
| entity.gender          | string | Gender of the BVN holder                    |
| entity.date\_of\_birth | string | Date of birth in YYYY-MM-DD format          |
| entity.phone\_number1  | string | Primary phone number linked to the BVN      |
| entity.image           | string | Base64-encoded photograph of the BVN holder |
| entity.phone\_number2  | string | Secondary phone number linked to the BVN    |

## BVN Advanced

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

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

| Parameter | Type   | Description | Required |
| --------- | ------ | ----------- | -------- |
| bvn \*    | string | A valid bvn | required |

### Sample response

```json Response theme={null}
{
  "entity": {
        "bvn": "2*****234567",
        "first_name": "JOHN",
        "last_name": "MUSA",
        "middle_name": "DOE",
        "gender": "Male",
        "date_of_birth": "1997-05-16",
        "phone_number1": "08012345678",
        "image": "BASE 64 IMAGE",
      	"email": "johndoe@gmail.com",
        "enrollment_bank": "GTB",
        "enrollment_branch": "IKEJA",
        "level_of_account": "LEVEL 2",
        "lga_of_origin": "OSOGBO",
        "lga_of_residence": "IKEJA",
        "marital_status": "SINGLE",
        "name_on_card": "",
        "nationality": "NIGERIAN",
        "phone_number2": "08012345678",
        "registration_date": "",
        "residential_address": "",
        "state_of_origin": "OSUN",
        "state_of_residence": "LAGOS",
        "title": "MISS",
        "watch_listed": "NO"
    }
}
```

### Response Fields

| Field                       | Type   | Description                                   |
| --------------------------- | ------ | --------------------------------------------- |
| entity                      | object | Contains the BVN holder's identity details    |
| entity.bvn                  | string | Bank Verification Number                      |
| entity.first\_name          | string | First name of the BVN holder                  |
| entity.last\_name           | string | Last name of the BVN holder                   |
| entity.middle\_name         | string | Middle name of the BVN holder                 |
| entity.gender               | string | Gender of the BVN holder                      |
| entity.date\_of\_birth      | string | Date of birth in YYYY-MM-DD format            |
| entity.phone\_number1       | string | Primary phone number linked to the BVN        |
| entity.image                | string | Base64-encoded photograph of the BVN holder   |
| entity.email                | string | Email address of the BVN holder               |
| entity.enrollment\_bank     | string | Bank where the BVN was enrolled               |
| entity.enrollment\_branch   | string | Branch where the BVN was enrolled             |
| entity.level\_of\_account   | string | Account level classification                  |
| entity.lga\_of\_origin      | string | Local Government Area of origin               |
| entity.lga\_of\_residence   | string | Local Government Area of residence            |
| entity.marital\_status      | string | Marital status of the BVN holder              |
| entity.name\_on\_card       | string | Name printed on the BVN card                  |
| entity.nationality          | string | Nationality of the BVN holder                 |
| entity.phone\_number2       | string | Secondary phone number linked to the BVN      |
| entity.registration\_date   | string | BVN registration date (DD-MMM-YYYY)           |
| entity.residential\_address | string | Residential address of the BVN holder         |
| entity.state\_of\_origin    | string | State of origin                               |
| entity.state\_of\_residence | string | State of residence                            |
| entity.title                | string | Title of the BVN holder (e.g., Mr, Mrs, Miss) |
| entity.watch\_listed        | string | Whether the BVN holder is on a watchlist      |

### Test Credentials for Sandbox

Kindly use this Test BVN in sandbox Environment

bvn = `22222222222`
