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

# Verificação de ID Nacional da Nigéria + Selfie (NIMC) API

> Verifique o ID nacional da Nigéria + selfie (NIMC) via Didit, com consulta à base oficial. A partir de $0.35 por chamada, sem contratos nem mínimos.

Verifica um Número de Identificação Nacional (NIN) nigeriano no registo da National Identity Management Commission. Requer uma selfie: a fotografia de inscrição associada ao NIN é comparada com a selfie através de correspondência facial, e o registo só é devolvido quando ambas representam a mesma pessoa. A Didit disponibiliza este serviço através de `POST /v3/database-validation/` para que possa verificar os dados submetidos contra a fonte oficial e receber resultados de correspondência normalizados.

## Cobertura

* **Cobertura:** \~ 100%
* **País:** Nigéria
* **ID do serviço:** `nga_national_id_facial`
* **Domínio de dados:** Identidade
* **Categoria:** NationalIDRegistry

## Entradas

| Campo | Obrigatório | Exemplo |
| - | -: | - |
| `national_id` | 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:** `national_id`, `selfie`
* **Entradas opcionais:** `first_name`, `last_name`, `date_of_birth`, `vendor_data`
* **Consentimento:** Não obrigatório
* **Disponibilidade no fluxo:** Disponível no fluxo
* **Cobertura:** \~ 100%
* **Preço:** \$0.35 por consulta bem-sucedida

Nem todos os documentos aceites por este serviço incluem o identificador pelo qual é feita a consulta. Quando o identificador não é extraído do documento, a verificação é registada como **não aplicável** - nenhuma base de dados é consultada e não lhe é cobrado nada - o que, em alguns países, representa uma grande parte dos utilizadores reais. Para os cobrir, recolha também o identificador a partir de uma resposta a um questionário, de um campo de extração do Document AI ou de um valor que envie ao criar a sessão, e mapeie-o no passo de Validação de base de dados.

## Parâmetros do corpo

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

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

Exemplo: `NGA`

**services** `string` *required* (default: nga\_national\_id\_facial)

Matriz que contém o ID deste serviço. Fixar o serviço mantém o pedido restrito a esta base de dados exata.

Exemplo: `nga_national_id_facial`

**national\_id** `string` *required* (default: 11111111111)

Número de identificação nacional deste serviço.

Exemplo: `11111111111`

**selfie** `file` *required*

Ficheiro de imagem da selfie a carregar para a validação biométrica da base de dados. Formatos aceites: JPEG, PNG ou WebP.

Exemplo: `@./selfie.jpg`

**first\_name** `string`

Nome próprio a validar.

Exemplo: `John`

**last\_name** `string`

Apelido a validar.

Exemplo: `Doe`

**date\_of\_birth** `string`

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

Exemplo: `1990-01-01`

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

A sua referência estável de utilizador para esta pessoa, como o ID interno do utilizador. A Didit usa-a para ligar verificações autónomas ao mesmo utilizador final e reduzir o ruído na deteção de duplicados.

Exemplo: `user-1234`

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

* `first_name` tem de corresponder a `[A-Za-zÀ-ÖØ-öø-ÿ .'-]+`.
* `national_id` deve conter apenas dígitos; remova espaços, hífenes e sinais de pontuação antes de enviar o pedido.
* `national_id` tem de ter exatamente 11 caracteres.

## Como fazer a chamada

```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_national_id_facial" \
  -F "vendor_data=user-1234" \
  -F "national_id=11111111111" \
  -F "selfie=@./selfie.jpg"
```

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

# Reads DIDIT_API_KEY.
client = Didit()

result = client.database_validation.validate(
    issuing_state="NGA",
    services=["nga_national_id_facial"],
    national_id="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_national_id_facial"],
  national_id: "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_national_id_facial"}),
	NationalID:   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.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_national_id_facial"))
        .nationalId("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_national_id_facial'],
    'national_id' => '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_national_id_facial"],
  national_id: "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_national_id_facial" },
    NationalId = "11111111111",
    VendorData = "user-1234",
    Selfie = FileUpload.FromPath("selfie.jpg"),
});
Console.WriteLine(JsonSerializer.Serialize(result));
```

Cada chamada bem-sucedida devolve HTTP `200`. O campo **`outcome_code`** indica o que realmente aconteceu, distinguindo, por exemplo, uma verdadeira falta de correspondência biométrica (`BIOMETRIC_NO_MATCH`) de uma selfie que não pôde ser lida (`BIOMETRIC_IMAGE_UNUSABLE`). O `status` apresentado é o estado predefinido da funcionalidade; as suas [ações configuradas para Correspondência parcial / Sem correspondência](https://docs.didit.me/pt/core-technology/database-validation/database-validation-warnings.md) podem substituí-lo.

**`MATCH`** — O registo confirmou a identidade e todos os campos verificados correspondem.

```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_national_id_facial",
      "service_name": "Nigeria National ID + Selfie (NIMC)",
      "source_data": {
        "address": "1 SAMPLE STREET",
        "birth_country": "nigeria",
        "birth_lga": "Ikeja",
        "birth_state": "Lagos",
        "date_of_birth": "1990-01-01",
        "face_match_score": 92.4,
        "first_name": "JOHN",
        "gender": "Male",
        "identification_number": "11111111111",
        "last_name": "DOE",
        "marital_status": "single",
        "middle_name": "SAMUEL",
        "phone_number": "08000000000",
        "photo_available": true,
        "residence_lga": "Ikeja",
        "residence_state": "Lagos",
        "residence_town": "IKEJA"
      },
      "validation": {
        "date_of_birth": "full_match",
        "full_name": "full_match",
        "identification_number": "full_match"
      }
    }
  ]
}
```

**`PARTIAL_MATCH`** — A selfie corresponde à fotografia registada e o NIN consta do registo, mas um nome ou uma data de nascimento que enviou difere do registo da NIMC. O registo é devolvido para que veja qual o campo que 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_national_id_facial",
      "service_name": "Nigeria National ID + Selfie (NIMC)",
      "source_data": {
        "address": "1 SAMPLE STREET",
        "birth_country": "nigeria",
        "birth_lga": "Ikeja",
        "birth_state": "Lagos",
        "date_of_birth": "1990-02-01",
        "face_match_score": 92.4,
        "first_name": "JOHN",
        "gender": "Male",
        "identification_number": "11111111111",
        "last_name": "DOE",
        "marital_status": "single",
        "middle_name": "SAMUEL",
        "phone_number": "08000000000",
        "photo_available": true,
        "residence_lga": "Ikeja",
        "residence_state": "Lagos",
        "residence_town": "IKEJA"
      },
      "validation": {
        "date_of_birth": "no_match",
        "full_name": "full_match",
        "identification_number": "full_match"
      }
    }
  ]
}
```

