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

Authentication

Pré requisitos para implementação utilizando API#

Possuir uma chave de API para a Plataforma de Crédito. Para testar a Plataforma, recomendamos o ambiente de Desenvolvimento. O Token de acesso pode ser solicitado em developers@inovanti.com.br.
Ser familiar com APIs RESTful com autenticação OAuth 2.0. Se tiver dúvidas sobre como utilizar as APIs, procure nossa equipe.

Token de Acesso#

Todas as requisições fazem uso do Token de acesso.
Inclua o token no cabeçalho Authorization de suas requisições.
💡
Exemplo: Authorization: Bearer 2f68dbbf-519d-4f01-9636-e2421b68f379

Parâmetros Header#

Em todas as requisições devem ser enviados
Accept: application/json
Content-Type: application/json
X-Client-Domain: SEU_DOMINIO (somente quando for um cadastro tipo cliente acessando)

Base URL#

🔗
Desenvolvimento: https://cred-api-stg.inovanti.tec.br/api/v1
Produção: https://cred-api.inovanti.tec.br/api/v1

Faça um teste de autenticação#

🔗
Faça uma requizição GET para {BASE_URL}/users/me.

Exemplo de Resposta#

Se o token for autorizado, você receberá um resposta como abaixo
{
  "uuid": "116da82e-5385-47d0-8e40-97ef1a274b62",
  "name": "Nome do Usuário",
  "email": "email@email.com.br",
  "taxid_number": "12345678900",
  "username": "12345678900",
  "password_change_required": false,
  "type": "dev",
  "organizations": [
    {
      "default_group": "116da82e-5385-47d0-8e40-97ef1a274b62",
      "groups": [
        "116da82e-5385-47d0-8e40-97ef1a274b62"
      ],
      "uuid": "116da82e-5385-47d0-8e40-97ef1a274b62"
    },
    {
      "default_group": "116da82e-5385-47d0-8e40-97ef1a274b62",
      "groups": [
        "116da82e-5385-47d0-8e40-97ef1a274b62"
      ],
      "uuid": "116da82e-5385-47d0-8e40-97ef1a274b62"
    }
  ],
  "two_factor": {
    "is_active": false,
    "methods": []
  },
  "created_at": "2024-05-08 13:37:09",
  "active": true
}

Ajuda e Suporte#

👍
Conte com a nossa ajuda!
Em caso de dúvidas ou caso precise de apoio, entre em contato conosco através do e-mail developers@inovanti.com.br com o máximo de detalhes possível.
Modificado em 2025-03-21 09:13:42
Página anterior
About
Próxima página
Error Messages
Built with