> ## 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 vérification de décès en Nouvelle-Zélande (BDM)

> Vérification de décès en Nouvelle-Zélande (BDM) via Didit, sur la base officielle. Dès $0.27 par appel, sans contrat ni minimum.

Le registre officiel néo-zélandais des naissances, décès et mariages. Didit expose ce service via `POST /v3/database-validation/` afin de vérifier les données soumises auprès de la source faisant autorité et de recevoir des résultats de correspondance normalisés.

## Couverture

* **Couverture :** 100%\*
* **Pays :** Nouvelle-Zélande
* **ID du service :** `nzl_zealand_death_check`
* **Domaine de données :** Autre
* **Catégorie :** DeathRecord

## Entrées

| Champ | Obligatoire | Exemple |
| - | -: | - |
| `first_name` | Oui | `John` |
| `last_name` | Oui | `Doe` |
| `date_of_birth` | Oui | `1990-01-01` |
| `address.street_1` | Oui | `123 Sample Street` |
| `address.postal_code` | Oui | `10001` |
| `address.street_2` | Non | `Unit 4` |
| `address.city` | Non | `Sample City` |
| `address.region` | Non | `Sample State` |
| `vendor_data` | Non | `user-1234` |

* **Entrées obligatoires :** `first_name`, `last_name`, `date_of_birth`, `address.street_1`, `address.postal_code`
* **Entrées facultatives :** `address.street_2`, `address.city`, `address.region`, `vendor_data`
* **Consentement :** Non requis
* **Disponibilité dans le workflow :** Disponible dans le workflow
* **Couverture :** 100%\*
* **Prix :** \$0.27 par requête réussie

## Paramètres du corps de 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\_zealand\_death\_check)

Tableau contenant l'ID de ce service. Épingler le service limite la requête à cette base de données précise.

Exemple : `nzl_zealand_death_check`

**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`

**address** `object` *required* (default: \{"street\_1":"123 Sample Street","street\_2":"Unit 4","city":"Sample City","region":"Sample State","postal\_code":"10001","country":"US"})

Objet d'adresse résidentielle structuré. Utilisez `street_1`, `street_2`, `city`, `region`, `postal_code` et `country`. Une chaîne d'adresse complète au format ancien est toujours acceptée, mais non recommandée.

Exemple : `{"street_1":"123 Sample Street","street_2":"Unit 4","city":"Sample City","region":"Sample State","postal_code":"10001","country":"US"}`

**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 indépendantes au même utilisateur final et réduire le bruit généré par la détection des doublons.

Exemple : `user-1234`

## Règles de saisie et notes de validation

* Pour les services d'adresse, envoyez des champs d'adresse structurés plutôt qu'une seule chaîne `address` lorsque c'est possible.
* `address.street_1` correspond à la voie, y compris le numéro et le type de voie.
* `address.street_2` correspond à l'appartement, à l'unité, au bâtiment, à l'étage ou à toute ligne d'adresse supplémentaire. Ne l'envoyez que si vous le possédez.
* `address.city` correspond à la ville, à la banlieue, au district, à la localité ou au quartier.
* `address.region` correspond à l'État, à la province, à la région ou à la ville.
* `address.postal_code` correspond au code postal.
* Les services de base de données fondés sur l'adresse exigent au minimum la voie et le code postal ; 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_zealand_death_check" \
  -F "vendor_data=user-1234" \
  -F "first_name=John" \
  -F "last_name=Doe" \
  -F "date_of_birth=1990-01-01" \
  -F 'address={"street_1":"123 Sample Street","street_2":"Unit 4","city":"Sample City","region":"Sample State","postal_code":"10001","country":"US"}'
```

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

# Reads DIDIT_API_KEY.
client = Didit()

