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

# Vérification de la citoyenneté néo-zélandaise (DIA) - API

> Vérification de la citoyenneté néo-zélandaise via la base DIA, avec Didit. Paiement à l'appel dès $1.67, sans contrat ni minimum.

Service de vérification de la citoyenneté DIA. Didit expose ce service via `POST /v3/database-validation/` afin que vous puissiez vérifier les données soumises auprès de la source faisant autorité et recevoir des résultats de correspondance normalisés.

## Couverture

* **Couverture :** > 10%
* **Pays :** Nouvelle-Zélande
* **Identifiant du service :** `nzl_new_zealand_citizenship`
* **Domaine de données :** Identité
* **Catégorie :** Citoyenneté

## Entrées

| Champ | Obligatoire | Exemple |
| - | -: | - |
| `first_name` | Oui | `John` |
| `last_name` | Oui | `Doe` |
| `date_of_birth` | Oui | `1990-01-01` |
| `vendor_data` | Non | `user-1234` |

* **Champs obligatoires :** `first_name`, `last_name`, `date_of_birth`
* **Champs facultatifs :** `vendor_data`
* **Consentement :** Obligatoire
* **Disponibilité dans le workflow :** Disponible dans le workflow
* **Couverture :** > 10%
* **Prix :** \$1.67 par requête réussie

## Paramètres du corps de la requête

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

Code pays ISO 3166-1 alpha-3 de ce service de base de données.

Exemple : `NZL`

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

Tableau contenant l'identifiant de ce service. Fixer le service limite la requête à cette base de données exacte.

Exemple : `nzl_new_zealand_citizenship`

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

Consentement explicite de l'utilisateur final pour ce service.

Exemple : `true`

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

Prénom à valider.

Exemple : `John`

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

Nom de famille à valider.

Exemple : `Doe`

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

Date de naissance au format `YYYY-MM-DD`.

Exemple : `1990-01-01`

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

Votre référence utilisateur stable pour cette personne, par exemple votre identifiant utilisateur interne. Didit s'en sert pour relier les vérifications autonomes au même utilisateur final et réduire le bruit des détections de doublons.

Exemple : `user-1234`

## Règles de saisie et notes de validation

* Envoyez les champs listés ci-dessus exactement tels qu'ils ont été saisis par l'utilisateur ou relevés sur le document.
* Didit valide les champs obligatoires avant d'interroger la base de données. Les requêtes rejetées avant la consultation de la source ne sont pas facturées.

## Comment l'appeler

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

Chaque appel réussi renvoie un code HTTP `200`. Le champ **`outcome_code`** indique ce qui s'est réellement passé, en permettant de distinguer, par exemple, une véritable absence de correspondance biométrique (`BIOMETRIC_NO_MATCH`) d'un selfie illisible (`BIOMETRIC_IMAGE_UNUSABLE`). Le `status` affiché correspond au statut par défaut de la fonctionnalité ; les [actions configurées pour Partial Match / No Match](https://docs.didit.me/fr/core-technology/database-validation/database-validation-warnings.md) peuvent le remplacer.

**`MATCH`** : Le registre a confirmé l'identité et chaque champ vérifié correspond.

```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`** : Un ou plusieurs champs comparés par ce service ne correspondent pas totalement. Dans cet exemple, `full_name` ne correspond pas, tandis que `date_of_birth` correspond.

```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`** : Le registre n'a renvoyé aucune correspondance pour les données soumises.

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

## Données renvoyées

Les champs exacts présentés dans `source_data` dépendent des données renvoyées par le registre. L'exemple généré pour `nzl_new_zealand_citizenship` documente actuellement cette structure normalisée :

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

## Tarifs et SLA

Les requêtes DIA - New Zealand Citizenship ne sont facturées que lorsque Didit reçoit un résultat concluant de la source de validation.

* **Prix par appel :** \$1.67 USD.
* **Facturation :** par requête réussie. Vous n'êtes pas facturé lorsque le registre est injoignable, lorsque des champs obligatoires sont manquants, ou lorsque la requête est rejetée avant d'atteindre la source.
* **Latence :** p95 typique \< 2 s.
* **Disponibilité :** 99.9% par trimestre du côté de Didit ; la disponibilité de la source en aval varie selon le pays et le jeu de données.

## Pour aller plus loin

* [Présentation de la validation en base de données pour la Nouvelle-Zélande](https://docs.didit.me/api-reference/database-validation/new-zealand.md)
* [Présentation de la validation en base de données](https://docs.didit.me/fr/core-technology/database-validation/overview.md)
* [Codes de résultat](https://docs.didit.me/fr/core-technology/database-validation/database-validation-outcome-codes.md)


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