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

# Validate BVN

> The BVN Match service allows you to verify that the first name, last name, and middle name of a user matches their BVN information

### Request

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

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

| Parameters | Type   | Description                               | Required |
| ---------- | ------ | ----------------------------------------- | -------- |
| bvn \*     | string | A valid bvn                               | required |
| first name | string | first name of bvn holder                  | optional |
| last name  | string | last name of bvn holder                   | optional |
| dob        | string | date of birth of bvn holder in yyyy-mm-dd | optional |

#### Sample response

```json [200] theme={null}
{
    "entity": {
        "bvn": {
            "value": "2*****89012",
            "status": true
        },
        "first_name": {
            "confidence_value": 100,
            "status": true
        },
         "last_name": {
            "confidence_value": 100,
            "status": true
        }
    }
}
```

### Response Fields

| Field                                | Type    | Description                                            |
| ------------------------------------ | ------- | ------------------------------------------------------ |
| entity                               | object  | Contains the BVN validation results                    |
| entity.bvn                           | object  | BVN validation result                                  |
| entity.bvn.value                     | string  | The BVN that was validated                             |
| entity.bvn.status                    | boolean | Whether the BVN is valid                               |
| entity.first\_name                   | object  | First name match result                                |
| entity.first\_name.confidence\_value | number  | Confidence score (0-100) for the first name match      |
| entity.first\_name.status            | boolean | Whether the provided first name matches the BVN record |
| entity.last\_name                    | object  | Last name match result                                 |
| entity.last\_name.confidence\_value  | number  | Confidence score (0-100) for the last name match       |
| entity.last\_name.status             | boolean | Whether the provided last name matches the BVN record  |

```json [400] theme={null}
{
    "error": "BVN not found"
}
```

### Error Response Fields

| Field | Type   | Description                                     |
| ----- | ------ | ----------------------------------------------- |
| error | string | Error message describing why the request failed |

### Test Credentials for Sandbox

Kindly use this Test BVN in sandbox Environment

bvn = `22222222222`