iCredit
  1. Operations
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
          GET
        • search
          POST
        • find
          GET
        • audit
          POST
        • create
          POST
        • simulate
          POST
        • update
          PUT
        • delete
          DELETE
        • files
          GET
        • resend-notification
          GET
        • update-deadline-at
          PATCH
        • add-signatories
          POST
        • remove-signatory
          DELETE
        • cancel-document
          PATCH
        • finish-document
          PATCH
        • reprocess-current-status
          POST
        • change-status
          POST
        • update-status-to-grant
          POST
        • update-status-to-endorsement
          POST
        • update-status-to-approval
          POST
        • operation-status
          GET
      • 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
  1. Operations

cancel-document

PATCH
/api/v1/operations/cancel-document/document/{document_key}/clicksign/{organization_uuid}
Cancelar um contrato da operação

Requisição

Authorization
Forneça seu token bearer no cabeçalho
Authorization
ao fazer requisições para recursos protegidos.
Exemplo:
Authorization: Bearer ********************
Parâmetros Path
document_key
string 
requerido
Exemplo:
32dfcb8b-0346-4be6-ad3f-283daff1da41
organization_uuid
string 
requerido
Exemplo:
a6b2e6ca-bd1a-537c-8cd4-cf20c7bfc284
Parâmetros Header
Accept
string 
opcional
Padrão:
application/json
Content-Type
string 
opcional
Padrão:
application/json
Parâmetros Bodyapplication/json
organization_uuid
string 
requerido
document_key
string 
requerido
signer_key
array [object {2}] 
requerido
key
string 
opcional
sign_as
enum<string> 
opcional
Valores permitidos:
account_holderaccountantadministratorapproveassociateattorneybaileeborrowerbrokerbuilding_managerbuyerco_responsiblecollateral_providercomfortercondominium_memberconsentedconsentingconsenting_intervenorconsigneecontracteecontractorcreditordebtordirectordistracteddistractingemployeeemployerendorseeendorserfranchiseefranchisorgranteegrantorguarantorguarantor_spouseinsurance_brokerinsuredintermediaryinterveningintervening_guarantorissuerjoint_debtorlawyerlegal_guardianlegal_representativelenderlesseelessorlicensedlicensormanagerownerpartnerpartypledgedpresidentratifyreal_estate_brokerreceiptresidentsecretarysecuredsellerservice_providersignsignedsuretysurveyortransfereetransferortreasurervalidatorwitness
message
string 
requerido
api
object 
requerido
type
string 
requerido
Exemplo
{
    "organization_uuid": "string",
    "document_key": "string",
    "signer_key": [
        {
            "key": "string",
            "sign_as": "account_holder"
        }
    ],
    "message": "string",
    "api": {
        "type": "string"
    }
}

Respostas

🟢200Success
application/json
Body
object {0}
Exemplo
{}
Modificado em 2024-11-18 18:17:19
Página anterior
remove-signatory
Próxima página
finish-document
Built with