> ## 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 BVN da Nigéria (Bank Verification Number)

> Consulta do Bank Verification Number (BVN) da Nigéria em base oficial via Didit. Pagamento por chamada a partir de $0.35, sem contratos nem mínimos.

Verifica os dados informados na base do setor bancário nigeriano. Exige uma selfie: a foto de cadastro associada ao BVN é comparada facialmente à selfie, e o registro só é retornado quando ambas pertencem à mesma pessoa. A Didit disponibiliza este serviço por meio de `POST /v3/database-validation/`, para que você verifique os dados enviados na fonte oficial e receba resultados de correspondência normalizados.

## Cobertura

* **Cobertura:** \~ 100%
* **País:** Nigéria
* **ID do serviço:** `nga_bank_verification_number`
* **Domínio de dados:** Financeiro
* **Categoria:** Bancário

## Entradas

| Campo | Obrigatório | Exemplo |
| - | -: | - |
| `bvn` | Sim | `11111111111` |
| `selfie` | Sim | `@./selfie.jpg` |
| `first_name` | Não | `John` |
| `last_name` | Não | `Doe` |
| `date_of_birth` | Não | `1990-01-01` |
| `vendor_data` | Não | `user-1234` |

* **Entradas obrigatórias:** `bvn`, `selfie`
* **Entradas opcionais:** `first_name`, `last_name`, `date_of_birth`, `vendor_data`
* **Consentimento:** Não obrigatório
* **Disponibilidade no fluxo:** Disponível no fluxo de verificação (workflow) com mapeamento de campos
* **Cobertura:** \~ 100%
* **Preço:** \$0.35 por consulta bem-sucedida

Em um fluxo, o `bvn` não vem impresso em um documento de identidade, então nenhuma etapa o gera por conta própria. Colete-o a partir de uma resposta a um Questionário, de um campo de extração do Document AI ou de um valor que você envia ao criar a sessão, e mapeie-o na etapa de Validação de banco de dados. Enquanto ele não for mapeado, o editor de fluxos mostra este serviço desativado e indica a entrada que falta; durante a execução, uma entrada ausente faz com que a verificação seja ignorada antes de qualquer consulta, então você nunca é cobrado por uma consulta a uma base de dados que não pôde ser realizada.

## Parâmetros do corpo

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

Código de país ISO 3166-1 alpha-3 deste serviço de banco de dados.

Exemplo: `NGA`

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

Array que contém este ID de serviço. Fixar o serviço mantém a requisição restrita exatamente a esta base de dados.

Exemplo: `nga_bank_verification_number`

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

Bank Verification Number (número de verificação bancária).

Exemplo: `11111111111`

**selfie** `file` *required*

Arquivo de imagem da selfie para enviar para validação em um banco de dados biométricos. Formatos aceitos: JPEG, PNG ou WebP.

Exemplo: `@./selfie.jpg`

**first\_name** `string`

Primeiro nome a validar.

Exemplo: `John`

**last\_name** `string`

Sobrenome a validar.

Exemplo: `Doe`

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

Data de nascimento no formato `YYYY-MM-DD`.

Exemplo: `1990-01-01`

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

Sua referência estável de usuário para esta pessoa, como o seu ID interno de usuário. A Didit a usa para vincular verificações avulsas ao mesmo usuário final e reduzir o ruído na detecção de duplicados.

Exemplo: `user-1234`

## Regras de entrada e notas de validação

* Bank Verification Number nigeriano (exatamente 11 dígitos)
* O `bvn` deve conter apenas dígitos; remova espaços, hifens e pontuação antes de enviar a requisição.
* O `bvn` deve ter exatamente 11 caracteres.

## Como chamar

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

Toda chamada bem-sucedida retorna HTTP `200`. O campo **`outcome_code`** informa o que de fato aconteceu, distinguindo, por exemplo, uma divergência biométrica real (`BIOMETRIC_NO_MATCH`) de uma selfie que não pôde ser lida (`BIOMETRIC_IMAGE_UNUSABLE`). O `status` exibido é o status padrão do recurso; as [ações de Partial Match / No Match](https://docs.didit.me/pt-br/core-technology/database-validation/database-validation-warnings.md) que você configurou podem substituí-lo.

**`MATCH`**: o registro confirmou a identidade e todos os campos verificados corresponderam.

```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`**: o BVN consta no registro e a selfie correspondeu ao retrato de cadastro do NIBSS, mas um nome ou uma data de nascimento que você enviou diverge do registro. O registro é retornado para que você veja qual campo difere.

```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`**: a pontuação de correspondência facial ficou abaixo do limiar de aceitação; a selfie não é da mesma pessoa da foto do registro.

```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`**: o registro não conseguiu determinar se a pessoa corresponde; o resultado é de fato incerto (ela pode ou não constar no registro). Isso NÃO indica ausência de correspondência e NÃO é um problema técnico de imagem; nenhum campo é confirmado, então match\_type é null e a verificação é enviada para revisão.

```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`**: o número de documento enviado não corresponde a nenhum registro na base.

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

## Dados retornados

Os campos exatos expostos em `source_data` dependem do que o cadastro retorna. O exemplo gerado para `nga_bank_verification_number` documenta atualmente este formato normalizado:

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

## Preços e SLAs

As consultas de Bank Verification Number (BVN) da Nigéria são cobradas somente quando a Didit recebe um resultado conclusivo da fonte de validação.

* **Preço por chamada:** \$0.35 USD.
* **Faturamento:** por consulta bem-sucedida. Você não é cobrado quando o registro de empresas está inacessível, quando faltam campos obrigatórios ou quando a requisição é rejeitada antes de chegar à fonte.
* **Latência:** p95 típico \< 2 s.
* **Disponibilidade:** 99.9% por trimestre no lado da Didit; a disponibilidade da fonte externa varia conforme o país e o conjunto de dados.

## Continue a leitura

* [Visão geral da Validação de banco de dados na Nigéria](https://docs.didit.me/api-reference/database-validation/nigeria.md)
* [Visão geral da Validação de banco de dados](https://docs.didit.me/pt-br/core-technology/database-validation/overview.md)
* [Códigos de resultado](https://docs.didit.me/pt-br/core-technology/database-validation/database-validation-outcome-codes.md)


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