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

# Afrique du Sud - API de contactabilité : ID Match

> Afrique du Sud - Contactabilité : validation en base de données officielle via Didit. À partir de $0.35 par appel, sans contrat ni minimum.

Renvoie les numéros de téléphone, adresses e-mail et adresses connus qui sont associés à une personne physique sud-africaine. 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 :** —
* **Pays :** Afrique du Sud
* **Identifiant du service :** `zaf_contactability`
* **Domaine de données :** Télécommunications
* **Catégorie :** Télécommunications

## Entrées

| Champ | Obligatoire | Exemple |
| - | -: | - |
| `national_id` | Oui | `SAMPLE-NID-12345` |
| `vendor_data` | Non | `user-1234` |

* **Entrées obligatoires :** `national_id`
* **Entrées facultatives :** `vendor_data`
* **Consentement :** requis
* **Disponibilité dans le workflow :** disponible dans un workflow
* **Couverture :** —
* **Tarif :** \$0.35 par requête réussie

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

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

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

Exemple : `ZAF`

**services** `string` *required* (default: zaf\_contactability)

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

Exemple : `zaf_contactability`

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

Consentement explicite de l'utilisateur final pour ce service.

Exemple : `true`

**national\_id** `string` *required* (default: SAMPLE-NID-12345)

Numéro d'identité nationale pour ce service.

Exemple : `SAMPLE-NID-12345`

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

Votre référence stable pour cette personne, par exemple votre identifiant utilisateur interne. Didit l'utilise pour relier les vérifications autonomes au même utilisateur final et réduire le bruit de détection des 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 recherche dans 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=ZAF" \
  -F "services=zaf_contactability" \
  -F "vendor_data=user-1234" \
  -F "consent=true" \
  -F "national_id=SAMPLE-NID-12345"
```

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

# Reads DIDIT_API_KEY.
client = Didit()

result = client.database_validation.validate(
    issuing_state="ZAF",
    services=["zaf_contactability"],
    consent=True,
    national_id="SAMPLE-NID-12345",
    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: "ZAF",
  services: ["zaf_contactability"],
  consent: true,
  national_id: "SAMPLE-NID-12345",
  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: "ZAF",
	Services:     didit.Some([]string{"zaf_contactability"}),
	Consent:      didit.Bool(true),
	NationalID:   didit.String("SAMPLE-NID-12345"),
	VendorData:   didit.String("user-1234"),
})
if err != nil {
	log.Fatal(err)
}
fmt.Printf("%+v\n", result)
```

```java Java theme={null}
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("ZAF")
        .services(List.of("zaf_contactability"))
        .consent(true)
        .nationalId("SAMPLE-NID-12345")
        .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' => 'ZAF',
    'services' => ['zaf_contactability'],
    'consent' => true,
    'national_id' => 'SAMPLE-NID-12345',
    '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: "ZAF",
  services: ["zaf_contactability"],
  consent: true,
  national_id: "SAMPLE-NID-12345",
  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 = "ZAF",
    Services = new string[] { "zaf_contactability" },
    Consent = true,
    NationalId = "SAMPLE-NID-12345",
    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 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é ; vos [actions Partial Match / No Match](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 tous les champs vérifiés correspondent.

```json 200 OK — MATCH theme={null}
{
  "request_id": "req_01H…",
  "status": "Approved",
  "issuing_state": "ZAF",
  "match_type": "full_match",
  "validations": [
    {
      "outcome_code": "MATCH",
      "service_id": "zaf_contactability",
      "service_name": "South Africa - Contactability Lookup",
      "source_data": {
        "contact_email": "alex.sample@example.com",
        "contact_phone_numbers": "+15550101000",
        "date_of_birth": "1990-01-01",
        "deceased": "sample_value",
        "first_name": "John",
        "gender": "M",
        "identification_number": "SAMPLE-ID-12345",
        "last_name": "Doe",
        "phone_history_count": "+15550101000"
      },
      "validation": {
        "identification_number": "full_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": "ZAF",
  "match_type": "no_match",
  "validations": [
    {
      "outcome_code": "NO_MATCH",
      "service_id": "zaf_contactability",
      "service_name": "South Africa - Contactability Lookup",
      "source_data": {
        "identification_number": "NO_MATCH"
      },
      "validation": {
        "identification_number": "no_match"
      }
    }
  ]
}
```

## Données renvoyées

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

* `contact_email`
* `contact_phone_numbers`
* `date_of_birth`
* `deceased`
* `first_name`
* `gender`
* `identification_number`
* `last_name`
* `phone_history_count`

## Tarifs et SLA

Les requêtes de recherche de coordonnées pour l'Afrique du Sud sont facturées uniquement lorsque Didit reçoit un résultat concluant de la source de validation.

* **Prix par appel :** \$0.35 USD.
* **Facturation :** par requête réussie. Aucun frais n'est 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 côté Didit ; la disponibilité de la source 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 en Afrique du Sud](https://docs.didit.me/api-reference/database-validation/south-africa.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.