result = client.database_validation.validate(
    issuing_state="NZL",
    services=["nzl_zealand_death_check"],
    first_name="John",
    last_name="Doe",
    date_of_birth="1990-01-01",
    address={"street_1": "123 Sample Street", "street_2": "Unit 4", "city": "Sample City", "region": "Sample State", "postal_code": "10001", "country": "US"},
    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_zealand_death_check"],
  first_name: "John",
  last_name: "Doe",
  date_of_birth: "1990-01-01",
  address: { street_1: "123 Sample Street", street_2: "Unit 4", city: "Sample City", region: "Sample State", postal_code: "10001", country: "US" },
  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_zealand_death_check"}),
	FirstName:    didit.String("John"),
	LastName:     didit.String("Doe"),
	DateOfBirth:  didit.String("1990-01-01"),
	Address:      didit.Some[any](map[string]any{"street_1": "123 Sample Street", "street_2": "Unit 4", "city": "Sample City", "region": "Sample State", "postal_code": "10001", "country": "US"}),
	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_zealand_death_check"))
        .firstName("John")
        .lastName("Doe")
        .dateOfBirth(LocalDate.parse("1990-01-01"))
        .address(DatabaseValidationValidateParams.Address.ofVariant1(DatabaseValidationValidateParams.Address.Variant1.builder()
                .street1("123 Sample Street")
                .street2("Unit 4")
                .city("Sample City")
                .region("Sample State")
                .postalCode("10001")
                .country("US")
                .build()))
        .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_zealand_death_check'],
    'first_name' => 'John',
    'last_name' => 'Doe',
    'date_of_birth' => '1990-01-01',
    'address' => ['street_1' => '123 Sample Street', 'street_2' => 'Unit 4', 'city' => 'Sample City', 'region' => 'Sample State', 'postal_code' => '10001', 'country' => 'US'],
    '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_zealand_death_check"],
  first_name: "John",
  last_name: "Doe",
  date_of_birth: "1990-01-01",
  address: { street_1: "123 Sample Street", street_2: "Unit 4", city: "Sample City", region: "Sample State", postal_code: "10001", country: "US" },
  vendor_data: "user-1234"
)
puts result.to_h
```

```csharp .NET theme={null}
using System;
using System.Collections.Generic;
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_zealand_death_check" },
    FirstName = "John",
    LastName = "Doe",
    DateOfBirth = "1990-01-01",
    Address = new Dictionary<string, object> { ["street_1"] = "123 Sample Street", ["street_2"] = "Unit 4", ["city"] = "Sample City", ["region"] = "Sample State", ["postal_code"] = "10001", ["country"] = "US" },
    VendorData = "user-1234",
});
Console.WriteLine(JsonSerializer.Serialize(result));
```

Chaque appel réussi renvoie le code HTTP `200`. Le champ **`outcome_code`** indique ce qui s'est réellement passé, en distinguant par exemple une véritable non-correspondance biométrique (`BIOMETRIC_NO_MATCH`) d'un selfie qui n'a pas pu être lu (`BIOMETRIC_IMAGE_UNUSABLE`). Le `status` affiché est le statut par défaut de la fonctionnalité ; vos [actions de correspondance partielle / d'absence de correspondance](https://docs.didit.me/fr/core-technology/database-validation/database-validation-warnings.md) configurées 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_zealand_death_check",
      "service_name": "New Zealand Death Check (BDM)",
      "source_data": {
        "address": "123 Sample Street",
        "address_match_score": "1.000",
        "city": "Sample City",
        "date_of_birth": "1990-01-01",
        "first_name": "John",
        "full_name": "John Doe",
        "last_name": "Doe",
        "name_match_score": "1.000",
        "postal_code": "10001",
        "state": "Sample State",
        "street": "sample_value"
      },
      "validation": {
        "address": "full_match",
        "date_of_birth": "full_match",
        "full_name": "full_match"
      }
    }
  ]
}
```

**`PARTIAL_MATCH`** : Un ou plusieurs champs comparés par ce service ne correspondent pas entièrement. Dans cet exemple, `full_name` ne correspond pas, alors que `address` et `date_of_birth` correspondent.

```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_zealand_death_check",
      "service_name": "New Zealand Death Check (BDM)",
      "source_data": {
        "address": "123 Sample Street",
        "address_match_score": "1.000",
        "city": "Sample City",
        "date_of_birth": "1990-01-01",
        "first_name": "John",
        "full_name": "John Doe",
        "last_name": "Doe",
        "name_match_score": "1.000",
        "postal_code": "10001",
        "state": "Sample State",
        "street": "sample_value"
      },
      "validation": {
        "address": "full_match",
        "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_zealand_death_check",
      "service_name": "New Zealand Death Check (BDM)",
      "source_data": {
        "address": "NO_MATCH",
        "date_of_birth": "NO_MATCH",
        "full_name": "NO_MATCH"
      },
      "validation": {
        "address": "no_match",
        "date_of_birth": "no_match",
        "full_name": "no_match"
      }
    }
  ]
}
```

## Données renvoyées

Les champs exacts remontés dans `source_data` dépendent de ce que renvoie le registre. L'exemple généré pour `nzl_zealand_death_check` documente actuellement cette structure normalisée :

* `address`
* `address_match_score`
* `city`
* `date_of_birth`
* `first_name`
* `full_name`
* `last_name`
* `name_match_score`
* `postal_code`
* `state`
* `street`

## Tarifs et SLA

Les requêtes New Zealand Death Check (BDM) ne sont facturées que lorsque Didit reçoit un résultat concluant de la source de validation.

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

## Pour aller plus loin

* [Vue d'ensemble de la validation en base de données pour la Nouvelle-Zélande](https://docs.didit.me/api-reference/database-validation/new-zealand.md)
* [Vue d'ensemble 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.