> ## 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.

# Visão geral

> Indique clientes para o crédito consignado CLT, deixe o cliente concluir a contratação no link seguro da Wincred e acompanhe cada etapa por webhook.

Com a API do Parceiro, você indica clientes para o crédito consignado CLT da Wincred e acompanha a evolução da proposta de forma reativa.

O parceiro não conduz a jornada: simulação, envio de propostas e formalização/assinatura são realizados diretamente pelo cliente no link seguro disponibilizado pela Wincred.

Na prática, o seu sistema atua como um ouvinte: basta registrar o cliente e implementar um endpoint (webhook) para receber notificações em tempo real a cada mudança de status no sistema da Wincred.

```mermaid theme={null}
sequenceDiagram
  participant P as Sistema do parceiro
  participant W as API Wincred
  participant C as Cliente
  P->>W: POST /referrals (CPF e nome)
  W-->>P: 201 com process_external_id e link
  P->>C: Entrega o link
  C->>W: Autoriza a consulta, escolhe a proposta e assina
  W-->>P: Webhook term_signed, contract_created, loan_disbursed ou closed
  P->>W: GET /referrals/{process_external_id}
  W-->>P: Visão atual do processo
```

## As 4 rotas

A API tem quatro rotas na base `/partners/v1`, todas autenticadas por [chave de API](https://docs.wincred.digital/api-do-parceiro/autenticacao.md):

| Método | Rota | Para que serve |
| - | - | - |
| `POST` | [`/referrals`](https://docs.wincred.digital/api-do-parceiro/indicacoes) | Cria a indicação (201) ou devolve o processo já aberto para o CPF (200) |
| `GET` | [`/referrals/{process_external_id}`](https://docs.wincred.digital/api-do-parceiro/consultar) | Devolve a visão atual do processo |
| `GET` | [`/ping`](https://docs.wincred.digital/api-do-parceiro/referencia/conferir-chave-e-hubs) | Valida a chave e devolve os seus hubs, com a faixa de valor e prazo de cada um |
| `POST` | [`/webhooks/test`](https://docs.wincred.digital/api-do-parceiro/referencia/testar-webhook) | Entrega imediatamente um evento `ping` assinado na sua URL de webhook |

Para mantê-lo atualizado, a Wincred envia requisições `POST` para a URL configurada no seu cadastro a cada mudança de status da indicação. Para saber mais sobre os payloads e eventos, consulte [Webhooks](https://docs.wincred.digital/api-do-parceiro/webhooks.md).

> [!NOTE]
>
> A documentação técnica detalhada de cada rota, com schemas, parâmetros, exemplos de requisição e códigos de erro, está disponível em **Referência da API**, no menu lateral.
>
> Já este guia foca nas regras de negócio, no fluxo de integração e nas boas práticas que você precisa conhecer para operar com a Wincred.

## Por onde seguir

> [card] [Início rápido](https://docs.wincred.digital/api-do-parceiro/inicio-rapido.md)
>
> Da chave de dev à primeira indicação, em quatro comandos.

> [card] [Como integrar](https://docs.wincred.digital/api-do-parceiro/como-integrar.md)
>
> O onboarding com o time de integrações e o caminho até a produção.

> [card] [Ciclo de vida](https://docs.wincred.digital/api-do-parceiro/ciclo-de-vida.md)
>
> Os status da indicação e as 5 regras para uma integração previsível.

> [card] [Webhooks](https://docs.wincred.digital/api-do-parceiro/webhooks.md)
>
> Formato, assinatura, retentativas e deduplicação.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.