> ## 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 verificação de cidadania da Nova Zelândia - DIA

> DIA - Cidadania da Nova Zelândia: consulta à base oficial neozelandesa via Didit. Pague por consulta a partir de $1.67, sem contratos nem mínimos.

Serviço de verificação de cidadania do DIA. A Didit disponibiliza este serviço por meio de `POST /v3/database-validation/` para que você possa verificar os dados enviados contra a fonte oficial e receber resultados de correspondência normalizados.

## Cobertura

* **Cobertura:** > 10%
* **País:** Nova Zelândia
* **ID do serviço:** `nzl_new_zealand_citizenship`
* **Domínio de dados:** Identidade
* **Categoria:** Cidadania

## Entradas

| Campo | Obrigatório | Exemplo |
| - | -: | - |
| `first_name` | Sim | `John` |
| `last_name` | Sim | `Doe` |
| `date_of_birth` | Sim | `1990-01-01` |
| `vendor_data` | Não | `user-1234` |

* **Entradas obrigatórias:** `first_name`, `last_name`, `date_of_birth`
* **Entradas opcionais:** `vendor_data`
* **Consentimento:** Obrigatório
* **Disponibilidade no workflow:** Disponível no workflow
* **Cobertura:** > 10%
* **Preço:** \$1.67 por consulta bem-sucedida

## Parâmetros do corpo

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

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

Exemplo: `NZL`

**services** `string` *required* (default: nzl\_new\_zealand\_citizenship)

Array que contém este ID de serviço. Definir o serviço mantém a requisição restrita a este banco de dados específico.

Exemplo: `nzl_new_zealand_citizenship`

**consent** `boolean` *required* (default: true)

Consentimento explícito do usuário final para este serviço.

Exemplo: `true`

**first\_name** `string` *required* (default: John)

Nome a validar.

Exemplo: `John`

**last\_name** `string` *required* (default: Doe)

Sobrenome a validar.

Exemplo: `Doe`

**date\_of\_birth** `string` *required* (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

* Envie os campos listados acima exatamente como foram capturados do usuário ou do documento.
* A Didit valida os campos obrigatórios antes de chamar o banco de dados. Requisições rejeitadas antes da consulta à fonte não são cobradas.

## 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=NZL" \
  -F "services=nzl_new_zealand_citizenship" \
  -F "vendor_data=user-1234" \
  -F "consent=true" \
  -F "first_name=John" \
  -F "last_name=Doe" \
  -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="NZL",
    services=["nzl_new_zealand_citizenship"],
    consent=True,
    first_name="John",
    last_name="Doe",
    date_of_birth="1990-01-01",
    vendor_data="user-1234",
)
print(result)
```

```javascript Node.js theme={null}
import Didit from "@didit-protocol/sdk-node";

// Reads DIDIT_API_KEY.
const didit = new Didit();

const result = await didit.databaseValidation.validate({
  issuing_state: "NZL",
  services: ["nzl_new_zealand_citizenship"],
  consent: true,
  first_name: "John",
  last_name: "Doe",
  date_of_birth: "1990-01-01",
  vendor_data: "user-1234",
});
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: "NZL",
	Services:     didit.Some([]string{"nzl_new_zealand_citizenship"}),
	Consent:      didit.Bool(true),
	FirstName:    didit.String("John"),
	LastName:     didit.String("Doe"),
	DateOfBirth:  didit.String("1990-01-01"),
	VendorData:   didit.String("user-1234"),
})
if err != nil {
	log.Fatal(err)
}
fmt.Printf("%+v\n", result)
```

```java Java theme={null}
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("NZL")
        .services(List.of("nzl_new_zealand_citizenship"))
        .consent(true)
        .firstName("John")
        .lastName("Doe")
        .dateOfBirth(LocalDate.parse("1990-01-01"))
        .vendorData("user-1234")
        .build());
System.out.println(result);
```

```php PHP theme={null}
<?php

require 'vendor/autoload.php';

use Didit\DiditClient;

// Reads DIDIT_API_KEY.
$didit = new DiditClient();

$result = $didit->databaseValidation->validate([
    'issuing_state' => 'NZL',
    'services' => ['nzl_new_zealand_citizenship'],
    'consent' => true,
    'first_name' => 'John',
    'last_name' => 'Doe',
    'date_of_birth' => '1990-01-01',
    'vendor_data' => 'user-1234',
]);
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: "NZL",
  services: ["nzl_new_zealand_citizenship"],
  consent: true,
  first_name: "John",
  last_name: "Doe",
  date_of_birth: "1990-01-01",
  vendor_data: "user-1234"
)
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 = "NZL",
    Services = new string[] { "nzl_new_zealand_citizenship" },
    Consent = true,
    FirstName = "John",
    LastName = "Doe",
    DateOfBirth = "1990-01-01",
    VendorData = "user-1234",
});
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": "NZL",
  "match_type": "full_match",
  "validations": [
    {
      "outcome_code": "MATCH",
      "service_id": "nzl_new_zealand_citizenship",
      "service_name": "DIA - New Zealand Citizenship",
      "source_data": {
        "date_of_birth": "1990-01-01",
        "first_name": "John",
        "last_name": "Doe"
      },
      "validation": {
        "date_of_birth": "full_match",
        "full_name": "full_match"
      }
    }
  ]
}
```

**`PARTIAL_MATCH`**: um ou mais dos campos que este serviço compara não corresponderam totalmente. Neste exemplo, `full_name` não correspondeu, enquanto `date_of_birth` correspondeu.

```json 200 OK — PARTIAL_MATCH theme={null}
{
  "request_id": "req_01H…",
  "status": "In Review",
  "issuing_state": "NZL",
  "match_type": "partial_match",
  "validations": [
    {
      "outcome_code": "PARTIAL_MATCH",
      "service_id": "nzl_new_zealand_citizenship",
      "service_name": "DIA - New Zealand Citizenship",
      "source_data": {
        "date_of_birth": "1990-01-01",
        "first_name": "John",
        "last_name": "Doe"
      },
      "validation": {
        "date_of_birth": "full_match",
        "full_name": "no_match"
      }
    }
  ]
}
```

**`NO_MATCH`**: o cadastro não retornou nenhuma correspondência para os dados enviados.

```json 200 OK — NO_MATCH theme={null}
{
  "request_id": "req_01H…",
  "status": "Declined",
  "issuing_state": "NZL",
  "match_type": "no_match",
  "validations": [
    {
      "outcome_code": "NO_MATCH",
      "service_id": "nzl_new_zealand_citizenship",
      "service_name": "DIA - New Zealand Citizenship",
      "source_data": {
        "date_of_birth": "NO_MATCH",
        "full_name": "NO_MATCH"
      },
      "validation": {
        "date_of_birth": "no_match",
        "full_name": "no_match"
      }
    }
  ]
}
```

## Dados retornados

Os campos exatos expostos em `source_data` dependem do que o registro de empresas retorna. O exemplo gerado para `nzl_new_zealand_citizenship` documenta atualmente este formato normalizado:

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

## Preços e SLAs

As consultas de DIA - Cidadania da Nova Zelândia são cobradas somente quando a Didit recebe um resultado conclusivo da fonte de validação.

* **Preço por chamada:** \$1.67 USD.
* **Faturamento:** por consulta bem-sucedida. Você não é cobrado quando o registro 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 do lado da Didit; a disponibilidade da fonte downstream varia por país e conjunto de dados.

## Continue a leitura

* [Visão geral da Validação de banco de dados da Nova Zelândia](https://docs.didit.me/api-reference/database-validation/new-zealand.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.