Fluxo de Chamadas da API

Sequência recomendada de chamadas para operar uma operação de crédito, do simulador ao desembolso.

Toda chamada abaixo pressupõe um token de acesso válido, obtido via POST /auth/token.

Etapa 1 — Simulação e originação

#PassoChamada
1Simular a operação e apresentar as condições ao cliente (taxa, CET, IOF, parcelas).POST /simulations
2Criar a operação de crédito com os dados definitivos do tomador e do desembolso.POST /credit-operations
3Enviar os documentos do tomador (identidade, comprovantes, selfie).POST /credit-operations/{externalContractId}/documents
4Consultar o status atual da operação a qualquer momento.GET /credit-operations/{externalContractId}

Etapa 2 — Aprovação, formalização e desembolso

#PassoChamada
5Aprovar a operação (transição RECEIVEDAPPROVED).POST /credit-operations/{externalContractId}/approve
6Gerar a CCB (Cédula de Crédito Bancário) da operação aprovada.POST /credit-operations/{externalContractId}/ccb
7Solicitar a assinatura eletrônica da CCB pelo tomador.POST /credit-operations/{externalContractId}/ccb/sign
8Solicitar o desembolso, após a CCB assinada.POST /credit-operations/{externalContractId}/disbursement

Observações

  • A simulação (POST /simulations) é stateless: não cria nenhum registro, serve apenas para calcular condições antes de o cliente decidir contratar.
  • Cada transição de estado (aprovação, geração de CCB, assinatura, desembolso) tem pré-requisitos de status — veja as regras completas em Máquina de Estados.
  • Em vez de consultar (GET) repetidamente para saber quando uma etapa concluiu, prefira assinar os webhooks de eventos — cada mudança de status dispara uma notificação.
  • A qualquer momento antes do desembolso, a operação pode ser cancelada via POST /credit-operations/{externalContractId}/cancel.
  • O KYC pode ser solicitado (POST .../kyc) e consultado (GET .../kyc) de forma independente do fluxo principal — veja KYC.

Did this page help you?