For the complete documentation index, see llms.txt. This page is also available as Markdown.

Criar cliente

Permite criar um cliente antes de realizar qualquer uma das verificações e validações do consumidor no cadastro DHA da África do Sul 🇿🇦.

Endpoint

POST /civil-registry/dha/customers

Autenticação

Tipo
Localização
Nome

API Key

Cabeçalho

x-api-key

Corpo da solicitação

Content-Type: application/json

Parâmetros

Parâmetro
Tipo
Obrigatório
Descrição

id_type

string

Sim

Tipo de identificação. Valores possíveis: id_number, passport

id_number

string

Sim

Número de identificação sul-africano de 13 dígitos.

first_name

string

Sim

Nome do cliente tal como aparece no seu Documento de identidade.

middle_name

string

Sim

Segundo nome do cliente tal como aparece no seu Documento de identidade.

last_name

string

Sim

Sobrenome do cliente tal como aparece no seu Documento de identidade.

email

string

Sim

Endereço de e-mail do cliente. Deve ter o formato [email protected]

client_reference

string

Sim

Referência que pode ser usada para identificar e buscar o cliente no seu sistema. Cada cliente deve ter um client_reference único.

country

string

Não

Nacionalidade do cliente.

popi

boolean

Sim

Indica se o cliente deu seu consentimento sob a Lei de Proteção de Informações Pessoais (POPI) para continuar com a coleta de dados e verificações adicionais.

terms_and_conditions

boolean

Sim

Indica se o cliente aceitou os Termos e Condições do Aplicativo e as verificações que estão sendo realizadas.

Exemplo de solicitação

Respostas

200 Sucesso

Exemplo de resposta

400 Requisição inválida

401 Não autorizado

403 Proibido

502 Gateway inválido

504 Gateway Timeout

Atualizado