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

# Triagem criminal por rosto na África do Sul - API

> Triagem criminal facial na África do Sul via Didit: consulta a base oficial. A partir de $8.00 por chamada, sem contratos nem mínimos.

Compara uma imagem facial com bases de antecedentes criminais publicadas para identificar possíveis correspondências. A Didit oferece este serviço por meio de `POST /v3/database-validation/`, para que você possa verificar os dados enviados na fonte oficial e receber resultados de correspondência normalizados.

## Cobertura

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

## Entradas

| Campo | Obrigatório | Exemplo |
| - | -: | - |
| `selfie` | Sim | `@./selfie.jpg` |
| `score_level` | Não | `standard` |
| `max_matches` | Não | `10` |
| `vendor_data` | Não | `user-1234` |

* **Entradas obrigatórias:** `selfie`
* **Entradas opcionais:** `score_level`, `max_matches`, `vendor_data`
* **Consentimento:** Obrigatório
* **Disponibilidade no fluxo:** Disponível no fluxo
* **Cobertura:** —
* **Preço:** \$8.00 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\_criminal\_face\_screening)

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

Exemplo: `zaf_criminal_face_screening`

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

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

Exemplo: `true`

**selfie** `file` *required*

Arquivo de imagem da selfie a ser enviado para validação em um banco de dados biométrico. Formatos aceitos: JPEG, PNG ou WebP.

Exemplo: `@./selfie.jpg`

**score\_level** `string`

Valor de `score_level` exigido por este serviço de banco de dados.

Exemplo: `standard`

**max\_matches** `string`

Valor de `max_matches` exigido por este serviço de banco de dados.

Exemplo: `10`

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

Sua referência estável para esta pessoa, como o ID interno do usuário. A Didit a usa 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 notas 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 chamar o banco de dados. Requisições rejeitadas antes da consulta à fonte 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_criminal_face_screening" \
  -F "vendor_data=user-1234" \
  -F "consent=true" \
  -F "selfie=@./selfie.jpg"
```

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

# Reads DIDIT_API_KEY.
client = Didit()

result = client.database_validation.validate(
    issuing_state="ZAF",
    services=["zaf_criminal_face_screening"],
    consent=True,
    vendor_data="user-1234",
    selfie=open("selfie.jpg", "rb"),
)
print(result)
```

```javascript Node.js theme={null}
import Didit, { fileFromPath } from "@didit-protocol/sdk-node";

// Reads DIDIT_API_KEY.
const didit = new Didit();

const result = await didit.databaseValidation.validate({
  issuing_state: "ZAF",
  services: ["zaf_criminal_face_screening"],
  consent: true,
  vendor_data: "user-1234",
  selfie: await fileFromPath("selfie.jpg"),
});
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_criminal_face_screening"}),
	Consent:      didit.Bool(true),
	VendorData:   didit.String("user-1234"),
	Selfie:       didit.Some(didit.FileFromPath("selfie.jpg")),
})
if err != nil {
	log.Fatal(err)
}
fmt.Printf("%+v\n", result)
```

```java Java theme={null}
import java.nio.file.Path;
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_criminal_face_screening"))
        .consent(true)
        .vendorData("user-1234")
        .selfie(Path.of("selfie.jpg"))
        .build());
System.out.println(result);
```

```php PHP theme={null}
<?php

require 'vendor/autoload.php';

use Didit\DiditClient;
use Didit\File;

// Reads DIDIT_API_KEY.
$didit = new DiditClient();

$result = $didit->databaseValidation->validate([
    'issuing_state' => 'ZAF',
    'services' => ['zaf_criminal_face_screening'],
    'consent' => true,
    'vendor_data' => 'user-1234',
    'selfie' => File::fromPath('selfie.jpg'),
]);
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_criminal_face_screening"],
  consent: true,
  vendor_data: "user-1234",
  selfie: Pathname("selfie.jpg")
)
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_criminal_face_screening" },
    Consent = true,
    VendorData = "user-1234",
    Selfie = FileUpload.FromPath("selfie.jpg"),
});
Console.WriteLine(JsonSerializer.Serialize(result));
```

Toda chamada bem-sucedida retorna HTTP `200`. O campo **`outcome_code`** indica o que de fato 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 registro 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_criminal_face_screening",
      "service_name": "South Africa - Criminal Screening by Face",
      "source_data": {
        "criminal_matches": "sample_value",
        "face_quality": "sample_value",
        "request_id": "SAMPLE-12345"
      },
      "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_criminal_face_screening",
      "service_name": "South Africa - Criminal Screening by Face",
      "source_data": {
        "identification_number": "NO_MATCH"
      },
      "validation": {
        "identification_number": "no_match"
      }
    }
  ]
}
```

**`BIOMETRIC_NO_MATCH`**: a pontuação de correspondência facial ficou abaixo do limiar de aceitação; a selfie não é da mesma pessoa da foto do registro.

```json 200 OK — BIOMETRIC_NO_MATCH theme={null}
{
  "request_id": "req_01H…",
  "status": "Declined",
  "issuing_state": "ZAF",
  "match_type": "no_match",
  "validations": [
    {
      "outcome_code": "BIOMETRIC_NO_MATCH",
      "service_id": "zaf_criminal_face_screening",
      "service_name": "South Africa - Criminal Screening by Face",
      "source_data": {
        "identification_number": "NO_MATCH"
      },
      "validation": {
        "identification_number": "no_match"
      }
    }
  ]
}
```

**`BIOMETRIC_IMAGE_UNUSABLE`**: não foi possível processar a selfie (vazia, sem rosto, baixa qualidade ou o registro não conseguiu lê-la). Peça ao usuário que tire a selfie novamente.

```json 200 OK — BIOMETRIC_IMAGE_UNUSABLE theme={null}
{
  "request_id": "req_01H…",
  "status": "In Review",
  "issuing_state": "ZAF",
  "match_type": "no_match",
  "validations": [
    {
      "outcome_code": "BIOMETRIC_IMAGE_UNUSABLE",
      "service_id": "zaf_criminal_face_screening",
      "service_name": "South Africa - Criminal Screening by Face",
      "source_data": {
        "identification_number": "NO_MATCH"
      },
      "validation": {
        "identification_number": "no_match"
      }
    }
  ]
}
```

## Dados retornados

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

* `criminal_matches`
* `face_quality`
* `request_id`

## Preços e SLAs

As consultas de África do Sul - Triagem criminal por reconhecimento facial são cobradas somente quando a Didit recebe um resultado conclusivo da fonte de validação.

* **Preço por chamada:** \$8.00 USD.
* **Faturamento:** por consulta bem-sucedida. Você não é cobrado quando o registro 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 subjacente varia conforme o país e a base 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.