# Consultar

## ConsultarConsumidor

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

Exemplo no POSTMAN - <https://www.postman.com/fidelimax/workspace/fidelimax-api-1-0/request/18773698-e9ff368e-9b42-41e4-bcf7-ec5d3bea2bc9>

#### Headers

| Name                                           | Type   | Description                                                                                                    |
| ---------------------------------------------- | ------ | -------------------------------------------------------------------------------------------------------------- |
| AuthToken<mark style="color:red;">\*</mark>    | string | Token de integração que esta na sua plataforma de controle em Integrações > API da Fidelimax > Quero Integrar. |
| Content-Type<mark style="color:red;">\*</mark> | String | application/json                                                                                               |

#### Request Body

| Name      | Type    | Description                                                                                              |
| --------- | ------- | -------------------------------------------------------------------------------------------------------- |
| cpf       | string  | CPF do Consumidor. Campo obrigatório se os demais campos não forem enviados                              |
| telefone  | string  | Telefone do Consumidor, formato (11)99999-9999. Campo obrigatório se os demais campos não forem enviados |
| categoria | boolean | Quando verdadeiro retorna a categoria atual que o consumidor está enquadrado no programa de fidelidade   |

{% tabs %}
{% tab title="200 consumidor\_existente - Consumidor existe no programa de fidelidade
saldo - Saldo em pontos do consumidor
cashback - Saldo de cashback do consumidor, só é preenchido quando a plataforma de fidelidade está com o cashback habilitado
CodigoResposta - Identificação numérica da resposta
MensagemErro - Mensagem retornada pela API, quando há uma resposta diferente de OK
produtos - Array de objetos contendo informações dos prêmios que o consumidor tem saldo suficiente para resgatar
produtos.nome - Nome do prêmio
produtos.descricao - Descrição detalhada do prêmio
produtos.foto - Url em que a foto do prêmio está armazenada
produtos.identificador - Identificador vinculado ao prêmio
produtos.pontos - Pontos necessários para resgatar o prêmio" %}

```
{    
    "consumidor_existente": true,
    "saldo": 200,
    "cashback": 2.00, 
    "categoria": "Ouro",
    "congelado": false,
    "produtos": [
     {
       "nome": "Prêmio 1",
       "descricao": "Prêmio nos tamanhos P, M e G",
       "foto": "http://url.com.br",
       "identificador": "PremioXXX",
       "pontos": 80
     }
    ],
    "CodigoResposta": 100,
    "MensagemErro": ""
}
```

{% endtab %}
{% endtabs %}


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.fidelimax.com.br/clientes/consultar.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.