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

# ナイジェリア銀行認証番号（BVN）照合API

> Diditでナイジェリアの銀行認証番号（BVN）を公的データベースと照合。1回あたり$0.35からの従量課金で、契約も最低利用額も不要です。

入力データをナイジェリアの銀行業界データベースと照合して検証します。セルフィーが必須です。BVNに登録されている登録時の顔写真とセルフィーを顔照合し、両者が同一人物である場合にのみレコードが返されます。Diditはこのサービスを`POST /v3/database-validation/`で提供しているため、送信されたデータを公式の情報源と照合し、正規化された照合結果を受け取ることができます。

## カバレッジ

* **カバレッジ：** 約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%
* **料金：** 成功したクエリ1件あたり\$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)

銀行認証番号（Bank Verification Number）。

例：`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/ja/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が検証元から確定的な結果を受け取った場合にのみ請求されます。

* **呼び出し1件あたりの料金：** \$0.35 USD。
* **請求：** 成功したクエリ1件ごと。登録機関に接続できない場合、必須フィールドが不足している場合、またはリクエストが検証元に到達する前に拒否された場合は課金されません。
* **レイテンシ：** 通常、p95は2秒未満です。
* **可用性：** Didit側で四半期あたり99.9%。外部の検証元の可用性は国やデータセットによって異なります。

## 関連情報

* [ナイジェリアのデータベース検証の概要](https://docs.didit.me/api-reference/database-validation/nigeria.md)
* [データベース検証の概要](https://docs.didit.me/ja/core-technology/database-validation/overview.md)
* [結果コード](https://docs.didit.me/ja/core-technology/database-validation/database-validation-outcome-codes.md)


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