> ## 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 BVN Нигерии: проверка номера банковской верификации

> Проверка BVN в Нигерии через Didit: запрос к авторитетной базе данных. Оплата за вызов от $0.35, без контрактов и минимальных объёмов.

Проверяет входные данные по базе данных банковской отрасли Нигерии. Требуется селфи: портрет, зарегистрированный в системе BVN, сверяется с ним по лицу, и запись возвращается только в том случае, если это один и тот же человек. Didit предоставляет этот сервис через `POST /v3/database-validation/`, чтобы вы могли сверить отправленные данные с авторитетным источником и получить нормализованные результаты сопоставления. Формат ввода: `bvn` принимает номер банковской верификации Нигерии (ровно 11 цифр).

## Покрытие

* **Покрытие:** \~ 100%
* **Страна:** Нигерия
* **ID сервиса:** `nga_bank_verification_number`
* **Домен данных:** финансовые данные
* **Категория:** банковские услуги

## Входные данные

| Поле | Обязательное | Пример |
| - | -: | - |
| `bvn` | Да | `11111111111` |
| `selfie` | Да | `@./selfie.jpg` |
| `first_name` | Нет | `John` |
| `last_name` | Нет | `Doe` |
| `date_of_birth` | Нет | `1990-01-01` |
| `vendor_data` | Нет | `user-1234` |

* **Обязательные входные данные:** `bvn`, `selfie`
* **Необязательные входные данные:** `first_name`, `last_name`, `date_of_birth`, `vendor_data`
* **Согласие:** не требуется
* **Доступность в сценарии:** доступно в сценарии с сопоставлением полей
* **Покрытие:** \~ 100%
* **Цена:** \$0.35 за успешный запрос

В сценарии `bvn` не указывается в удостоверении личности, поэтому ни один шаг не получает его самостоятельно. Соберите его из ответа на анкету, поля, извлечённого через Document AI, или значения, которое вы передаёте при создании сессии, и сопоставьте его на шаге «Проверка по базам данных». Пока поле не сопоставлено, редактор сценариев показывает, что этот сервис отключён, и называет недостающий входной параметр. Во время выполнения отсутствие входного параметра означает, что проверка пропускается до любого запроса, поэтому с вас никогда не берут плату за базу данных, которую не удалось запросить.

## Параметры тела запроса

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

Код страны по ISO 3166-1 alpha-3 для этого сервиса базы данных.

Пример: `NGA`

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

Массив, содержащий ID этого сервиса. Указание сервиса ограничивает запрос этой конкретной базой данных.

Пример: `nga_bank_verification_number`

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

Номер банковской верификации (BVN).

Пример: `11111111111`

**selfie** `file` *required*

Файл изображения селфи для загрузки при биометрической проверке по базе данных. Принимаемые форматы: JPEG, PNG или WebP.

Пример: `@./selfie.jpg`

**first\_name** `string`

Имя для проверки.

Пример: `John`

**last\_name** `string`

Фамилия для проверки.

Пример: `Doe`

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

Дата рождения в формате `YYYY-MM-DD`.

Пример: `1990-01-01`

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

Ваш постоянный идентификатор пользователя, например внутренний ID пользователя. Didit использует его, чтобы связать отдельные проверки с одним и тем же конечным пользователем и уменьшить количество ложных срабатываний при поиске дубликатов.

Пример: `user-1234`

## Правила ввода и примечания по валидации

* Номер банковской верификации Нигерии (ровно 11 цифр)
* `bvn` должен содержать только цифры; удалите пробелы, дефисы и знаки препинания перед отправкой запроса.
* Длина `bvn` должна быть ровно 11 символов.

## Как выполнить вызов

```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));
```

Каждый успешный вызов возвращает HTTP `200`. Поле **`outcome_code`** показывает, что произошло на самом деле: например, оно отличает реальное биометрическое несовпадение (`BIOMETRIC_NO_MATCH`) от селфи, которое не удалось прочитать (`BIOMETRIC_IMAGE_UNUSABLE`). Показанный `status`, то есть статус функции по умолчанию, могут переопределить ваши настроенные [действия при частичном совпадении и отсутствии совпадения](https://docs.didit.me/ru/core-technology/database-validation/database-validation-warnings.md).

**`MATCH`**: реестр подтвердил личность, и все проверенные поля совпали.

```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`**: BVN есть в реестре, и селфи совпало с портретом, зарегистрированным в NIBSS, но имя или дата рождения, которые вы отправили, не совпадают с записью реестра. Запись возвращается, чтобы вы могли увидеть, какое поле отличается.

```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`**: оценка совпадения лиц ниже порога принятия, на селфи изображён другой человек, а не тот, что на фотографии в реестре.

```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`**: реестр не может определить, совпадает ли человек с записью. Результат действительно неопределённый: человек может быть в реестре, а может и не быть. Это НЕ отсутствие совпадения и НЕ техническая проблема с изображением. Ни одно поле не подтверждается, поэтому match\_type равен null, а проверка отправляется на ручную проверку.

```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`**: отправленный номер документа не соответствует ни одной записи в реестре.

```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"
      }
    }
  ]
}
```

## Возвращаемые данные

Точный набор полей, возвращаемых в `source_data`, зависит от того, что возвращает реестр. Сгенерированный пример для `nga_bank_verification_number` сейчас описывает такую нормализованную структуру:

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

## Цены и SLA

Запросы номера банковской верификации (BVN) Нигерии тарифицируются только тогда, когда Didit получает окончательный результат от источника проверки.

* **Цена за вызов:** \$0.35 USD.
* **Тарификация:** за каждый успешный запрос. Плата не взимается, если реестр недоступен, если не хватает обязательных полей или если запрос отклонён до того, как он дошёл до источника.
* **Задержка:** типичный p95 \< 2 с.
* **Доступность:** 99.9% за квартал со стороны Didit; доступность источника данных зависит от страны и набора данных.

## Читайте также

* [Обзор проверки по базам данных в Нигерии](https://docs.didit.me/api-reference/database-validation/nigeria.md)
* [Обзор проверки по базам данных](https://docs.didit.me/ru/core-technology/database-validation/overview.md)
* [Коды результатов](https://docs.didit.me/ru/core-technology/database-validation/database-validation-outcome-codes.md)


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