> ## 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 antecedentes penales por rostro en Sudáfrica

> Verificación de antecedentes penales por rostro en Sudáfrica con Didit: consulta oficial. Desde $8.00 por consulta, sin contratos ni mínimos.

Compara una imagen facial con conjuntos de datos publicados de antecedentes penales para detectar posibles coincidencias. Didit ofrece este servicio a través de `POST /v3/database-validation/` para que puedas verificar los datos enviados con la fuente oficial y recibir resultados de coincidencia normalizados.

## Cobertura

* **Cobertura:** —
* **País:** Sudáfrica
* **ID del servicio:** `zaf_criminal_face_screening`
* **Dominio de datos:** Antecedentes penales
* **Categoría:** Antecedentes penales

## Datos de entrada

| Campo | Obligatorio | Ejemplo |
| - | -: | - |
| `selfie` | Sí | `@./selfie.jpg` |
| `score_level` | No | `standard` |
| `max_matches` | No | `10` |
| `vendor_data` | No | `user-1234` |

* **Datos obligatorios:** `selfie`
* **Datos opcionales:** `score_level`, `max_matches`, `vendor_data`
* **Consentimiento:** Obligatorio
* **Disponibilidad en flujos:** Disponible en el flujo de trabajo
* **Cobertura:** —
* **Precio:** \$8.00 por consulta exitosa

## Parámetros del cuerpo

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

Código de país ISO 3166-1 alfa-3 de este servicio de base de datos.

Ejemplo: `ZAF`

**services** `string` *required* (default: zaf\_criminal\_face\_screening)

Array que contiene el ID de este servicio. Fijar el servicio limita la solicitud a esta base de datos concreta.

Ejemplo: `zaf_criminal_face_screening`

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

Consentimiento explícito del usuario final para este servicio.

Ejemplo: `true`

**selfie** `file` *required*

Archivo de imagen de la selfie que se sube para la validación en la base de datos biométrica. Formatos admitidos: JPEG, PNG o WebP.

Ejemplo: `@./selfie.jpg`

**score\_level** `string`

Valor de `score_level` que requiere este servicio de base de datos.

Ejemplo: `standard`

**max\_matches** `string`

Valor de `max_matches` que requiere este servicio de base de datos.

Ejemplo: `10`

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

Tu referencia estable de usuario para esta persona, como tu ID interno de usuario. Didit la usa para vincular las comprobaciones independientes al mismo usuario final y reducir el ruido en la detección de duplicados.

Ejemplo: `user-1234`

## Reglas de entrada y notas de validación

* Envía los campos indicados arriba exactamente como se obtuvieron del usuario o del documento.
* Didit valida los campos obligatorios antes de consultar la base de datos. Las solicitudes rechazadas antes de consultar la fuente no se cobran.

## Cómo invocar el endpoint

```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 llamada exitosa devuelve HTTP `200`. El campo **`outcome_code`** indica lo que ocurrió realmente; por ejemplo, distingue una falta de coincidencia biométrica real (`BIOMETRIC_NO_MATCH`) de una selfie que no se pudo leer (`BIOMETRIC_IMAGE_UNUSABLE`). El `status` que se muestra es el estado predeterminado de la función; las [acciones de Partial Match / No Match](https://docs.didit.me/es/core-technology/database-validation/database-validation-warnings.md) que hayas configurado pueden sobrescribirlo.

**`MATCH`**: el registro confirmó la identidad y todos los campos comprobados coincidieron.

```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`**: el registro no devolvió ninguna coincidencia para los datos 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`**: la puntuación de coincidencia facial quedó por debajo del umbral de aceptación; la persona de la selfie no es la misma que la de la foto del 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`**: no se pudo procesar la selfie (vacía, sin rostro, de baja calidad o el registro no pudo leerla). Pide al usuario que vuelva a tomar la selfie.

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

## Datos devueltos

Los campos exactos que aparecen en `source_data` dependen de lo que devuelva el registro. El ejemplo generado para `zaf_criminal_face_screening` documenta actualmente esta estructura normalizada:

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

## Precios y SLA

Las consultas de Sudáfrica - Análisis de antecedentes penales mediante reconocimiento facial solo se facturan cuando Didit recibe un resultado concluyente de la fuente de validación.

* **Precio por consulta:** \$8.00 USD.
* **Facturación:** por consulta exitosa. No se te cobra cuando el registro no está disponible, cuando faltan campos obligatorios o cuando la solicitud se rechaza antes de llegar a la fuente.
* **Latencia:** p95 típico \< 2 s.
* **Disponibilidad:** 99.9% por trimestre por parte de Didit; la disponibilidad de la fuente externa varía según el país y el conjunto de datos.

## Sigue leyendo

* [Descripción general de la validación de bases de datos de Sudáfrica](https://docs.didit.me/api-reference/database-validation/south-africa.md)
* [Descripción general de la validación de bases de datos](https://docs.didit.me/es/core-technology/database-validation/overview.md)
* [Códigos de resultado](https://docs.didit.me/es/core-technology/database-validation/database-validation-outcome-codes.md)


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