1. Credit v2
iCredit
  • Credit
    • Get Started
      • About
      • Authentication
      • Error Messages
    • Get Started APP
      • About
      • Authentication
      • Error Messages
      • Webhooks
    • Api Reference
      • Auth
        • login
        • refresh
        • logout
        • update-password
      • Users
        • me
      • Clients
        • Banks
          • list
          • search
          • find
          • create
          • update
          • delete
        • Files
          • Types
            • search
            • list
            • fInd
            • create
            • update
            • delete
          • create
          • fInd
          • download
          • search
          • delete
        • search
        • fInd
        • audits
        • list-by-organization
        • get-me
        • required-fields
        • basic-create
        • create
        • create-legal
        • update
        • update-legal
        • get-client-banks
        • get-client-operations
        • get-client-requests
        • get-client-files
        • finalize-registration
        • change-status
        • change-client-group
        • change-client-user
        • reset-password
        • update-client-representative
        • credit-analysis-validation
        • additional-information
        • create-client-from-onboarding
        • client-validation
      • Requests
        • Options
          • update
        • Files
          • search
          • find
          • create
          • update
          • delete
          • download
        • search
        • find
        • create
        • create-client-pj
        • create-client-pf
        • create-request-passing-client
        • update
        • delete
        • send-to-client-approval
        • handle-change-fund
        • handle-change-endorser
        • reject
        • accept
      • Operations
        • required-fields
        • search
        • find
        • audit
        • create
        • simulate
        • update
        • delete
        • files
        • resend-notification
        • update-deadline-at
        • add-signatories
        • remove-signatory
        • cancel-document
        • finish-document
        • reprocess-current-status
        • change-status
        • update-status-to-grant
        • update-status-to-endorsement
        • update-status-to-approval
        • operation-status
      • Credit Analysis
        • Serasa
          • analysis
          • new-report
      • Supplires
        • find
        • search
        • create
        • send-or-update-public-key
        • delete
        • inactive
        • set-status
    • Enums
      • ClientTypeEnum
      • ClientFilesStatusEnum
      • BankAccountTypeEnum
      • OperationFrequencyEnum
      • OperationModalityEnum
      • OperationCalcMethodEnum
      • SignAsEnum
  • Credit v2
    • Organizations
      • create
      • contract-by-organization
    • Timelines
      • show
    • Operation
      • status-labels
      • create
      • update
      • change-status
      • approval
      • grant
      • endorsement
      • reprocess-current-status
      • list-by-operation
      • files
      • resend-notification
      • update-deadline-atIn-document
      • add-signatories
      • remove-signatory
      • cancel-document
      • finish-document
    • Requests
      • status-labels
      • create
      • create-client
      • create-passing-the-client
      • update
      • set-fund
      • set-calculation-method
      • set-endorser
      • handle-option
      • change-status
      • send-to-client-approval
      • reject
      • accept
      • generate-operation
    • Contract Type
      • list
      • find
      • effective-settings
      • create
      • update
      • submit-validation
      • approve
      • request-revision
      • link-organization
      • update-link-organization
  1. Credit v2

Organizations

Doc: Migração de Etapas (V1 ➡️ V2)#

Na versão 2 (V2) da API, as configurações da Organização deixaram de ser chamadas de forma granular. O payload foi unificado para espelhar a nova UI, agrupando os submódulos em 5 Macro-Etapas.
A etapa celcoin foi descontinuada como um endpoint isolado e as suas configurações agora devem ser enviadas dentro de endorser.additional_settings.CELCOIN.

Tabela de Mapeamento (De -> Para)#

Etapa Anterior (V1)➡️Nova Macro-Etapa (V2)Verbo HTTPAção no Backend
start, clients, requests➡️identificationPOST / PUTAtualiza dados básicos, visão do cliente e notificações de requisição.
operations, commission, credit_analysis➡️operationPUTAtualiza taxas, comissões, multas, regras da operação e análise de crédito.
endorser, webhooks, qprof (+ celcoin)➡️integrationsPUTAtualiza integrações externas, QProf, Webhooks e Endossantes (incluindo as configs adicionais).
signatures, emails, onboarding, simplified_contract➡️communicationPUTAtualiza APIs de assinatura, disparos de e-mail, onboarding background e contrato simplificado.
whitelabel_custom➡️whitelabelPUTAtualiza domínios, temas, logos e aparência geral do app/web.
(Nenhuma - Apenas Leitura)➡️revisionGETUtilizar a rota GET /organizations/{uuid} para buscar o resumo completo da organização.

💡 Comportamento de Resposta (V2)#

Diferente da V1 que retornava 204 No Content, agora os endpoints de POST (create) e PUT (update) retornam um status 200/201 contendo o progresso atualizado da configuração para facilitar a gestão de estado no Front-end:
{
  "message": "Etapa salva com sucesso.",
  "progress": {
    "percentage": 80,
    "pendencies": [
      "Definir logo (tema escuro) enviado"
    ],
    "checklist": {
      "identification": true,
      "operation": true,
      "integrations": true,
      "communication": true,
      "whitelabel": false
    }
  }
}
Modificado em 2026-05-18 14:13:35
Página anterior
SignAsEnum
Próxima página
create
Built with