> For the complete documentation index, see [llms.txt](https://docs.facephi.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.facephi.com/docs.facephi-pt-br/api-rest/identity-api/identity-api-reference/onboarding/kyc/nigeria/identity-verification/nin-verify.md).

# Verificar NIN

Verifique o **Número de Identificação Nacional** (NIN) da Nigéria e retorna as informações do titular, incluindo dados **biométricos e demográficos**.

### Endpoint

```
POST /kyc/nga/nin
```

### Autenticação

| Tipo    | Localização | Nome          |
| ------- | ----------- | ------------- |
| API Key | Cabeçalho   | **x-api-key** |

### Corpo da solicitação

**Content-Type:** `application/json`

#### Parâmetros

| Parâmetro | Tipo   | Obrigatório | Descrição                                           |
| --------- | ------ | ----------- | --------------------------------------------------- |
| `nin`     | string | **Sim**     | Número de Identificação Nacional de **11 dígitos**. |

#### Exemplo de solicitação

```json
{
  "nin": "12345678901"
}
```

### Respostas

#### `200` Sucesso

#### Parâmetros de resposta

| Parâmetro              | Tipo    | Descrição                                                                                                       |
| ---------------------- | ------- | --------------------------------------------------------------------------------------------------------------- |
| `serviceResultCode`    | integer | Código que indica o **resultado geral** da execução do serviço. Ver [Service Result Code](#service-result-code) |
| `serviceTime`          | string  | Tempo de processamento **(milissegundos)**.                                                                     |
| `serviceResultLog`     | string  | Campo descritivo do resultado da execução do serviço. Inclui detalhes quando há um erro ou exceção no módulo.   |
| `serviceTransactionId` | string  | Identificador de transação associado à solicitação processada pela API.                                         |
| `data`                 | object  | Objeto com os dados completos do NIN. Veja a tabela abaixo.                                                     |

#### Parâmetros de resposta — `data`

Os campos de `data` são retornados **tal como são entregues pelo registro nacional** (nomes em minúsculas, sem normalizar). Os campos sem dado são retornados como string vazia (`""`).

| Parâmetro           | Tipo   | Descrição                                                                       |
| ------------------- | ------ | ------------------------------------------------------------------------------- |
| `nin`               | string | Número de Identificação Nacional.                                               |
| `firstname`         | string | Nome(s) do titular.                                                             |
| `middlename`        | string | Segundo nome.                                                                   |
| `surname`           | string | Sobrenome(s) do titular.                                                        |
| `title`             | string | Título pessoal (por ex. `mr`, `mrs`).                                           |
| `gender`            | string | Gênero. Valores possíveis: `m`, `f`                                             |
| `birthdate`         | string | Data de nascimento (formato `DD-MM-YYYY`).                                      |
| `birthcountry`      | string | País de nascimento.                                                             |
| `birthstate`        | string | Estado de nascimento.                                                           |
| `birthlga`          | string | Área de Governo Local (LGA) de nascimento.                                      |
| `maritalstatus`     | string | Estado civil.                                                                   |
| `educationallevel`  | string | Nível educacional.                                                              |
| `employmentstatus`  | string | Situação profissional.                                                          |
| `profession`        | string | Profissão.                                                                      |
| `religion`          | string | Religião.                                                                       |
| `heigth`            | string | Altura em centímetros. (sic — nome do campo exatamente como é recebido).        |
| `email`             | string | E-mail.                                                                         |
| `telephoneno`       | string | Número de telefone.                                                             |
| `residence_address` | string | Endereço de residência.                                                         |
| `residence_town`    | string | Localidade de residência.                                                       |
| `residence_lga`     | string | Área de Governo Local (LGA) de residência.                                      |
| `residence_state`   | string | Estado de residência.                                                           |
| `residencestatus`   | string | Situação de residência (por ex. `birth`).                                       |
| `self_origin_place` | string | Local de origem.                                                                |
| `self_origin_lga`   | string | Área de Governo Local (LGA) de origem.                                          |
| `self_origin_state` | string | Estado de origem.                                                               |
| `spoken_language`   | string | Idioma principal.                                                               |
| `ospokenlang`       | string | Outros idiomas falados.                                                         |
| `nok_firstname`     | string | Nome do parente de contato (next of kin).                                       |
| `nok_middlename`    | string | Segundo nome do parente de contato.                                             |
| `nok_surname`       | string | Sobrenome do parente de contato.                                                |
| `nok_address1`      | string | Endereço (linha 1) do parente de contato.                                       |
| `nok_address2`      | string | Endereço (linha 2) do parente de contato.                                       |
| `nok_town`          | string | Localidade do parente de contato.                                               |
| `nok_lga`           | string | Área de Governo Local (LGA) do parente de contato.                              |
| `nok_state`         | string | Estado do parente de contato.                                                   |
| `nok_postalcode`    | string | Código postal do parente de contato.                                            |
| `pfirstname`        | string | Nome anterior do titular (se existir; normalmente vazio).                       |
| `pmiddlename`       | string | Segundo nome anterior do titular (se existir; normalmente vazio).               |
| `psurname`          | string | Sobrenome anterior do titular (se existir; normalmente vazio).                  |
| `vnin`              | string | NIN virtual (vNIN), se um foi usado na consulta.                                |
| `userid`            | string | Identificador de usuário no registro (normalmente vazio).                       |
| `central_iD`        | string | Identificador central do registro. (sic — casing do campo tal como é recebido). |
| `tracking_id`       | string | Identificador de rastreamento da solicitação no registro.                       |
| `photo`             | string | Foto do titular em formato **Base64**.                                          |
| `signature`         | string | Assinatura do titular em formato **Base64**.                                    |

#### Service Result Code

O `serviceResultCode` indica o resultado geral da execução do serviço:

| serviceResultCode | Descrição                                                                              | Código HTTP |
| ----------------- | -------------------------------------------------------------------------------------- | ----------- |
| 200               | A execução do serviço foi bem-sucedida, o módulo processou a solicitação corretamente. | 200         |

#### Exemplo de resposta

```json
{
  "serviceResultCode": 200,
  "serviceTime": "2000",
  "serviceResultLog": "Success",
  "serviceTransactionId": "a07d891e-90e8-7d9h-d42d-8e2478df88fg",
  "data": {
    "nin": "12345678901",
    "firstname": "JOHN",
    "middlename": "PAUL",
    "surname": "DOE",
    "title": "mr",
    "gender": "m",
    "birthdate": "15-01-1990",
    "birthcountry": "nigeria",
    "birthstate": "Lagos",
    "birthlga": "Lagos Mainland",
    "maritalstatus": "single",
    "educationallevel": "tertiary",
    "employmentstatus": "employed",
    "profession": "ENGINEER",
    "religion": "christianity",
    "heigth": "175",
    "email": "",
    "telephoneno": "08012345678",
    "residence_address": "2A MUSA ADE STREET",
    "residence_town": "OGBA",
    "residence_lga": "Ogba",
    "residence_state": "Lagos",
    "residencestatus": "birth",
    "self_origin_place": "",
    "self_origin_lga": "",
    "self_origin_state": "",
    "spoken_language": "YORUBA",
    "ospokenlang": "",
    "nok_firstname": "AISHA",
    "nok_middlename": "",
    "nok_surname": "AGBA",
    "nok_address1": "3B MICHAEL WISDOM STREET",
    "nok_address2": "",
    "nok_town": "FESTAC",
    "nok_lga": "Lagos Island",
    "nok_state": "Lagos",
    "nok_postalcode": "",
    "pfirstname": "",
    "pmiddlename": "",
    "psurname": "",
    "vnin": "",
    "userid": "",
    "central_iD": "123456",
    "tracking_id": "ABC0DEFG5000XYZ",
    "photo": "base64encodedphoto...",
    "signature": "base64encodedsignature..."
  }
}
```

#### `400` Bad Request

Erro retornado com o envelope do serviço (`serviceResultCode` reflete o código HTTP da resposta):

```json
{
  "serviceResultCode": 400,
  "serviceResultLog": "Sorry, lookup failed. Please check the details and try again",
  "serviceTime": "151",
  "serviceTransactionId": "08ac9699-dc9e-4cdc-81d7-264f71838309"
}
```

#### `502` Bad Gateway

É retornado quando o serviço não está temporariamente disponível ou sua resposta não pôde ser interpretada. O corpo usa o envelope do serviço com `serviceResultCode: 500`:

```json
{
  "serviceResultCode": 500,
  "serviceResultLog": "Service temporarily unavailable. Please try again later",
  "serviceTime": "3000",
  "serviceTransactionId": "38de2932-0f2h-7gff-14g0-597h04161632"
}
```

#### `504` Gateway Timeout

Erro de **timeout**, retornado com o envelope do serviço:

```json
{
  "serviceResultCode": 504,
  "serviceResultLog": "Request timeout. Please try again",
  "serviceTime": "30000",
  "serviceTransactionId": "48ef3043-1g3i-8hgg-25h1-608i15272743"
}
```

{% hint style="info" %}
Os erros de autenticação (`401`/`403`) são rejeitados pelo **gateway antes de chegar ao serviço** e **não** usam o envelope `serviceResultCode`. Os erros de validação da plataforma usam o formato `application/problem+json`. Consulte [Tratamento de erros](/docs.facephi-pt-br/api-rest/identity-api/identity-api-reference/onboarding/kyc/nigeria.md#manejo-de-errores) para obter detalhes das três formas de resposta.
{% endhint %}
