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

# API de vérification du numéro BVN du Nigeria

> Numéro BVN du Nigeria : consultation dans la base de données officielle du Nigeria via Didit. Paiement à l'appel dès $0.35, sans contrat ni minimum.

Vérifie les données saisies auprès de la base de données du secteur bancaire nigérian. Nécessite un selfie : le portrait d'enrôlement associé au BVN est comparé par correspondance faciale à ce selfie, et l'enregistrement n'est renvoyé que lorsqu'elles représentent la même personne. Didit expose ce service via `POST /v3/database-validation/` afin que vous puissiez vérifier les données soumises auprès de la source faisant autorité et recevoir des résultats de correspondance normalisés. Format de saisie : `bvn` correspond au numéro de vérification bancaire nigérian (exactement 11 chiffres).

## Couverture

* **Couverture :** \~ 100%
* **Pays :** Nigeria
* **ID du service :** `nga_bank_verification_number`
* **Domaine de données :** Financier
* **Catégorie :** Banque

## Entrées

| Champ | Requis | Exemple |
| - | -: | - |
| `bvn` | Oui | `11111111111` |
| `selfie` | Oui | `@./selfie.jpg` |
| `first_name` | Non | `John` |
| `last_name` | Non | `Doe` |
| `date_of_birth` | Non | `1990-01-01` |
| `vendor_data` | Non | `user-1234` |

* **Entrées requises :** `bvn`, `selfie`
* **Entrées facultatives :** `first_name`, `last_name`, `date_of_birth`, `vendor_data`
* **Consentement :** Non requis
* **Disponibilité dans un workflow :** Disponible dans un workflow avec mappage des champs
* **Couverture :** \~ 100%
* **Prix :** \$0.35 par requête réussie

Dans un workflow, `bvn` n'est pas imprimé sur un document d'identité, donc aucune étape ne le produit seule. Collectez-le à partir d'une réponse de questionnaire, d'un champ d'extraction Document AI, ou d'une valeur que vous envoyez lors de la création de la session, puis mappez-le sur l'étape Validation en base de données. Tant qu'il n'est pas mappé, l'éditeur de workflow affiche ce service comme désactivé et indique l'entrée manquante ; au moment de l'exécution, une entrée manquante signifie que la vérification est ignorée avant toute requête, de sorte que vous n'êtes jamais facturé pour une base de données qui n'a pas pu être interrogée.

## Paramètres du corps

**issuing\_state** `string` *required* (default: NGA)

Code pays ISO 3166-1 alpha-3 de ce service de base de données.

Exemple : `NGA`

**services** `string` *required* (default: nga\_bank\_verification\_number)

Tableau contenant l'ID de ce service. Épingler le service limite la requête à cette base de données exacte.

Exemple : `nga_bank_verification_number`

**bvn** `string` *required* (default: 11111111111)

Numéro de vérification bancaire.

Exemple : `11111111111`

**selfie** `file` *required*

Fichier image du selfie à téléverser pour la validation biométrique auprès de la base de données. Formats acceptés : JPEG, PNG ou WebP.

Exemple : `@./selfie.jpg`

**first\_name** `string`

Prénom à valider.

Exemple : `John`

**last\_name** `string`

Nom de famille à valider.

Exemple : `Doe`

**date\_of\_birth** `string` (default: 1990-01-01)

Date de naissance au format `YYYY-MM-DD`.

Exemple : `1990-01-01`

**vendor\_data** `string` (default: user-1234)

Votre référence utilisateur stable pour cette personne, par exemple votre identifiant interne. Didit l'utilise pour relier les vérifications autonomes au même utilisateur final et réduire le bruit de détection des doublons.

Exemple : `user-1234`

## Règles de saisie et notes de validation

* Numéro de vérification bancaire nigérian (exactement 11 chiffres)
* `bvn` ne doit contenir que des chiffres ; supprimez les espaces, les tirets et la ponctuation avant d'envoyer la requête.
* `bvn` doit comporter exactement 11 caractères.

## Comment l'appeler

```bash cURL theme={null}
curl -X POST "https://verification.didit.me/v3/database-validation/" \
  -H "x-api-key: YOUR_API_KEY" \
  -F "issuing_state=NGA" \
  -F "services=nga_bank_verification_number" \
  -F "vendor_data=user-1234" \
  -F "bvn=11111111111" \
  -F "selfie=@./selfie.jpg" \
  -F "date_of_birth=1990-01-01"
```

```python Python theme={null}
from didit import Didit

# Reads DIDIT_API_KEY.
client = Didit()

result = client.database_validation.validate(
    issuing_state="NGA",
    services=["nga_bank_verification_number"],
    date_of_birth="1990-01-01",
    bvn="11111111111",
    vendor_data="user-1234",
    selfie=open("selfie.jpg", "rb"),
)
print(result)
```

