Referência de API · Crédito

Contrato de Crédito, campo a campo.

64 endpoints organizados pelo fluxo de integração. Cada endpoint traz método, rota, campos de request e response campo a campo e o exemplo de chamada em cURL, C# e JavaScript, gerados do contrato.

Endpoints

Etapas do fluxo

Linguagens de exemplo

Como usar esta referência. Siga as etapas do fluxo no menu à esquerda. Cada endpoint traz um cURL pronto para colar no terminal ou importar no Postman (Import > Raw text). Use os placeholders {{baseUrl}} e {{token}}, compatíveis com variáveis de environment do Postman.

Copiar para LLM→Baixar referência (.md)→Como importar no Postman→

Baixe a collection e importe no Postman (Import > File). As variáveis {{baseUrl}} e {{token}} já vêm declaradas no nível da collection.

Collection completaConsignado privado e FGTS, em pastas espelhando a documentação.Baixar →Collection do Consignado privadoCadastros, operação e consultas do módulo.Baixar →Collection do FGTSCadastros, operação e consultas do módulo.Baixar →Environment do PostmanAs variáveis fora da collection, para versionar uma sem versionar o token.Baixar →Documentação consolidada para LLMToda a documentação em um arquivo de texto, na ordem da navegação.Baixar →Referência em MarkdownEste contrato, campo a campo, gerado do spec.Baixar →

Guia de importação: Como importar no Postman · Todos os downloads: Downloads

Fluxo de integração

As etapas abaixo seguem a ordem típica de uma integração. Abra uma etapa no menu à esquerda para ver seus endpoints — todos os grupos iniciam fechados.

Etapa	O que fazer	Endpoints
1. Pessoas	Cadastre ou selecione a pessoa (física ou jurídica) titular da operação.	26
2. Simulação	Simule a operação e obtenha parcelas, CET, IOF e custos antes de contratar.	3
3. Operação de crédito	Crie a operação, anexe documentos, envie para aprovação e acompanhe o status.	35