Iorq Public Routes
  1. CCB
Iorq Public Routes
  • AUTH
    • Token de acesso
      POST
  • CCB
    • Cessão de CCB
      POST
    • Renegociação de CCB
      PATCH
    • Cessão de CCB com Documentos de Lastro
      POST
    • Recompra de CCB
      POST
    • Atualização de status de instrumento financeiro
      PATCH
    • Liquidação de parcelas
      POST
    • Liquidação antecipada de parcelas
      POST
  • Webhook
    • Create Webhook
      POST
    • List Webhooks
      GET
    • Get Webhook By Id
      GET
    • Update Webhook
      PATCH
  • Webhook Outgoing
    • Payload enviado para a URL do webhook registrado pelo cliente
      POST
  • Esquemas
    • Schemas
      • TokenRequest
      • TokenResponse
      • WebhookBase
      • OperationData
      • Address
      • Borrower
      • Cosigner
      • InstallmentLoanRequest
      • Installment
      • BackingDocument
      • CreateLoanRequest
      • RepurchaseLoanRequest
      • SettleInstallmentRequest
      • PrepaymentInstallment
      • InstallmentPrepaymentRequest
      • WebhookCreateSchema
      • WebhookCreateResponseSchema
      • WebhookResponse
      • WebhookUpdateSchema
      • GetAllWebhookResponse
      • HTTPValidationError
      • ValidationError
      • LoanIdentification
      • BaseLoanRequest
      • LoanRenegotiationRequest
      • LoanStatusUpdateRequest
      • WebhookPayload
  1. CCB

Cessão de CCB com Documentos de Lastro

POST
/loan/with-document
Endpoint para envio de CCB juntamente com os documentos de lastro (CCB assinada, NF, etc.) em uma única requisição.
Vantagens desta rota:
Integração simplificada: envia dados da operação e documentos em uma única chamada
Utiliza o mesmo objeto CreateLoanRequest da rota /loan, facilitando a migração
Validação automática dos documentos (formato, tamanho e integridade)
Regras importantes:
O campo backing_documents no JSON deve conter a lista de documentos esperados
O nome de cada arquivo (sem extensão) deve corresponder ao value do respectivo backing_document
Exemplo: se backing_documents[0].value = "DOC123", o arquivo deve se chamar DOC123.pdf
Validações dos arquivos:
Formato: apenas PDF
Tamanho máximo: 2MB por arquivo
Validação de integridade do conteúdo do arquivo
Quantidade de arquivos deve ser igual à quantidade de backing_documents

Requisição

Authorization
JWT Bearer
Adicionar o parâmetro
Authorization
a Cabeçalhos
Exemplo:
Authorization: ********************
or
Parâmetros Bodymultipart/form-dataNecessário

Respostas

🟢201Criado
application/json
CCB e documento recebidos e processados com sucesso
Body

🟠400Solicitação Incorreta
🟠401Não Autorizado
🔴500Erro do Servidor
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://hs-receiver-app-development.iorq.com.br/api/loan/with-document' \
--header 'Authorization: Bearer <token>' \
--form 'loan_data="{\"fund_id\":\"374485cf-f6df-467c-b91d-9f14082c6f36\",\"banker_cnpj\":\"34337707000100\",\"product_type\":\"personal_loan\",\"banker_proposal_code\":\"12312345453\",\"originator_proposal_code\":\"34586674\",\"originator_product_type\":\"medical_credit\",\"ipoc\":\"903377072215613374214000056026604\",\"number_of_installments\":4,\"acquisition_value\":3418.00,\"interest_rate_monthly\":7.649999,\"acquisition_rate_monthly\":5.000000,\"late_interest_rate\":1.000000,\"late_fine_rate\":5.000000,\"iof_value\":46.62,\"fee_value\":13.67,\"tac_value\":30.00,\"cet_monthly\":8.856983,\"days_base_year\":252,\"days_base_month\":21,\"capitalization_frequency\":\"daily\",\"date_issued\":\"2025-03-30\",\"borrower\":{\"cpf\":\"12345678912\",\"name\":\"Marina Oliveira Santos\",\"birth_date\":\"1992-08-15\",\"gender\":\"female\",\"phone\":\"5511987654321\",\"email\":\"marina.santos@techcorp.com.br\",\"address\":{\"city\":\"São Paulo\",\"state\":\"SP\",\"number\":\"1000\",\"street\":\"Av. Paulista\",\"complement\":\"Apt 100\",\"postal_code\":\"01310300\",\"neighborhood\":\"Bela Vista\"}},\"installments\":[{\"code\":\"1\",\"due_date\":\"2025-04-30\",\"face_value\":1023.94,\"acquisition_value\":975.18,\"nosso_numero\":\"1001\"}],\"backing_documents\":[{\"type\":\"ccb\",\"value\":\"DOC123456\"}]}"' \
--form 'files=""'
Response Response Example
201 - Sucesso
{
    "status": "created",
    "message": "Loan received successfully"
}
Modificado em 2025-12-08 12:31:25
Página anterior
Renegociação de CCB
Próxima página
Recompra de CCB
Built with