```javascript Node.js theme={null}
import Didit, { fileFromPath } from "@didit-protocol/sdk-node";

// Reads DIDIT_API_KEY.
const didit = new Didit();

const result = await didit.databaseValidation.validate({
  issuing_state: "NGA",
  services: ["nga_bank_verification_number"],
  date_of_birth: "1990-01-01",
  bvn: "11111111111",
  vendor_data: "user-1234",
  selfie: await fileFromPath("selfie.jpg"),
});
console.log(result);
```

```go Go theme={null}
ctx := context.Background()
// Reads DIDIT_API_KEY.
client := didit.NewClient()

result, err := client.DatabaseValidation.Validate(ctx, didit.DatabaseValidationValidateParams{
	IssuingState: "NGA",
	Services:     didit.Some([]string{"nga_bank_verification_number"}),
	DateOfBirth:  didit.String("1990-01-01"),
	Bvn:          didit.String("11111111111"),
	VendorData:   didit.String("user-1234"),
	Selfie:       didit.Some(didit.FileFromPath("selfie.jpg")),
})
if err != nil {
	log.Fatal(err)
}
fmt.Printf("%+v\n", result)
```

```java Java theme={null}
import java.nio.file.Path;
import java.time.LocalDate;
import java.util.List;
import me.didit.Didit;
import me.didit.types.DatabaseValidationValidateParams;

// Reads DIDIT_API_KEY.
Didit client = new Didit();

var result = client.databaseValidation().validate(DatabaseValidationValidateParams.builder()
        .issuingState("NGA")
        .services(List.of("nga_bank_verification_number"))
        .dateOfBirth(LocalDate.parse("1990-01-01"))
        .bvn("11111111111")
        .vendorData("user-1234")
        .selfie(Path.of("selfie.jpg"))
        .build());
System.out.println(result);
```

```php PHP theme={null}
<?php

require 'vendor/autoload.php';

use Didit\DiditClient;
use Didit\File;

// Reads DIDIT_API_KEY.
$didit = new DiditClient();

$result = $didit->databaseValidation->validate([
    'issuing_state' => 'NGA',
    'services' => ['nga_bank_verification_number'],
    'date_of_birth' => '1990-01-01',
    'bvn' => '11111111111',
    'vendor_data' => 'user-1234',
    'selfie' => File::fromPath('selfie.jpg'),
]);
print_r($result->toArray());
```

```ruby Ruby theme={null}
require "didit"

# Reads DIDIT_API_KEY.
didit = Didit::Client.new

result = didit.database_validation.validate(
  issuing_state: "NGA",
  services: ["nga_bank_verification_number"],
  date_of_birth: "1990-01-01",
  bvn: "11111111111",
  vendor_data: "user-1234",
  selfie: Pathname("selfie.jpg")
)
puts result.to_h
```

```csharp .NET theme={null}
using System;
using System.Text.Json;
using Didit;

// Reads DIDIT_API_KEY.
using var client = new DiditClient();

var result = await client.DatabaseValidation.ValidateAsync(new DatabaseValidationValidateParams
{
    IssuingState = "NGA",
    Services = new string[] { "nga_bank_verification_number" },
    DateOfBirth = "1990-01-01",
    Bvn = "11111111111",
    VendorData = "user-1234",
    Selfie = FileUpload.FromPath("selfie.jpg"),
});
Console.WriteLine(JsonSerializer.Serialize(result));
```

Chaque appel réussi renvoie HTTP `200`. Le champ **`outcome_code`** indique ce qui s'est réellement passé, en distinguant par exemple une véritable absence de correspondance biométrique (`BIOMETRIC_NO_MATCH`) d'un selfie qui n'a pas pu être lu (`BIOMETRIC_IMAGE_UNUSABLE`). Le `status` affiché est le statut par défaut de la fonctionnalité ; vos [actions configurées pour Correspondance partielle / Absence de correspondance](https://docs.didit.me/fr/core-technology/database-validation/database-validation-warnings.md) peuvent le remplacer.

**`MATCH`** — Le registre a confirmé l'identité, et chaque champ vérifié correspond.

```json 200 OK — MATCH theme={null}
{
  "request_id": "req_01H…",
  "status": "Approved",
  "issuing_state": "NGA",
  "match_type": "full_match",
  "validations": [
    {
      "outcome_code": "MATCH",
      "service_id": "nga_bank_verification_number",
      "service_name": "Nigeria Bank Verification Number (BVN)",
      "source_data": {
        "date_of_birth": "1990-01-01",
        "first_name": "John",
        "last_name": "Doe"
      },
      "validation": {
        "identification_number": "full_match"
      }
    }
  ]
}
```

