1. Get Started
iCredit
  • Credit
    • Get Started
      • About
      • Authentication
      • Error Messages
    • Get Started APP
      • About
      • Authentication
      • Error Messages
      • Webhooks
    • Enums
      • ClientTypeEnum
      • ClientFilesStatusEnum
      • BankAccountTypeEnum
      • OperationFrequencyEnum
      • OperationModalityEnum
      • OperationCalcMethodEnum
      • SignAsEnum
    • Api Reference
      • Auth
        • Login
        • refresh
        • logout
        • update-password
      • Users
      • 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
        • sync
        • Ionboarding resync
      • Requests
        • Options
          • update
        • Files
          • search
          • find
          • create
          • update
          • delete
          • download
        • Listar Requests / obter request_uuid
        • Consultar detalhe da Request / capturar option
        • 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
        • review file
        • request documents
        • resend documents
        • Get Request Participants
        • Add Participant
        • Add New Spouse
        • Add Existing Spouse
        • Check Request Readiness
        • client-reject
        • get requests
      • Operations
        • required-fields
        • search
        • find
        • audit
        • create
        • simulate
        • generic-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
        • Listar arquivos da operação
        • Get Operation Participants
        • Add Participant
        • Edit Participants
        • Delete Participants
        • Add New Spouse
        • Select Existing Spouse
        • Remover garantidor da operação
        • signature-sync
      • Credit Analysis
        • Serasa
          • analysis
          • new-report
      • Supplires
        • find
        • search
        • create
        • send-or-update-public-key
        • delete
        • inactive
        • set-status
      • System Settings
        • list
        • search
        • find
        • create
        • update
        • delete
        • activate
        • audits
  • Credit V2
    • Dashboard
      • home-admin
    • Monitoramento
      • check
      • documentation
      • signature-diagnosis
    • Operações
      • Arquivos
        • files
        • list-by-operation
      • Assinaturas e documentos
        • add-signatories
        • cancel-document
        • finish-document
        • resend-notification
        • remove-signatory
        • update-deadline-atIn-document
        • get_file_events_operation
      • Cônjuges
        • Criar cônjuge na operação
      • Fluxo e status
        • status-labels
        • approval
        • endorsement
        • grant
        • reprocess-current-status
        • change-status
      • Garantidores
        • Listar garantidores da operação
        • Listar clientes elegíveis para garantidores da operação
      • Geral
        • Criar operação com participantes e garantidores
        • update
      • Participantes
        • Listar candidatos a participantes
        • Listar participantes da operação
        • Listar candidatos a participantes da operação
        • Listar clientes elegíveis para garantidores da operação
    • Organizações
      • create
      • get form options
      • contract-by-organization
      • get organization
    • Requests
      • Cônjuges
        • Criar Person e relacionamento conjugal
        • Anexar cônjuge existente
      • Documentos
        • review-files
        • resend-documents
      • Fluxo e status
        • QA-01 — Confirmar catálogo de status V2
        • accept
        • generate-operation
        • check-readiness
        • reject
        • send-to-client-approval
        • change-status
      • Garantidores
        • REQ-03 — Listar Guarantors
        • REQ-03 — Criar candidato a Guarantor
        • REQ-03 — Clients elegíveis para Guarantor
        • REQ-03 — Vincular Client existente
        • REQ-03 — Suggestions de Guarantors
        • REQ-03 — Remover Guarantor
        • REQ-03 — Aprovar Guarantor
        • REQ-03 — Rejeitar Guarantor
        • REQ-03 — Solicitar correção do Guarantor
        • REQ-03 — Reenviar Guarantor para revisão
      • Geral
        • Criar Request
        • update
        • create-client
        • create-passing-the-client
        • search
        • request details
        • set-calculation-method
        • set-endorser
        • set-fund
        • handle-option
      • Participantes
        • Listar participantes da Request
        • Criar ou reativar participante
        • Listar candidatos a participante da Request
        • Remover participante da Request
        • Alterar papel do participante
    • Simulações
      • preview
      • Create Operation
      • export pdf
    • Timeline
      • show
    • Tipos de arquivo
      • QA-09 — Selecionar tipo de documento requestable
      • Create File Type
      • delete file type
      • find file type
      • update file type
    • Tipos de contrato
      • list
      • create
      • find
      • update
      • approve
      • effective-settings
      • update-link-organization
      • link-organization
      • request-revision
      • submit-validation
    • CADOC
      • Arquivos
        • Transmissões STA
          • Listar transmissões STA do arquivo
          • Consultar transmissão STA
        • Validações oficiais
          • Listar validações oficiais do arquivo
          • Download de artefato (audita)
        • Buscar arquivos CADOC
        • Consultar arquivo
        • download files
      • CADOCs
        • 200 — Buscar CADOCs
        • Consultar CADOC
      • Configurações
        • 200 — Buscar configurações
        • Consultar configuração
      • Entidades reportantes
        • 200 — Listar entidades reportantes
        • Endossantes elegíveis
        • Readiness regulatório
      • Lotes de geração
        • 200 — Buscar lotes de geração
        • Consultar lote
      • Mapeamentos de produtos
        • 200 — Buscar mapeamentos
        • Consultar mapeamento
      • Perfis regulatórios
        • 200 — Buscar perfis regulatórios
        • Consultar perfil regulatório
    • Witness
      • Create Witness
  1. Get Started

Error Messages

A API de Crédito segue o padrão de HTTP Status Codes. Os erros 4xx ocorrem quando há algo de errado na requisição que o cliente está enviando para para a API. Já os erros 5xx, são erros inesperados que podem ocorrer em nossos servidores.

4×× Client Error#

❗
Sempre verifique o BODY da resposta.
O retorno da requisição mostrará o motivo pelo qual a requisição não foi aceita pelos servidores da API.
🚧
Erro de CORS (Cross-Origin Resource Sharing).
O retorno da requisição mostrará o motivo pelo qual a requisição não foi aceita pelos servidores da API.
CódigoReferênciaExplicação
400BAD REQUESTO servidor não processará a solicitação devido a algo que é percebido como sendo um erro do cliente. Este é um erro genérico.
401UNAUTHORIZEDO servidor não autorizou a requisição. Access Token inválido.
403FORBIDDENO servidor não autorizou a requisição. O Access Token não possui permissão para acessar o recurso.
404NOT FOUNDO servidor não encontrou o recurso ou não está disposto a divulgar sua existência.
422UNPROCESSABLE ENTITYO servidor não conseguiu processar as informações contidas na requisição.

Exemplo de retorno de requisição inválida#

{
    "message": "O campo taxid_number é obrigatório",
    "details": null
}

5×× Client Error#

CódigoReferênciaExplicação
500INTERNAL SERVER ERROROcorreu um erro interno inesperado.
Se você estiver com problemas relacionados à integração, entre em contato conosco através do developers@inovanti.com.br o máximo de detalhes possível. Informações que nos ajudam a debugar a sua requisição:
Ambiente: sandbox ou produção
Conta
E-mail do operador
Path da requisição
Método da requisição
Código HTTP de erro
JSON enviado
JSON recebido
UUID se aplicado
Outras informações que possam auxliar no debug do erro
Modificado em 2025-03-21 09:14:06
Página anterior
Authentication
Próxima página
About
Built with