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

# Numéro de Vérification Bancaire Avancé (BVN)

> Récupérez un profil BVN vérifié complet incluant les données d'inscription, l'état matrimonial et la photo du client.

L'endpoint BVN Avancé fournit une vue complète de l'identité d'un client. En plus des champs BVN standard, il renvoie les détails d'inscription, le statut de liste de surveillance, l'adresse de résidence et une photo du client encodée en base64.

## Endpoint

```
POST /api/onboarding/nigeria_kyc/bvn_advanced/
```

## Requête

### En-têtes

| En-tête          | Valeur                | Requis |
| ---------------- | --------------------- | ------ |
| `x-access-token` | Votre clé secrète API | Oui    |
| `Content-Type`   | `application/json`    | Oui    |

### Paramètres de corps

| Paramètre       | Type   | Requis | Description                                                |
| --------------- | ------ | ------ | ---------------------------------------------------------- |
| `bvn`           | string | Oui    | Le Numéro de Vérification Bancaire à 11 chiffres du client |
| `date_of_birth` | string | Oui    | La date de naissance du client au format `YYYY-MM-DD`      |

### Exemple

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

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

  ```python Python theme={null}
  import requests

  response = requests.post(
      "https://adhere-api.smartcomply.com/api/onboarding/nigeria_kyc/bvn_advanced/",
      headers={
          "x-access-token": "YOUR_SECRET_KEY",
          "Content-Type": "application/json",
      },
      json={"bvn": "22000000001", "date_of_birth": "1990-01-15"},
  )
  data = response.json()
  ```
</CodeGroup>

## Réponse

### 200 OK

| Champ                     | Type   | Description                                             |
| ------------------------- | ------ | ------------------------------------------------------- |
| `data.bvn`                | string | Le BVN qui a été interrogé                              |
| `data.image`              | string | Photo JPEG du client encodée en base64                  |
| `data.title`              | string | Titre honorifique (par ex. `"Mr"`, `"Mrs"`)             |
| `data.gender`             | string | `"male"` ou `"female"`                                  |
| `data.lastName`           | string | Nom de famille du client                                |
| `data.firstName`          | string | Prénom du client                                        |
| `data.middleName`         | string | Deuxième prénom du client                               |
| `data.dateOfBirth`        | string | Date de naissance au format `YYYY-MM-DD`                |
| `data.phoneNumber1`       | string | Numéro de téléphone principal enregistré                |
| `data.phoneNumber2`       | string | Numéro de téléphone secondaire (si disponible)          |
| `data.maritalStatus`      | string | Par ex. `"Single"`, `"Married"`                         |
| `data.lgaOfOrigin`        | string | Zone de gouvernement local d'origine                    |
| `data.stateOfOrigin`      | string | État d'origine                                          |
| `data.stateOfResidence`   | string | État de résidence actuel                                |
| `data.lgaOfResidence`     | string | Zone de gouvernement local de résidence (si disponible) |
| `data.residentialAddress` | string | Adresse de résidence (si disponible)                    |
| `data.enrollmentBank`     | string | Code bancaire où le BVN a été inscrit                   |
| `data.enrollmentBranch`   | string | Agence où le BVN a été inscrit                          |
| `data.registrationDate`   | string | Date d'enregistrement du BVN                            |
| `data.levelOfAccount`     | string | Niveau de compte CBN                                    |
| `data.watchListed`        | string | `"YES"` si sur une liste de surveillance, sinon `"NO"`  |

```json theme={null}
{
  "status": "success",
  "data": {
    "bvn": "22000000001",
    "image": "<base64-encoded-jpeg>",
    "title": "Mr",
    "gender": "male",
    "lastName": "OMOLE",
    "firstName": "ABRAHAM",
    "middleName": "ISAAC",
    "nameOnCard": "",
    "dateOfBirth": "1909-09-19",
    "lgaOfOrigin": "Ado-Odo/Ota",
    "watchListed": "NO",
    "phoneNumber1": "09011001100",
    "phoneNumber2": "",
    "maritalStatus": "Single",
    "stateOfOrigin": "Ogun State",
    "enrollmentBank": "033",
    "levelOfAccount": "Level 1 - Low Level Accounts",
    "lgaOfResidence": "",
    "enrollmentBranch": "0517-OTA 2",
    "registrationDate": "2017-09-05",
    "stateOfResidence": "Ogun State",
    "residentialAddress": ""
  },
  "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_advanced/
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: Document Verification
  - 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_advanced/:
    post:
      tags:
        - Nigeria KYC
      summary: BVN Advanced
      operationId: bvnAdvanced
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - bvn
              properties:
                bvn:
                  type: string
                  description: 11-digit Bank Verification Number
                  example: '22244545518'
                date_of_birth:
                  type: string
                  description: >-
                    Date of birth in YYYY-MM-DD format (optional, used for
                    additional verification)
                  example: '1990-01-15'
      responses:
        '200':
          description: BVN advanced data retrieved
        '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

````