Visão geral do fluxo CLT

Esta página mostra a ordem recomendada para integrar o produto Crédito Privado CLT. O fluxo depende do consentimento do cliente antes da simulação e da criação da operação.

Fluxo recomendado

1. Autenticar
2. Configurar webhooks
3. Gerar termo de consentimento
4. Autorizar e acompanhar consentimento
5. Aguardar consulta de margem
6. Consultar configurações/taxas
7. Criar simulação
8. Criar proposta/operação
9. Acompanhar a operação
10. Resolver pendências ou cancelar, quando necessário

Antes de começar

Obtenha um token válido em POST /oauth/token.
Configure os webhooks de consulta/margem e operação.
Prepare sua aplicação para coletar o aceite do cliente.
Armazene o identificador retornado no termo de consentimento.
Avance para simulação somente depois que o fluxo de consentimento/margem permitir.

Passo a passo da integração

Etapa	O que fazer	Endpoint principal	O que guardar
Autenticação	Gerar token de acesso	`POST /oauth/token`	`access_token`
Webhooks	Registrar callbacks de margem e operação	`POST /user/webhook/private-consignment/consult` e `POST /user/webhook/private-consignment/operation`	URLs validadas
Consentimento	Gerar termo para o cliente	`POST /private-consignment/consult`	`id` da consulta
Acompanhamento	Listar/acompanhar termos	`GET /private-consignment/consult`	`status`, `availableMarginValue`
Autorização	Registrar aceite do cliente	`POST /private-consignment/consult/{consult_id}/authorize`	Status do consentimento
Taxas	Consultar configurações disponíveis	`GET /private-consignment/simulation/configs`	`Id` da configuração
Simulação	Calcular proposta CLT	`POST /private-consignment/simulation`	`id_simulation`
Operação	Criar proposta/operação	`POST /private-consignment/operation`	ID da operação
Acompanhamento	Listar ou detalhar operações	Página de operações CLT	Status atual
Pendências	Reapresentar PIX ou documentos	Página de pendências	ID da operação
Cancelamento	Cancelar operação elegível	`POST /private-consignment/operation/{idOperation}/cancel`	Status final

Regra mais importante do CLT

O consentimento é parte obrigatória do fluxo. O identificador gerado no termo deve ser guardado, porque ele conecta as próximas etapas da integração.

Não trate simulação e criação de operação como chamadas isoladas. Elas dependem do andamento do consentimento, da margem e das configurações disponíveis.

Status do consentimento

A página de termo documenta os seguintes status:

WAITING_CONSENT
CONSENT_APPROVED
WAITING_CONSULT
WAITING_CREDIT_ANALYSIS
SUCCESS
FAILED
REJECTED

Use esses status para orientar a experiência do usuário e decidir quando seguir para simulação.

Próximas páginas

Para implementar a autenticação, consulte Autenticação.
Para preparar callbacks, consulte Webhooks.
Para iniciar o fluxo operacional, siga para Termo de Consentimento.

Referência de status e webhooks FGTS

Checklist de integração CLT