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

> Validação de base de dados na África do Sul via Didit. Consulta oficial por $1.28 por chamada, sem contratos nem mínimos.

Verifica as imagens de impressões digitais fornecidas contra o registo de impressões digitais do Department of Home Affairs. A Didit disponibiliza este serviço através de `POST /v3/database-validation/`, para que possa verificar os dados enviados contra a fonte oficial e receber resultados de correspondência normalizados.

## Cobertura

* **Cobertura:** —
* **País:** África do Sul
* **ID do serviço:** `zaf_dha_fingerprint_match`
* **Domínio de dados:** Biométrico
* **Categoria:** Governo

## Entradas

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

* **Entradas obrigatórias:** `national_id`, `right_thumb`, `left_thumb`
* **Entradas opcionais:** `vendor_data`
* **Consentimento:** Obrigatório
* **Disponibilidade no fluxo:** Apenas na API autónoma
* **Cobertura:** —
* **Preço:** \$1.28 por consulta bem-sucedida

Este serviço pede `right_thumb` e `left_thumb`, valores que um passo de fluxo não produz. Por isso, só está disponível na API autónoma, onde você fornece os valores diretamente.

## 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\_dha\_fingerprint\_match)

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

Exemplo: `zaf_dha_fingerprint_match`

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

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

Exemplo: `true`

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

Número de identificação nacional para este serviço.

Exemplo: `SAMPLE-NID-12345`

**right\_thumb** `string` *required* (default: RIGHT\_THUMB\_TEMPLATE)

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

Exemplo: `RIGHT_THUMB_TEMPLATE`

**left\_thumb** `string` *required* (default: LEFT\_THUMB\_TEMPLATE)

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

Exemplo: `LEFT_THUMB_TEMPLATE`

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

A sua referência estável para esta pessoa, como o ID interno do utilizador. A Didit usa-a para associar as verificações autónomas ao mesmo utilizador final e reduzir o ruído na 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 faturados.

## Como o chamar

```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_dha_fingerprint_match" \
  -F "vendor_data=user-1234" \
  -F "consent=true" \
  -F "national_id=SAMPLE-NID-12345" \
  -F "right_thumb=RIGHT_THUMB_TEMPLATE" \
  -F "left_thumb=LEFT_THUMB_TEMPLATE"
```

Todas as chamadas bem-sucedidas devolvem HTTP `200`. O campo **`outcome_code`** indica o que realmente aconteceu, distinguindo, por exemplo, uma incompatibilidade biométrica real (`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 e 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 coincidiram.

```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_dha_fingerprint_match",
      "service_name": "South Africa - DHA Fingerprint Match",
      "source_data": {
        "identification_number": "SAMPLE-ID-12345"
      },
      "validation": {
        "identification_number": "full_match"
      }
    }
  ]
}
```

**`NO_MATCH`**: O registo não devolveu qualquer 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_dha_fingerprint_match",
      "service_name": "South Africa - DHA Fingerprint Match",
      "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_dha_fingerprint_match` documenta atualmente esta estrutura normalizada:

* `identification_number`

## Preços e SLAs

As consultas de correspondência de impressões digitais do DHA da África do Sul só são faturadas quando a Didit recebe um resultado conclusivo da fonte de validação.

* **Preço por chamada:** \$1.28 USD.
* **Faturação:** por consulta bem-sucedida. Não são cobrados os casos em que o registo está inacessível, em que faltam campos obrigatórios ou em que o pedido é rejeitado antes de chegar à fonte.
* **Latência:** p95 típico \< 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 de Validação de base de dados para a África do Sul](https://docs.didit.me/api-reference/database-validation/south-africa.md)
* [Visão geral de 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.