Simulation and Issuance
API under development
The API is still in development phase, therefore, this manual is subject to changes.
Debt Simulation
Before issuing the operation, simulate the financial conditions by sending the basic data with collateral type vehicle. Registration fees vary per Detran region, so the collateral data is required for an accurate financial simulation.
Request
POST
/debt_simulationRequest Body
{
"borrower": {
"person_type": "natural"
},
"financial": {
"first_due_date": "2025-06-15",
"installment_face_value": 500,
"disbursement_date": "2025-05-10",
"limit_days_to_disburse": 3,
"number_of_installments": 12,
"monthly_interest_rate": 0.018,
"interest_type": "pre_price_days",
"fine_configuration": {
"monthly_rate": 0.01,
"interest_base": "calendar_days",
"contract_fine_rate": 0.02
},
"credit_operation_type": "ccb",
"interest_grace_period": 0,
"principal_grace_period": 0
},
"collaterals": [
{
"collateral_type": "vehicle",
"collateral_data": {
"vehicle_type": "car",
"licensing_state": "SP"
}
}
]
}
info
The simulation accepts both installment_face_value (fixing the installment amount, varying the disbursement) and disbursed_amount (fixing the disbursed amount, varying the installment). The collateral_type field must be "vehicle". For simulation, the required fields in collateral_data are vehicle_type and licensing_state — fees vary per Detran region.
Response
STATUS
200 (OK)Response Body
{
"type": "debt",
"key": "<Debt Key>",
"status": "finished",
"event_datetime": "2025-05-10 16:50:00",
"data": {
"interest_type": "pre_price_days",
"credit_operation_type": "ccb",
"interest_grace_period": 0,
"principal_grace_period": 0,
"operation_type": "structured_operation",
"prefixed_interest_rate": {
"interest_base": "calendar_days_365",
"annual_rate": 0.23872053,
"monthly_rate": 0.018,
"daily_rate": 0.00058669
},
"issue_date": "2025-05-10",
"number_of_installments": 12,
"disbursement_options": [
{
"iof_amount": 25.50,
"total_pre_fixed_amount": 580.45,
"cet": 0.0230,
"annual_cet": 0.3120,
"contract_fees": [
{
"fee_type": "registration_fee",
"amount_type": "absolute",
"amount": 1.0,
"fee_amount": 350.00
}
],
"external_contract_fees": [],
"contract_fee_amount": 350.00,
"external_contract_fee_amount": 0.0,
"disbursement_date": "2025-05-10",
"first_due_date": "2025-06-15",
"installments": [
{
"calendar_days": 36,
"business_due_date": "2025-06-15",
"due_date": "2025-06-15",
"due_principal": 5419.55,
"has_interest": true,
"pre_fixed_amount": 114.65,
"tax_amount": 1.25,
"total_amount": 500,
"principal_amortization_amount": 385.35,
"installment_number": 1
}
],
"issue_amount": 5419.55,
"disbursed_issue_amount": 5044.05,
"assignment_amount": 5419.55,
"final_disbursement_amount": 5044.05,
"prefixed_interest_rate": {
"interest_base": "calendar_days_365",
"annual_rate": 0.23872053,
"monthly_rate": 0.018,
"daily_rate": 0.00058669
}
}
]
}
}
Installments Object
| Field | Description |
|---|---|
| calendar_days | Calendar days |
| business_due_date | Business day due date |
| due_date | Due date |
| due_principal | Due principal |
| has_interest | Indicates whether the installment has interest |
| pre_fixed_amount | Pre-fixed installment amount |
| tax_amount | Tax amount of the installment |
| total_amount | Total installment amount |
| principal_amortization_amount | Principal amortization amount |
| installment_number | Installment number |
Prefixed Interest Rate Object
| Field | Description |
|---|---|
| monthly_rate | Monthly rate |
| daily_rate | Daily rate |
| annual_rate | Annual rate |
| interest_base | Interest rate calculation base |
Contract Fees Object
| Field | Type | Description |
|---|---|---|
| fee_type | String | Fee type (e.g., registration_fee) |
| amount_type | String | Amount type (absolute or percentage) |
| amount | Float | Multiplier or percentage applied |
| fee_amount | Float | Final monetary fee value |
Registration Fees
General registration fees (DETRAN, SNG/B3) are directly reflected in the contract_fee_amount field within disbursement_options. The total fee amount is deducted from the issue amount (issue_amount), not from the net disbursement value.
Operation Issuance
After simulating and validating the conditions, issue the credit operation with vehicle collateral. The request body includes borrower data, financial data, vehicle collateral, and the disbursement account.
Request
POST
/debtRequest Body
{
"borrower": {
"name": "Borrower Name",
"email": "borrower@email.com",
"phone": {
"number": "999999999",
"area_code": "11",
"country_code": "055"
},
"gender": "male",
"political_exposition": "not_exposed",
"address": {
"city": "São Paulo",
"state": "SP",
"number": "100",
"street": "Example Street",
"complement": "Apt 10",
"postal_code": "01001000",
"neighborhood": "Centro"
},
"role_type": "issuer",
"birth_date": "1990-01-15",
"mother_name": "MOTHER NAME",
"nationality": "Brasileiro",
"person_type": "natural",
"marital_status": "single",
"attached_documents_list": [],
"individual_document_number": "12345678901",
"document_identification_date": "2015-10-02",
"document_identification_type": "rg",
"document_identification_number": "123456789"
},
"financial": {
"interest_type": "pre_price_days",
"first_due_date": "2025-06-15",
"disbursement_date": "2025-05-10",
"fine_configuration": {
"monthly_rate": 0.01,
"interest_base": "calendar_days",
"contract_fine_rate": 0.02
},
"credit_operation_type": "ccb",
"interest_grace_period": 0,
"monthly_interest_rate": 0.018,
"installment_face_value": 500,
"limit_days_to_disburse": 3,
"number_of_installments": 12,
"principal_grace_period": 0
},
"collaterals": [
{
"percentage": 1,
"collateral_type": "vehicle",
"collateral_data": {
"vehicle_type": "car",
"plate": "ABC1D23",
"licensing_state": "SP",
"licensing_city": "São Paulo",
"renavam": "12345678901",
"chassi_type": "Remarcado",
"chassi_number": "9BWZZZ37780001234",
"kilometers": 45000,
"car_color": "Prata",
"car_value": 85000.00,
"subcorban_document_number": "12345678000195",
"model": {
"brand": "Toyota",
"name": "Corolla XEI 2.0",
"year": "2022",
"manufacturing_year": "2021"
},
"seller": {
"name": "João da Silva Automóveis",
"document_number": "98765432000100"
}
}
}
],
"purchaser_document_number": "12345678000199",
"disbursement_bank_accounts": [
{
"name": "BORROWER NAME",
"bank_code": "001",
"account_digit": "0",
"branch_number": "1234",
"account_number": "000012345",
"document_number": "12345678901",
"transfer_method": "pix",
"percentage_receivable": 100
}
]
}
Important
There is no need to call separate endpoints to register liens or contracts. Simply send the vehicle data in the collaterals object when creating the debt and QI Tech handles the entire process internally (lien registration at SNG/B3, contract registration at DETRAN/Registrar, image submission).
Simulation
For POST /debt_simulation, include collateral_type: "vehicle" in the collaterals array with collateral_data containing at minimum vehicle_type and licensing_state. Registration fees vary per Detran region.
reservation_method
After creation, the API automatically adds reservation_method to collateral_data (value: "creation" or "issuing" based on requester configuration). This field should not be sent in the request.
collateral_data Fields
| Field | Type | Description | Req. |
|---|---|---|---|
| vehicle_type | String | Vehicle type (car, motorcycle, truck) | YES |
| plate | String | Vehicle plate (7 characters) | YES |
| licensing_state | String | Vehicle licensing state (2 chars, uppercase) | YES |
| licensing_city | String | Vehicle licensing city | YES |
| renavam | String | RENAVAM number (11 digits) | YES |
| chassi_type | String | Chassis type (Remarcado or Normal) | YES |
| chassi_number | String | Vehicle chassis number (4 to 21 chars, alphanumeric) | YES |
| kilometers | Integer | Current vehicle mileage | YES |
| car_color | String | Vehicle color | YES |
| car_value | Float | Vehicle value (2 decimal places) | YES |
| subcorban_document_number | String | Banking correspondent CNPJ (14 digits) | NO |
model Object
| Field | Type | Description | Req. |
|---|---|---|---|
| brand | String | Vehicle brand | YES |
| name | String | Vehicle model name | YES |
| year | String | Model year | YES |
| manufacturing_year | String | Manufacturing year | YES |
seller Object
| Field | Type | Description | Req. |
|---|---|---|---|
| name | String | Seller name | YES |
| document_number | String | Seller CPF (11 digits) or CNPJ (14 digits) | YES |
Response
STATUS
201 (Created)Response Body
Response Body
{
"webhook_type": "debt",
"key": "<Debt Key>",
"status": "waiting_signature",
"event_datetime": "2025-05-10 14:30:00",
"data": {
"borrower": {
"name": "Borrower Name",
"document_number": "12345678901",
"related_party_key": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
},
"contract": {
"number": "OP-000000000000001",
"urls": [
"https://storage.googleapis.com/doc-api/documents/<uuid>/BORROWER_NAME-CCB-OP000000000000001.pdf"
],
"signature_information": [
{
"signer_name": "Borrower Name",
"signer_document_number": "12345678901",
"signer_role": "issuer",
"signer_email": null,
"signer_external_key": null,
"signature_url": null
}
]
},
"collaterals": [
{
"absolute_amount": null,
"collateral_constituted": false,
"collateral_data": {
"vehicle_type": "car",
"plate": "ABC1D23",
"licensing_state": "SP",
"licensing_city": "São Paulo",
"renavam": "12345678901",
"chassi_type": "Remarcado",
"chassi_number": "9BWZZZ37780001234",
"kilometers": 45000,
"car_color": "Prata",
"car_value": 85000.00,
"subcorban_document_number": "12345678000195",
"model": {
"brand": "Toyota",
"name": "Corolla XEI 2.0",
"year": "2022",
"manufacturing_year": "2021"
},
"seller": {
"name": "João da Silva Automóveis",
"document_number": "98765432000100"
}
},
"collateral_key": "f1e2d3c4-b5a6-7890-fedc-ba0987654321",
"collateral_type": "vehicle",
"created_at": "2025-05-10T14:30:00.000000",
"external_key": null,
"percentage": 1,
"updated_at": "2025-05-10T14:30:00.000000"
}
],
"disbursement_options": [
{
"disbursement_date": "2025-05-10",
"contract_fees": [
{
"fee_type": "registration_fee",
"amount_type": "absolute",
"amount": 1.0,
"fee_amount": 350.00
}
],
"external_contract_fees": [],
"contract_fee_amount": 350.00,
"external_contract_fee_amount": 0.0,
"assignment_amount": 5419.55,
"issue_amount": 5419.55,
"cet": "2.3000%",
"annual_cet": "31.2000%",
"total_iof": 25.50,
"total_pre_fixed_amount": 580.45,
"installments": [
{
"business_due_date": "2025-06-15",
"calendar_days": 36,
"due_date": "2025-06-15",
"due_principal": 5419.55,
"has_interest": true,
"installment_number": 1,
"pre_fixed_amount": 114.65,
"principal_amortization_amount": 385.35,
"tax_amount": 1.25,
"total_amount": 500,
"installment_status": null,
"installment_type": null
}
],
"first_due_date": "2025-06-15",
"prefixed_interest_rate": {
"monthly_rate": 0.018,
"daily_rate": 0.00058669,
"annual_rate": 0.23872053,
"interest_base": "calendar_days_365"
}
}
]
}
}
Cancellation Webhook
If the operation is not signed or endorsed by the last disbursement date option, the partner will receive a webhook notifying about the operation cancellation:
WEBHOOK TYPE
debtWebhook Body
Webhook Body
{
"key": "<Debt Key>",
"status": "canceled",
"webhook_type": "debt",
"event_datetime": "2025-05-20 10:00:00",
"data": {
"cancel_reason": "<CANCEL_REASON>",
"cancel_reason_enumerator": "<CANCEL_REASON_ENUMERATOR>"
}
}
Enumerators
collateral_type
| Value | Description |
|---|---|
| vehicle | Vehicle collateral (lien) |
vehicle_type
| Value | Description |
|---|---|
| car | Car / Automobile |
| motorcycle | Motorcycle |
| truck | Truck |
chassi_type
| Value | Description |
|---|---|
| Remarcado | Remarked chassis |
| Normal | Normal chassis (default) |