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

# Validació en bases de dades Sud-àfrica: API ID Match

> Consulta de contactabilitat a Sud-àfrica: validació en bases de dades oficials amb Didit. Des de $0.35 per consulta, sense contractes ni mínims.

Retorna números de telèfon, adreces de correu electrònic i adreces conegudes vinculades a una persona física sud-africana. Didit ofereix aquest servei a través de `POST /v3/database-validation/` perquè puguis verificar les dades enviades amb la font de referència i rebre resultats de coincidència normalitzats.

## Cobertura

* **Cobertura:** —
* **País:** Sud-àfrica
* **ID del servei:** `zaf_contactability`
* **Àmbit de dades:** Telecomunicacions
* **Categoria:** Telecomunicacions

## Entrades

| Camp | Obligatori | Exemple |
| - | -: | - |
| `national_id` | Sí | `SAMPLE-NID-12345` |
| `vendor_data` | No | `user-1234` |

* **Entrades obligatòries:** `national_id`
* **Entrades opcionals:** `vendor_data`
* **Consentiment:** Obligatori
* **Disponibilitat en el flux de treball:** Disponible en el flux de treball
* **Cobertura:** —
* **Preu:** \$0.35 per consulta satisfactòria

## Paràmetres del cos

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

Codi de país ISO 3166-1 alfa-3 per a aquest servei de base de dades.

Exemple: `ZAF`

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

Matriu que conté aquest ID de servei. Fixar el servei manté la sol·licitud limitada a aquesta base de dades exacta.

Exemple: `zaf_contactability`

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

Consentiment explícit de l'usuari final per a aquest servei.

Exemple: `true`

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

Número d'identitat nacional per a aquest servei.

Exemple: `SAMPLE-NID-12345`

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

La teva referència estable d'usuari per a aquesta persona, com ara el teu ID d'usuari intern. Didit l'utilitza per vincular les comprovacions independents amb el mateix usuari final i reduir el soroll de detecció de duplicats.

Exemple: `user-1234`

## Regles d'entrada i notes de validació

* Envia els camps indicats més amunt exactament tal com s'han capturat de l'usuari o del document.
* Didit valida els camps obligatoris abans de cridar la base de dades. Les sol·licituds rebutjades abans de la consulta a la font no es cobren.

## Com fer la crida

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

Cada crida satisfactòria retorna HTTP `200`. El camp **`outcome_code`** indica què ha passat realment: per exemple, distingeix una incompatibilitat biomètrica real (`BIOMETRIC_NO_MATCH`) d'una selfie que no s'ha pogut llegir (`BIOMETRIC_IMAGE_UNUSABLE`). L'`status` mostrat és l'estat per defecte de la funcionalitat; les [accions de Coincidència parcial / Sense coincidència](https://docs.didit.me/ca/core-technology/database-validation/database-validation-warnings.md) que hagis configurat poden substituir-lo.

**`MATCH`**: El registre ha confirmat la identitat i tots els camps verificats coincideixen.

```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`**: El registre no ha retornat cap coincidència per a les dades enviades.

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

## Dades retornades

Els camps exactes que apareixen a `source_data` depenen del que retorni el registre. L'exemple generat per a `zaf_contactability` documenta actualment aquesta forma normalitzada:

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

## Preus i SLA

Les consultes South Africa - Contactability Lookup només es facturen quan Didit rep un resultat concloent de la font de validació.

* **Preu per crida:** \$0.35 USD.
* **Facturació:** per consulta satisfactòria. No es factura quan el registre no és accessible, quan falten camps obligatoris o quan la sol·licitud es rebutja abans d'arribar a la font.
* **Latència:** p95 típica inferior a 2 s.
* **Disponibilitat:** 99.9% per trimestre per part de Didit; la disponibilitat de les fonts subjacents varia segons el país i el conjunt de dades.

## Continuar llegint

* [Visió general de Validació en bases de dades a Sud-àfrica](https://docs.didit.me/api-reference/database-validation/south-africa.md)
* [Visió general de Validació en bases de dades](https://docs.didit.me/ca/core-technology/database-validation/overview.md)
* [Codis de resultat](https://docs.didit.me/ca/core-technology/database-validation/database-validation-outcome-codes.md)


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