> ## Documentation Index
> Fetch the complete documentation index at: https://docs.smartcomply.com/llms.txt
> Use this file to discover all available pages before exploring further.

# BVN with Face

> Verify a customer's BVN combined with a selfie for enhanced identity confirmation.

The BVN with Face endpoint verifies a customer's Bank Verification Number and performs a facial comparison against a provided photo URL. It returns the full BVN profile plus a match confidence score.

## Endpoint

```
POST /api/onboarding/nigeria_kyc/bvn_with_face/
```

## Request

### Headers

| Header           | Value               | Required |
| ---------------- | ------------------- | -------- |
| `x-access-token` | Your API secret key | Yes      |
| `Content-Type`   | `application/json`  | Yes      |

### Body Parameters

| Parameter      | Type   | Required | Description                                       |
| -------------- | ------ | -------- | ------------------------------------------------- |
| `bvn`          | string | Yes      | The customer's 11-digit Bank Verification Number  |
| `image_upload` | string | Yes      | URL of the customer's photo for facial comparison |

### Example

<CodeGroup>
  ```bash cURL theme={null}
  curl -X POST "https://adhere-api.smartcomply.com/api/onboarding/nigeria_kyc/bvn_with_face/" \
    -H "x-access-token: YOUR_SECRET_KEY" \
    -H "Content-Type: application/json" \
    -d '{"bvn": "22000000001", "image_upload": "https://example.com/photo.jpg"}'
  ```

  ```javascript Node.js theme={null}
  const response = await fetch(
    "https://adhere-api.smartcomply.com/api/onboarding/nigeria_kyc/bvn_with_face/",
    {
      method: "POST",
      headers: { "x-access-token": "YOUR_SECRET_KEY", "Content-Type": "application/json" },
      body: JSON.stringify({ bvn: "22000000001", image_upload: "https://example.com/photo.jpg" }),
    }
  );
  ```

  ```python Python theme={null}
  import requests
  response = requests.post(
      "https://adhere-api.smartcomply.com/api/onboarding/nigeria_kyc/bvn_with_face/",
      headers={"x-access-token": "YOUR_SECRET_KEY", "Content-Type": "application/json"},
      json={"bvn": "22000000001", "image_upload": "https://example.com/photo.jpg"},
  )
  ```
</CodeGroup>

## Response

### 200 OK

| Field                       | Type    | Description                         |
| --------------------------- | ------- | ----------------------------------- |
| `data.firstName`            | string  | First name                          |
| `data.lastName`             | string  | Last name                           |
| `data.dateOfBirth`          | string  | Date of birth                       |
| `data.gender`               | string  | Gender                              |
| `data.bvn`                  | string  | BVN number                          |
| `data.watchListed`          | boolean | `true` if flagged on a watchlist    |
| `data.base64Image`          | string  | Base64-encoded registered photo     |
| `data.face_data.status`     | boolean | `true` if the faces match           |
| `data.face_data.confidence` | number  | Match confidence percentage (0–100) |

```json theme={null}
{
  "status": "success",
  "data": {
    "firstName": "ABRAHAM",
    "lastName": "OMOLE",
    "middleName": "ISAAC",
    "dateOfBirth": "19-Sept-1909",
    "phoneNumber1": "09011001100",
    "email": null,
    "gender": "Male",
    "stateOfOrigin": "Ogun State",
    "bvn": "22200000000",
    "nin": null,
    "registrationDate": "2017-09-05",
    "lgaOfOrigin": "Ado-Odo/Ota",
    "maritalStatus": "Single",
    "watchListed": false,
    "base64Image": "<base64-encoded-jpeg>",
    "face_data": {
      "status": true,
      "response_code": "00",
      "message": "Face Match",
      "confidence": 99.99
    }
  },
  "message": "Bank Verification Number details retrieved successfully"
}
```

### 400 Bad Request

```json theme={null}
{
  "status": "failed",
  "data": [],
  "message": "Sorry, your check cannot be processed at the moment. Please try again in a few minutes"
}
```

### 401 Unauthorized

```json theme={null}
{
  "status": "failed",
  "message": "Authentication credentials were not provided."
}
```


## OpenAPI

````yaml POST /api/onboarding/nigeria_kyc/bvn_with_face/
openapi: 3.0.3
info:
  title: Adhere API
  description: >-
    Identity verification, credit checks, transaction monitoring, and loan fraud
    detection across Africa.
  version: 3.0.0
servers:
  - url: https://adhere-api.smartcomply.com
    description: Production
security:
  - ApiKeyAuth: []
tags:
  - name: Nigeria KYC
  - name: Kenya KYC
  - name: Ghana KYC
  - name: Rwanda KYC
  - name: Uganda KYC
  - name: Biometrics
  - name: Individual Credit
  - name: Business Credit
  - name: Transaction Monitoring
  - name: Transaction Screening
  - name: Transaction KYC
  - name: Loan Fraud
  - name: User Journey
paths:
  /api/onboarding/nigeria_kyc/bvn_with_face/:
    post:
      tags:
        - Nigeria KYC
      summary: BVN with Face
      operationId: bvnWithFace
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - bvn
                - image_url
              properties:
                bvn:
                  type: string
                  description: 11-digit Bank Verification Number
                  example: '22244545518'
                image_url:
                  type: string
                  description: URL of the selfie image
      responses:
        '200':
          description: BVN with face verified
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
components:
  responses:
    BadRequest:
      description: Bad Request
      content:
        application/json:
          schema:
            type: object
            properties:
              status:
                type: string
                example: failed
              data:
                type: array
                items: {}
              message:
                type: string
    Unauthorized:
      description: Unauthorized
      content:
        application/json:
          schema:
            type: object
            properties:
              status:
                type: string
                example: failed
              message:
                type: string
                example: Authentication credentials were not provided.
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-access-token
      description: Your Adhere API secret key

````