Assinaturas e documentos
Copiar Página
iCredit
Default module
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 (V1) — autenticação do Credit V2
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
Autenticação
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
200 — Listar transmissões STA do arquivo
200 — Consultar transmissão STA
Validações oficiais
200 — Listar validações oficiais do arquivo
200 — Download de artefato (audita)
200 — Buscar arquivos CADOC
200 — Consultar arquivo
download files
CADOCs
200 — Buscar CADOCs
200 — Consultar CADOC
Configurações
200 — Buscar configurações
200 — Consultar configuração
Entidades reportantes
200 — Listar entidades reportantes
200 — Endossantes elegíveis
200/404 — Readiness regulatório
Lotes de geração
200 — Buscar lotes de geração
200 — Consultar lote
Mapeamentos de produtos
200 — Buscar mapeamentos
200 — Consultar mapeamento
Perfis regulatórios
200 — Buscar perfis regulatórios
200 — Consultar perfil regulatório
Credit V2
Credit V2
Autenticação
Login (V1) — autenticação do Credit V2
Dashboard
home-admin
Monitoramento
check
documentation
signature-diagnosis
Operações
Arquivos
files
list-by-operation
Assinaturas e documentos
add-signatories
POST
cancel-document
PATCH
finish-document
PATCH
resend-notification
GET
remove-signatory
DELETE
update-deadline-atIn-document
PATCH
get_file_events_operation
GET
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
200 — Listar transmissões STA do arquivo
200 — Consultar transmissão STA
Validações oficiais
200 — Listar validações oficiais do arquivo
200 — Download de artefato (audita)
200 — Buscar arquivos CADOC
200 — Consultar arquivo
download files
CADOCs
200 — Buscar CADOCs
200 — Consultar CADOC
Configurações
200 — Buscar configurações
200 — Consultar configuração
Entidades reportantes
200 — Listar entidades reportantes
200 — Endossantes elegíveis
200/404 — Readiness regulatório
Lotes de geração
200 — Buscar lotes de geração
200 — Consultar lote
Mapeamentos de produtos
200 — Buscar mapeamentos
200 — Consultar mapeamento
Perfis regulatórios
200 — Buscar perfis regulatórios
200 — Consultar perfil regulatório
Assinaturas e documentos
Copiar Página
get_file_events_operation
GET
/api/v2/operations/{uuid}/signature-progress
Testar
Run in Apidog
Run in Apidog
Requisição
Authorization
Forneça seu token bearer no cabeçalho
Authorization
ao fazer requisições para recursos protegidos.
Exemplo:
Authorization: Bearer ********************
Parâmetros de Caminho
Gerar Código
Parâmetros Header
Gerar Código
Respostas
🟢
200
application/json
Gerar Código
Body
application/json
Gerar Código
Exemplo
{
"message"
:
"Não autenticado."
}
Modificado em
2026-10-22 17:50:26
Página anterior
update-deadline-atIn-document
Próxima página
Criar cônjuge na operação