**`BIOMETRIC_NO_MATCH`** — O NIN consta do registo, mas a selfie não é da mesma pessoa que a fotografia de inscrição da NIMC (pontuação de correspondência facial abaixo do limiar de aceitação). Nada do registo é devolvido, apenas a pontuação.

```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_national_id_facial",
      "service_name": "Nigeria National ID + Selfie (NIMC)",
      "source_data": {
        "face_match_score": 12.5,
        "identification_number": "NO_MATCH"
      },
      "validation": {
        "identification_number": "no_match"
      }
    }
  ]
}
```

**`INCONCLUSIVE`** — O NIN consta do registo, mas não foi possível fazer a correspondência facial: não existe fotografia de inscrição arquivada ou não foi detetada nenhuma face. Nada do registo é devolvido, `match_type` é nulo 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_national_id_facial",
      "service_name": "Nigeria National ID + Selfie (NIMC)",
      "source_data": {},
      "validation": {}
    }
  ]
}
```

**`DOCUMENT_NOT_FOUND`** — O NIN está bem formado, mas o registo da NIMC não contém qualquer registo correspondente. A consulta é cobrada.

```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_national_id_facial",
      "service_name": "Nigeria National ID + Selfie (NIMC)",
      "source_data": {
        "identification_number": "NO_MATCH"
      },
      "validation": {
        "identification_number": "no_match"
      }
    }
  ]
}
```

## Dados devolvidos

Os campos exatos apresentados em `source_data` dependem do que o registo devolve. O exemplo gerado para `nga_national_id_facial` documenta atualmente esta estrutura normalizada:

* `address`
* `birth_country`
* `birth_lga`
* `birth_state`
* `date_of_birth`
* `face_match_score`
* `first_name`
* `gender`
* `identification_number`
* `last_name`
* `marital_status`
* `middle_name`
* `phone_number`
* `photo_available`
* `residence_lga`
* `residence_state`
* `residence_town`

## Preços e SLAs

As consultas Nigeria National ID + Selfie (NIMC) só são faturadas quando a Didit recebe um resultado conclusivo da fonte de validação.

* **Preço por chamada:** \$0.35 USD.
* **Faturação:** por consulta bem-sucedida. Não lhe é cobrado quando o registo está inacessível, quando faltam campos obrigatórios ou quando o pedido é rejeitado antes de chegar à fonte.
* **Latência:** p95 típico \< 2 s.
* **Disponibilidade:** 99.9% por trimestre, do lado da Didit; a disponibilidade da fonte a jusante varia consoante o país e o conjunto de dados.

## Selfie e correspondência facial

Ao receber um NIN válido, o registo do NIMC devolve o registo completo do titular, pelo que conhecer um número não prova que se é o seu titular. Por isso, cada consulta está associada a uma selfie: é feita a correspondência facial desta com a fotografia de inscrição que o NIMC detém para esse NIN, e o registo só é devolvido quando ambas correspondem à mesma pessoa.

* **Correspondência:** `source_data` contém o registo do NIMC e `face_match_score`. Os nomes e a data de nascimento que enviar são comparados com esse registo e reportados em `validation`; envie-os para obter um veredicto sobre o nome e a data de nascimento, ou omita-os e leia os valores do registo a partir de `source_data`.
* **Pessoa diferente:** `BIOMETRIC_NO_MATCH`. Só `face_match_score` é devolvido, sem dados pessoais.
* **Correspondência impossível:** `INCONCLUSIVE` quando o NIMC não tem fotografia para o NIN ou quando não é possível encontrar nenhum rosto. Nada é devolvido e a verificação é enviada para revisão.
* **NIN desconhecido:** `DOCUMENT_NOT_FOUND`. A consulta é cobrada.

Num fluxo, a selfie é obtida a partir do passo de prova de vida ou do passo de correspondência facial, ou a partir do retrato no documento carregado quando o fluxo não tem um passo facial. Um pedido sem selfie, ou com um NIN que não tenha 11 dígitos, é rejeitado antes de qualquer cobrança.

## Continuar a ler

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


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