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

# Registo de Empresas da África do Sul - API de Consulta

> Consulta ao registo de empresas da África do Sul pela Didit, com dados oficiais. Desde $0.75 por chamada, sem contratos nem mínimos.

Pesquisa uma empresa sul-africana pelo número de registo no registo comercial da CIPC. A Didit disponibiliza este serviço através de `POST /v3/database-validation/`, para que possa validar os dados submetidos contra a fonte oficial e receber resultados de correspondência normalizados.

## Cobertura

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

## Entradas

| Campo | Obrigatório | Exemplo |
| - | -: | - |
| `company_registration_number` | Sim | `REG-123456` |
| `company_name` | Não | `Sample Company LLC` |
| `vendor_data` | Não | `user-1234` |

* **Entradas obrigatórias:** `company_registration_number`
* **Entradas opcionais:** `company_name`, `vendor_data`
* **Consentimento:** Não é necessário
* **Disponibilidade no fluxo:** Disponível em fluxo com mapeamento de campos
* **Cobertura:** —
* **Preço:** \$0.75 por consulta bem-sucedida

Num fluxo, o `company_registration_number` não aparece impresso num documento de identificação, pelo que nenhum passo o produz por si só. Recolha-o a partir de uma resposta a um questionário, de um campo extraído pelo Document AI ou de um valor que envie ao criar a sessão, e mapeie-o no passo de Validação de base de dados. Até ser mapeado, o editor de fluxos mostra este serviço desativado e indica o campo em falta. Em execução, um campo em falta faz com que a verificação seja ignorada antes de qualquer consulta, pelo que nunca é faturada uma base de dados que não pôde ser consultada.

## Parâmetros do corpo

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

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

Exemplo: `ZAF`

**services** `string` *required* (default: zaf\_company\_registry)

Matriz 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_company_registry`

**company\_registration\_number** `string` *required* (default: REG-123456)

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

Exemplo: `REG-123456`

**company\_name** `string`

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

Exemplo: `Sample Company LLC`

**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 autónomas 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 faturados.

## Como efetuar 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_company_registry" \
  -F "vendor_data=user-1234" \
  -F "company_registration_number=REG-123456"
```

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 [ações de Correspondência parcial / Sem correspondência](https://docs.didit.me/pt/core-technology/database-validation/database-validation-warnings.md) que tiver configurado 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_company_registry",
      "service_name": "South Africa - Company Registry Lookup",
      "source_data": {},
      "validation": {
        "identification_number": "full_match"
      }
    }
  ]
}
```

**`NO_MATCH`** — O registo não devolveu nenhuma correspondência para os dados submetidos.

```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_company_registry",
      "service_name": "South Africa - Company Registry Lookup",
      "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_company_registry` documenta atualmente esta estrutura normalizada:

* Varia consoante a resposta do registo.

## Preços e SLAs

As consultas de Pesquisa no registo de empresas da África do Sul só são faturadas quando a Didit recebe um resultado conclusivo da fonte de validação.

* **Preço por chamada:** \$0.75 USD.
* **Faturação:** por consulta bem-sucedida. Não é faturado 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 \< 2 s.
* **Disponibilidade:** 99.9% por trimestre do lado da Didit; a disponibilidade das fontes 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.