> ## 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 triagem para prevenção de fraude na África do Sul

> Validação de base de dados na África do Sul via Didit: consulta à base de dados oficial. A partir de $0.30 por chamada, sem contratos nem mínimos.

Verifica uma pessoa face à lista de vigilância do South African Fraud Prevention Service (SAFPS). A Didit disponibiliza este serviço através de `POST /v3/database-validation/` para que possa verificar os dados enviados com a fonte oficial e receber resultados de correspondência normalizados.

## Cobertura

* **Cobertura:** —
* **País:** África do Sul
* **ID do serviço:** `zaf_fraud_prevention`
* **Domínio de dados:** Antecedentes
* **Categoria:** Antecedentes

## Entradas

| Campo | Obrigatório | Exemplo |
| - | -: | - |
| `national_id` | Não | `SAMPLE-NID-12345` |
| `bank_account_number` | Não | `1234567890` |
| `phone_number` | Não | `+15550101000` |
| `email` | Não | `john.doe@example.com` |
| `vendor_data` | Não | `user-1234` |

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

## Parâmetros do corpo

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

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

Exemplo: `ZAF`

**services** `string` *required* (default: zaf\_fraud\_prevention)

Array que contém o ID deste serviço. Fixar o serviço mantém o pedido limitado a esta base de dados exata.

Exemplo: `zaf_fraud_prevention`

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

Consentimento explícito do utilizador final para este serviço.

Exemplo: `true`

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

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

Exemplo: `SAMPLE-NID-12345`

**bank\_account\_number** `string`

Valor de `bank_account_number` exigido por este serviço de base de dados.

Exemplo: `1234567890`

**phone\_number** `string`

Valor de `phone_number` exigido por este serviço de base de dados.

Exemplo: `+15550101000`

**email** `string`

Endereço de e-mail.

Exemplo: `john.doe@example.com`

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

A sua referência estável do utilizador para esta pessoa, como o ID interno do utilizador. A Didit usa-a para associar verificações isoladas ao mesmo utilizador final e reduzir o ruído de deteção de duplicados.

Exemplo: `user-1234`

## Regras de entrada e notas de validação

* Envie os campos indicados acima exatamente como foram recolhidos do utilizador ou do documento.
* A Didit valida os campos obrigatórios antes de chamar a base de dados. Os pedidos rejeitados antes da consulta à fonte não são cobrados.

## 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_fraud_prevention" \
  -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_fraud_prevention"],
    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_fraud_prevention"],
  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_fraud_prevention"}),
	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_fraud_prevention"))
        .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_fraud_prevention'],
    '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_fraud_prevention"],
  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_fraud_prevention" },
    Consent = true,
    NationalId = "SAMPLE-NID-12345",
    VendorData = "user-1234",
});
Console.WriteLine(JsonSerializer.Serialize(result));
```

Cada chamada bem-sucedida devolve HTTP `200`. O campo **`outcome_code`** indica o que realmente aconteceu, distinguindo, por exemplo, uma verdadeira falta de correspondência biométrica (`BIOMETRIC_NO_MATCH`) de uma selfie que não pôde ser lida (`BIOMETRIC_IMAGE_UNUSABLE`). O `status` apresentado é o estado predefinido da funcionalidade; as suas [ações configuradas para Correspondência parcial / Sem correspondência](https://docs.didit.me/pt/core-technology/database-validation/database-validation-warnings.md) podem substituí-lo.

**`MATCH`**: o registo confirmou a identidade e todos os campos verificados correspondem.

```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_fraud_prevention",
      "service_name": "South Africa - Fraud Prevention Screening",
      "source_data": {
        "fraud_listings": "sample_value",
        "identification_number": "SAMPLE-ID-12345"
      },
      "validation": {
        "identification_number": "full_match"
      }
    }
  ]
}
```

**`NO_MATCH`**: o registo não devolveu 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_fraud_prevention",
      "service_name": "South Africa - Fraud Prevention Screening",
      "source_data": {
        "identification_number": "NO_MATCH"
      },
      "validation": {
        "identification_number": "no_match"
      }
    }
  ]
}
```

## Dados devolvidos

Os campos exatos apresentados em `source_data` dependem do que o registo devolve. O exemplo gerado para `zaf_fraud_prevention` documenta atualmente esta estrutura normalizada:

* `fraud_listings`
* `identification_number`

## Preços e SLAs

As consultas de Triagem de prevenção de fraude na África do Sul só são faturadas quando a Didit recebe um resultado conclusivo da fonte de validação.

* **Preço por chamada:** \$0.30 USD.
* **Faturação:** por consulta bem-sucedida. Não lhe é cobrado quando o registo está inacessível, quando faltam campos obrigatórios ou quando o pedido é rejeitado antes de chegar à fonte.
* **Latência:** p95 típica inferior a 2 s.
* **Disponibilidade:** 99.9% por trimestre do lado da Didit; a disponibilidade da fonte a jusante varia consoante o país e o conjunto de dados.

## Continuar a ler

* [Visão geral da validação de base de dados da África do Sul](https://docs.didit.me/api-reference/database-validation/south-africa.md)
* [Visão geral da validação de base de dados](https://docs.didit.me/pt/core-technology/database-validation/overview.md)
* [Códigos de resultado](https://docs.didit.me/pt/core-technology/database-validation/database-validation-outcome-codes.md)


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