> For the complete documentation index, see [llms.txt](https://docs.fidelimax.com.br/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.fidelimax.com.br/clientes/cadastro-de-cliente-via-api.md).

# Cadastro de Clientes

O Endpoint **"CadastrarConsumidor"** é utilizado para cadastrar novos consumidores (clientes) no programa de fidelidade via API. Geralmente é o endpoint mais utilizado e deve seguir a estrutura abaixo.

{% hint style="info" %}
Atenção: Para utilizar a API da Fidelimax você precisará de um Token. \
\
Para obter seu token de integração vá em seu **Painel de Controle**, no menu esquerdo selecione **Integrações** e então escolha a opção **API da Fidelimax**. Clique em Quero **Integrar** e copie seu token.

O uso da API está disponível no Plano Max e no Plano Corp.
{% endhint %}

## CadastrarConsumidor

<mark style="color:green;">`POST`</mark> `https://api.fidelimax.com.br/api/Integracao/CadastrarConsumidor`

Exemplo no POSTMAN - <https://www.postman.com/fidelimax/workspace/fidelimax-api-1-0/request/18773698-61946aed-281d-486e-9384-c429420ffff1>

#### Headers

| Name                                           | Type   | Description                                     |
| ---------------------------------------------- | ------ | ----------------------------------------------- |
| AuthToken<mark style="color:red;">\*</mark>    | string | Token de Integração que esta na sua plataforma. |
| Content-Type<mark style="color:red;">\*</mark> | String | application/json                                |

#### Request Body

| Name                 | Type    | Description                                                                                                                                                                                         |
| -------------------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| nome                 | string  | Nome do Consumidor                                                                                                                                                                                  |
| cpf                  | string  | CPF do Consumidor, o CPF é usado como chave para realizar a atualização. Campo obrigatório se  telefone ou cartao não forem enviados                                                                |
| sexo                 | string  | Sexo do Consumidor, Masculino e Feminino                                                                                                                                                            |
| nascimento           | string  | Data de nascimento do Consumidor, formato dd/mm/yyyy                                                                                                                                                |
| email                | string  | E-mail do consumidor                                                                                                                                                                                |
| telefone             | string  | Telefone do Consumidor, formato (11)99999-9999. Campo obrigatório se o cpf ou cartao não forem enviados                                                                                             |
| saldo                | integer | Saldo em pontos inicial que o consumidor pode iniciar                                                                                                                                               |
| endereco             | Object  | Objeto para conter o endereço do cliente. O cadastro do endereço do cliente irá para uma fila que checará o CEP do endereço do cliente para depois vincular o endereço a este cliente.              |
| endereco.cep         | string  | CEP de endereço do consumidor. Obrigatório caso o objeto de endereço seja enviado.                                                                                                                  |
| endereco.numero      | string  | Número de endereço do consumidor. Até 10 caracteres                                                                                                                                                 |
| endereco.rua         | string  | Rua de endereço do consumidor. Até 115 caracteres                                                                                                                                                   |
| endereco.bairro      | string  | Bairro de endereço do consumidor. Até 115 caracteres                                                                                                                                                |
| endereco.complemento | string  | Complemento de endereço do consumidor. Até 100 caracteres                                                                                                                                           |
| senha                | string  | <p>Senha do Consumidor para acessar o programa de fidelidade. <br><br>Obs. Esta senha só será cadastrada se o programa de fidelidade estiver configurado/habilitado paraa utilização de senhas.</p> |
| tag                  | string  | Associe uma nova tag ao consumidor. A Tag deve ser previamente cadastrada pelo painel de controle, cada consumidor pode ter até 3 tags                                                              |

{% tabs %}
{% tab title="200 cartao\_duplicado - Indica que o cartão vinculado a esse consumidor já não foi cadastrado a outro consumidor do mesmo programa de fidelidade.
CodigoResposta - Identificação numérica da resposta
MensagemErro - Mensagem retornada pela API, quando há uma resposta diferente de OK" %}

```json
{    
    "cartao_duplicado": false,
    "CodigoResposta": 100,
    "MensagemErro": null
}
```

{% endtab %}
{% endtabs %}

{% hint style="info" %}
Em caso de dúvidas de como utilizar a API ou precisar de suporte técnico, acione nosso time de ajuda em [https://www.fidelimax.com/br/ajuda](https://www.fidelimax.com.br/ajuda)
{% endhint %}