> ## 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 contactabilidade na África do Sul: ID Match

> Consulta de contactabilidade na África do Sul em base oficial via Didit. Pague por chamada a partir de $0.35, sem contratos nem mínimos.

Retorna os números de telefone, e-mails e endereços conhecidos vinculados a uma pessoa física sul-africana. A Didit disponibiliza este serviço por meio de `POST /v3/database-validation/`, para que você possa verificar os dados enviados junto à fonte oficial e receber resultados de correspondência normalizados.

## Cobertura

* **Cobertura:** —
* **País:** África do Sul
* **ID do serviço:** `zaf_contactability`
* **Domínio de dados:** Telecomunicações
* **Categoria:** Telecomunicações

## Entradas

| Campo | Obrigatório | Exemplo |
| - | -: | - |
| `national_id` | Sim | `SAMPLE-NID-12345` |
| `vendor_data` | Não | `user-1234` |

* **Entradas obrigatórias:** `national_id`
* **Entradas opcionais:** `vendor_data`
* **Consentimento:** Obrigatório
* **Disponibilidade no workflow:** Disponível no fluxo
* **Cobertura:** —
* **Preço:** \$0.35 por consulta bem-sucedida

## Parâmetros do corpo

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

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

Exemplo: `ZAF`

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

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

Exemplo: `zaf_contactability`

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

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

Exemplo: `true`

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

Número de identidade nacional para este serviço.

Exemplo: `SAMPLE-NID-12345`

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

Sua referência estável para esta pessoa, como o ID interno do usuário. A Didit a utiliza 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 observações 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 consultar o banco de dados. Requisições rejeitadas antes da consulta à fonte de dados não são cobradas.

## Como fazer a chamada

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

Toda chamada bem-sucedida retorna HTTP `200`. O campo **`outcome_code`** informa o que realmente 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 correspondência parcial / sem correspondência](https://docs.didit.me/pt-br/core-technology/database-validation/database-validation-warnings.md) que você configurou podem substituí-lo.

**`MATCH`**: o cadastro confirmou a identidade e todos os campos verificados corresponderam.

```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`**: o registro 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": "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"
      }
    }
  ]
}
```

## Dados retornados

Os campos exatos apresentados em `source_data` dependem do que o registro retorna. O exemplo gerado para `zaf_contactability` documenta atualmente este formato normalizado:

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

## Preços e SLAs

As consultas de verificação de contato da África do Sul são cobradas somente quando a Didit recebe um resultado conclusivo da fonte de validação.

* **Preço por chamada:** \$0.35 USD.
* **Faturamento:** por consulta bem-sucedida. Você não é cobrado quando o cadastro 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 externa varia conforme o país e o conjunto de dados.

## Continue lendo

* [Visão geral da Validação de banco de dados da África do Sul](https://docs.didit.me/api-reference/database-validation/south-africa.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.