> For the complete documentation index, see [llms.txt](https://docs.facephi.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.facephi.com/docs.facephi-pt-br/api-rest/identity-api/identity-api-reference/onboarding/civil-registry/dha/crear-cliente.md).

# Criar cliente

Permite criar um cliente antes de realizar qualquer uma das verificações e validações do consumidor no registro **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 conforme aparece no seu Documento de identidade.                                                                                               |
| `middle_name`          | string  | **Sim**     | Segundo nome do cliente conforme aparece no seu Documento de identidade.                                                                                       |
| `last_name`            | string  | **Sim**     | Sobrenome do cliente conforme aparece no seu Documento de identidade.                                                                                          |
| `email`                | string  | **Sim**     | Endereço de e-mail do cliente. Deve ter o formato `ejemplo@123.com`                                                                                            |
| `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 da Aplicação e as Verificações que estão sendo realizadas.                                                   |

#### Exemplo de solicitação

```bash
curl --location '{IDENTITY_API_BASE_URL}/civil-registry/dha/customers' \\
--data-raw '{
    "id_type": "id_number",
    "id_number": "9999999999999",
    "client_reference": "clientnumber1",
    "email": "walter.w@facephi.com",
    "first_name": "Walter",
    "middle_name": "Hartwell",
    "last_name": "White",
    "popi": true,
    "terms_and_conditions": true,
    "country": null
}' \\
--header 'x-api-key: {API_KEY}'
```

### Respostas

#### `200` Sucesso

#### Exemplo de resposta

```json
{
    "id": "16cd33d2-cf0a-66ad-8150-cb39e9b9ff27",
    "client_reference": "clientnumber1",
    "popi": null,
    "terms_and_conditions": null,
    "email": "walter.w@facephi.com",
    "id_number": "9999999999999",
    "first_name": "Walter",
    "middle_name": "Hartwell",
    "last_name": "White",
    "full_name": "Walter Hartwell White",
    "id_type": "id_number",
    "country": null,
    "initials": "WHW"
}
```

#### `400` Requisição inválida

```json
{
  "status": 400,
  "title": "Bad Request",
  "detail": "Invalid request.",
  "type": "https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/400",
  "errors": []
}
```

#### `401` Não autorizado

```json
{
  "message": "Unauthorized"
}
```

#### `403` Proibido

```json
{
  "Message": "User is not authorized to access this resource with an explicit deny"
}
```

#### `502` Gateway inválido

```json
{
  "status": 502,
  "title": "Bad Gateway",
  "detail": "Server got an invalid response.",
  "type": "https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/502"
}
```

#### `504` Tempo esgotado no gateway

```json
{
  "message": "Endpoint request timed out"
}
```
