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

# Glossário

> Os termos usados nesta documentação.

| Termo | Significado |
| - | - |
| **Allowlist de entrada** | Lista de IPs de onde o parceiro chama a API. O parceiro informa os IPs dele e a Wincred os libera. Chamada de outro IP recebe `403` sem envelope de erro |
| **Averbação** | Registro do desconto das parcelas na folha de pagamento do cliente. Acontece depois da criação do contrato e antes do desembolso |
| **Assinatura do webhook** | O header `X-Wincred-Signature`, um HMAC-SHA256 do corpo do aviso. É como o parceiro confirma que o aviso veio da Wincred. Veja [Assinatura do webhook](https://docs.wincred.digital/api-do-parceiro/assinatura.md) |
| **CCB** | Cédula de Crédito Bancário, o título que formaliza o empréstimo. O número dela vem em `ccb_number` a partir de `contract_created` |
| **Chave de API** | Credencial do parceiro, enviada em `Authorization: Bearer <chave do parceiro>`. Veja [Autenticação](https://docs.wincred.digital/api-do-parceiro/autenticacao.md) |
| **Consignado CLT** | Empréstimo com as parcelas descontadas diretamente do salário de quem trabalha com carteira assinada |
| **Contratação Ativa** | Modalidade de contratação. Veja [Modalidades](https://docs.wincred.digital/inicio/modalidades/visao-geral.md) |
| **Desembolso** | Liberação do dinheiro ao cliente. Na API, o status `loan_disbursed` |
| **Envelope de erro** | O formato único de todo erro da API: `{ "error": { "code", "message", "request_id", ... } }`. Veja [Erros](https://docs.wincred.digital/api-do-parceiro/erros.md) |
| **Evento** | Cada tipo de aviso que a Wincred envia por webhook: `term_signed`, `contract_created`, `loan_disbursed`, `closed` e o `ping` de teste |
| **Hub** | Agrupamento do parceiro com faixa de valor e prazo próprios, por exemplo por condição comercial, produto ou marca. Identificado pelo `hub_code` |
| **Indicação** | O pedido do parceiro para que a Wincred ofereça crédito a um cliente, feito em `POST /referrals`. Abre um processo |
| **KYC** | Verificação da identidade do cliente (*Know Your Customer*), feita na jornada |
| **Leilão** | Modalidade de contratação. Veja [Modalidades](https://docs.wincred.digital/inicio/modalidades/visao-geral.md) |
| **Link da jornada** | O `url` devolvido em `POST /referrals`. É onde o cliente autoriza a consulta, escolhe a proposta e assina. Vale até `expires_at` |
| **Processo** | A contratação aberta por uma indicação, identificada pelo `process_external_id`. Um CPF tem no máximo um processo aberto por parceiro |
| **Proposta** | A oferta de valor e prazo escolhida pelo cliente na jornada. Vem em `proposal` e pode ser diferente do `loan_request` do parceiro |
| **Reset** | Quando o contrato cai no meio da jornada e o processo volta a `term_signed` para o cliente escolher outra proposta |
| **Termo de autorização** | O termo em que o cliente autoriza a consulta dos dados dele para a oferta de crédito. A assinatura gera o evento `term_signed` |
| **Webhook** | O `POST` que a Wincred faz na URL do parceiro a cada etapa da indicação. Veja [Webhooks](https://docs.wincred.digital/api-do-parceiro/webhooks.md) |
| **`X-Request-Id`** | Identificador de cada requisição. Volta em toda resposta; informe-o ao suporte |


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