> ## Documentation Index
> Fetch the complete documentation index at: https://docs.wincred.digital/llms.txt
> Use this file to discover all available pages before exploring further.

# 02 - Simular Propostas

O segundo passo na contratação ativa é simular propostas de crédito consignado com base nos vínculo empregatício escolhido pelo trabalhador.

A Wincred disponibiliza um endpoint **assíncrono** que recebe os dados do vínculo selecionado e que abstrai a complexidade, realizando:

* Consulta de dados do trabalhador.
* Simula propostas de crédito consignado conforme os parâmetros informados.

***

## Endpoint

<ParamField path="POST" type="endpoint">
  `/api/v1/e-consignado/propostas/simulacoes`
</ParamField>

### URL Base

HML: `https://integracao.apidev.wincred.digital`

### Headers

| Header          | Tipo   | Obrigatório | Descrição                      |
| --------------- | ------ | ----------- | ------------------------------ |
| `Content-Type`  | string | Sim         | `application/json`             |
| `Authorization` | string | Sim         | `Bearer {seu_token_de_acesso}` |

***

## Requisição

### Exemplo de Requisição

```bash theme={null}
curl -X POST "https://integracao.apidev.wincred.digital/api/v1/e-consignado/propostas/simulacoes" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer {seu_token_de_acesso}" \
  -d '{
    "idCotacao": "123e4567-e89b-12d3-a456-426614174000",
    "numeroParcelas": 24,
    "valor": 1500.00
    "empresa": { // Dados que retornam da dataprev
        "tipoInscricao": 1,
        "numeroInscricao": "12345678000195",
        "matricula": "123456",
    },
  }'
```

### Parâmetros da Requisição

<ParamField path="idCotacao" type="UUID" required>
  Identificador único da cotação retornado na etapa de consulta de vínculos.
  **Exemplo:** `"123e4567-e89b-12d3-a456-426614174000"`
</ParamField>

<ParamField path="numeroParcelas" type="int" required>
  Número de parcelas desejadas para a simulação de crédito consignado.

  **Exemplo:** `24`
</ParamField>

<ParamField path="valor" type="float" required>
  Valor total do empréstimo para o qual se deseja simular a proposta de crédito consignado.

  **Exemplo:** `1500.00`
</ParamField>

<ParamField path="empresa" type="object" required>
  Objeto contendo os dados da empresa e matrícula do trabalhador, conforme retornado pela DATAPREV na etapa de consulta de vínculos.

  <Expandable title="Propriedades">
    <ParamField path="tipoInscricao" type="int" required>
      Tipo de inscrição da empresa

      <Tip>
        Valores possíveis:

        * `1`: CNPJ
        * `2`: CPF
      </Tip>
    </ParamField>

    <ParamField path="numeroInscricao" type="string" required>
      Número da inscrição da empresa (apenas números)
    </ParamField>

    <ParamField path="matricula" type="string" required>
      Matrícula do trabalhador na empresa
    </ParamField>
  </Expandable>
</ParamField>

***

## Resposta

### Resposta de Sucesso (202 Accepted)

A requisição foi aceita e está sendo processada de forma assíncrona.

```json theme={null}
{
  "idCotacao": "123e4567-e89b-12d3-a456-426614174000",
  "erros": []
}
```

<Info>Caso algum erro aconteça na requisição, uma lista de erros será retornada.[**documentação de erros**](/e-consignado/casos-de-uso/contratação-ativa/erros/1-introducao)                     </Info>

### Resposta de Erro (404 Not Found)

```json theme={null}
{
    "erros": [
        {
            "codigo": "WIN_P00003",
            "msg": "Proposta não encontrada"
        }
    ]
}
```

## Respostas de erro comuns no sistema

### Resposta de Erro (4xx Bad Request)

```json theme={null}
{
    "erros": [
        {
            "codigo": "WIN_xxxx",
            "msg": "MENSGEM DE ERRO DESCRITIVA"
        }
    ]
}
```

### Resposta de Erro (422 Unprocessable Entity)

```json theme={null}
{
  "erros": [
    {
      "codigo": "WIN_XXXX",
      "msg": "Proposta não encontrada"
    }
  ]
}
```

### Resposta de Erro (401 Unauthorized)

```json theme={null}
{
  "code": 401,
  "message": ""
}
```

<Warning>
  **Esse payload é um retorno da API de autenticação e não da API do sistema.**

  Esta resposta pode indicar que o token de autenticação fornecido é inválido ou expirou. Verifique se o token está correto e se ainda é válido.
</Warning>

### Resposta de Erro (500 Unauthorized)

```json theme={null}
{
  "code": 500,
  "message": ""
}
```

## Códigos de Status

| Código | Descrição                            |
| ------ | ------------------------------------ |
| `202`  | Requisição aceita e em processamento |
| `401`  | Não autorizado - token inválido      |
| `422`  | Erro de validação dos dados          |
| `429`  | Muitas requisições, limite atingido  |
| `500`  | Erro interno do servidor             |

***

# Próximos Passos

<Steps>
  <Step title="Aguardar processamento">
    A consulta é processada de forma assíncrona. Aguarde alguns segundos antes de consultar o resultado.
  </Step>

  <Step title="Consultar resultado">
    Utilize o webhook para obter o resultado da simulação de propostas.
  </Step>

  <Step title="Comparar propostas">
    Com as propostas retornadas, você pode prosseguir para a próxima etapa de escolher a melhor opção de crédito consignado.
  </Step>
</Steps>

<Card title="Próximo: Consultar Status" icon="arrow-right" href="/e-consignado/casos-de-uso/contratação-ativa/webhooks-e-eventos/02-evento-de-propostas-simuladas">
  Consultar o status e resultado da simulação de propostas
</Card>

***