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

# E-Consignado

> A camada técnica do Consignado as a Service — crédito consignado privado via API, do ciclo de proposta ao pagamento 

## Sobre o produto

O E-Consignado é a camada de integração técnica do produto **Consignado as a Service** da Zipdin: uma
operação completa de crédito consignado privado que a Zipdin monta e opera para o seu negócio, para
que você ofereça crédito aos seus funcionários ou clientes sem construir uma operação de crédito do zero.

**Para quem é:** empresas, correspondentes bancários ou fintechs que já têm uma base de funcionários/clientes
elegíveis e querem oferecer consignado privado sob a própria marca ou através da Zipdin.

**Como funciona comercialmente:** a Zipdin oferece o produto de forma **modular ou completa** — você pode
contratar só o motor de crédito, só o servicing, ou a operação inteira (política de crédito e cobrança,
motor de crédito, atendimento multicanal, formalização e cessão bancária, gestão de carteira). Também existe
opção de **white-label**, em que a operação roda com a marca do parceiro.

Esta página documenta especificamente a **API do ciclo de proposta** (criar, simular, formalizar, pagar) —
a parte que se integra diretamente ao seu sistema. Os demais módulos (política de crédito, servicing,
white-label) são configurados junto ao time comercial da Zipdin.

<Info>
  Todos os endpoints requerem autenticação via **Bearer token** no header `Authorization`.
  Consulte o [guia de autenticação](/authentication) para obter suas credenciais e gerar um token.
</Info>

## Fluxo de Integração

<Steps>
  <Step title="[Criar Proposta](https://app.mintlify.com/zipdin-2ea7efb5/zipdin-2ea7efb5/~/2d5ca0da-68f8-4232-9fe8-307eb5c45d9a)">
    Envie os dados do funcionário e valor desejado. A análise de crédito é automática.
  </Step>

  <Step title="Simulação">
    Após aprovação, simule as condições (parcela, taxa, CET) para apresentar ao cliente.
  </Step>

  <Step title="Formalização">
    Inicie a assinatura digital do contrato. O cliente assina via link (SMS/WhatsApp).
  </Step>

  <Step title="Pagamento">
    Após formalização e averbação, o valor é depositado automaticamente na conta do cliente.
  </Step>
</Steps>

## Endpoints Disponíveis

| Ação             | Método | Endpoint                          |
| ---------------- | :----: | --------------------------------- |
| Criar proposta   | `POST` | `/api/v1/propostas`               |
| Simular          | `POST` | `/api/v1/propostas/{id}/simular`  |
| Consultar status |  `GET` | `/api/v1/propostas/{id}`          |
| Cancelar         | `POST` | `/api/v1/propostas/{id}/cancelar` |

## Eventos (Webhooks)

Receba notificações em tempo real em cada etapa do fluxo (proposta aprovada, formalização concluída, pagamento realizado, entre outros). Veja a lista completa de eventos e como configurar no [guia de webhooks](/guides/webhooks).