**`PARTIAL_MATCH`** — Le BVN figure dans le registre et le selfie correspond au portrait d'enrôlement NIBSS, mais un nom ou une date de naissance que vous avez envoyé ne correspond pas à l'enregistrement du registre. L'enregistrement est renvoyé afin que vous puissiez voir quel champ diffère.

```json 200 OK — PARTIAL_MATCH theme={null}
{
  "request_id": "req_01H…",
  "status": "In Review",
  "issuing_state": "NGA",
  "match_type": "partial_match",
  "validations": [
    {
      "outcome_code": "PARTIAL_MATCH",
      "service_id": "nga_bank_verification_number",
      "service_name": "Nigeria Bank Verification Number (BVN)",
      "source_data": {
        "date_of_birth": "1990-01-01",
        "first_name": "John",
        "last_name": "Doe"
      },
      "validation": {
        "date_of_birth": "no_match",
        "identification_number": "full_match"
      }
    }
  ]
}
```

**`BIOMETRIC_NO_MATCH`** — Le score de correspondance faciale est inférieur au seuil d'acceptation : le selfie ne représente pas la même personne que la photo du registre.

```json 200 OK — BIOMETRIC_NO_MATCH theme={null}
{
  "request_id": "req_01H…",
  "status": "Declined",
  "issuing_state": "NGA",
  "match_type": "no_match",
  "validations": [
    {
      "outcome_code": "BIOMETRIC_NO_MATCH",
      "service_id": "nga_bank_verification_number",
      "service_name": "Nigeria Bank Verification Number (BVN)",
      "source_data": {
        "identification_number": "NO_MATCH"
      },
      "validation": {
        "identification_number": "no_match"
      }
    }
  ]
}
```

**`INCONCLUSIVE`** — Le registre n'a pas pu déterminer si la personne correspond : le résultat est réellement incertain (elle figure peut-être ou non dans le registre). Ce n'est ni une absence de correspondance, ni un problème technique lié à l'image ; aucun champ n'est déclaré comme correspondant, donc match\_type vaut null et la vérification est envoyée en examen manuel.

```json 200 OK — INCONCLUSIVE theme={null}
{
  "request_id": "req_01H…",
  "status": "In Review",
  "issuing_state": "NGA",
  "match_type": null,
  "validations": [
    {
      "outcome_code": "INCONCLUSIVE",
      "service_id": "nga_bank_verification_number",
      "service_name": "Nigeria Bank Verification Number (BVN)",
      "source_data": {},
      "validation": {}
    }
  ]
}
```

**`DOCUMENT_NOT_FOUND`** — Le numéro de document soumis ne correspond à aucun enregistrement du registre.

```json 200 OK — DOCUMENT_NOT_FOUND theme={null}
{
  "request_id": "req_01H…",
  "status": "Declined",
  "issuing_state": "NGA",
  "match_type": "no_match",
  "validations": [
    {
      "outcome_code": "DOCUMENT_NOT_FOUND",
      "service_id": "nga_bank_verification_number",
      "service_name": "Nigeria Bank Verification Number (BVN)",
      "source_data": {
        "identification_number": "NO_MATCH"
      },
      "validation": {
        "identification_number": "no_match"
      }
    }
  ]
}
```

## Données renvoyées

Les champs exacts restitués dans `source_data` dépendent de ce que renvoie le registre. L'exemple généré pour `nga_bank_verification_number` documente actuellement cette structure normalisée :

* `date_of_birth`
* `first_name`
* `last_name`

## Tarifs et SLA

Les requêtes de vérification du numéro de vérification bancaire (BVN) nigérian ne sont facturées que lorsque Didit reçoit un résultat concluant de la source de validation.

* **Prix par appel :** \$0.35 USD.
* **Facturation :** par requête réussie. Vous n'êtes pas facturé lorsque le registre est injoignable, lorsque des champs requis manquent ou lorsque la requête est rejetée avant d'atteindre la source.
* **Latence :** p95 typique \< 2 s.
* **Disponibilité :** 99.9% par trimestre côté Didit ; la disponibilité de la source en aval varie selon le pays et le jeu de données.

## Pour aller plus loin

* [Vue d'ensemble de la validation en base de données au Nigeria](https://docs.didit.me/api-reference/database-validation/nigeria.md)
* [Vue d'ensemble de la validation en base de données](https://docs.didit.me/fr/core-technology/database-validation/overview.md)
* [Codes de résultat](https://docs.didit.me/fr/core-technology/database-validation/database-validation-outcome-codes.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.