Sending Collateral in an Operation
This set of endpoints allows the addition of collaterals associated with an operation. The collateral will be submitted for signature along with the operation documents. Each type of collateral contains its own rules for required documents and all collateral types are covered here in this documentation.
Send Collateral (POST)
Request
Path Params
| Field | Type | Description | Max Characters |
|---|---|---|---|
OPERATION-KEY * | string | Unique operation key (UUID v4). | 36 |
The collateral system enables the addition of different types of instruments, each with its own configuration of additional documents. In this section, we cover all available collateral models and their respective payloads.
Collateral Types
1 - Fiduciary alienation of property
2 - Fiduciary alienation of vehicle
3 - Fiduciary alienation of aircraft
4 - Fiduciary alienation of equipment/products/stock
5 - Fiduciary alienation of artwork
6 - Fiduciary alienation of securities
7 - Fiduciary alienation of shares and quotas
8 - Fiduciary alienation of credit rights
17 - Vehicle stock collateral (Floor Plan)
Fiduciary alienation of property
Request Body
{
"collateral_document_key": "25dd10b8-7364-4abe-b0e8-0e419b04194b",
"collateral_type": "fiduciary_alienation_property",
"additional_documents": [
{
"document_type": "property_appraisal_report",
"document_key": "a14e8b2c-bda7-4f3d-aebb-ae63822428ff"
},
{
"document_type": "property_registration_updated",
"document_key": "1bffe8c6-0a54-4854-b693-745b3dba9e04"
},
{
"document_type": "property_full_content_certificate",
"document_key": "210c38b5-6b61-4b74-b042-19ebef77e360"
},
{
"document_type": "property_insurance_policy",
"document_key": "4cc6d706-551f-4d5e-8539-1b59b2f96cff"
}
]
}
Document Types
| Enum | Description |
|---|---|
property_appraisal_report** | Property Appraisal Report. |
property_registration_updated** | Updated registration. |
property_full_content_certificate** | Full Content Certificate of Registration. |
property_insurance_policy | Insurance Policy (if required in contract). |
others | Other documents. |
(**) Required for fiduciary alienation of property
Fiduciary alienation of vehicle
Request Body
{
"collateral_document_key": "a14e8b2c-bda7-4f3d-aebb-ae63822428ff",
"collateral_type": "fiduciary_alienation_vehicle",
"additional_documents": [
{
"document_type": "vehicle_appraisal_report",
"document_key": "1bffe8c6-0a54-4854-b693-745b3dba9e04"
},
{
"document_type": "vehicle_inspection_report",
"document_key": "210c38b5-6b61-4b74-b042-19ebef77e360"
},
{
"document_type": "vehicle_crv_certificate",
"document_key": "4cc6d706-551f-4d5e-8539-1b59b2f96cff"
}
]
}
Document Types
| Enum | Description |
|---|---|
vehicle_appraisal_report** | Vehicle Appraisal Report (maximum 30-day lag) or FIPE Table. |
vehicle_inspection_report** | Inspection report. |
vehicle_crv_certificate** | Updated Vehicle Registration Certificate (CRLV). |
others | Other documents. |
(**) Required for fiduciary alienation of vehicle
Fiduciary alienation of aircraft
Request Body
{
"collateral_document_key": "a14e8b2c-bda7-4f3d-aebb-ae63822428ff",
"collateral_type": "fiduciary_alienation_aircraft",
"additional_documents": [
{
"document_type": "aircraft_certificate_anac",
"document_key": "1bffe8c6-0a54-4854-b693-745b3dba9e04"
},
{
"document_type": "aircraft_rab_consult",
"document_key": "210c38b5-6b61-4b74-b042-19ebef77e360"
},
{
"document_type": "aircraft_insurance_policy",
"document_key": "4cc6d706-551f-4d5e-8539-1b59b2f96cff"
},
{
"document_type": "aircraft_appraisal_report",
"document_key": "df608f78-5293-4f96-ab60-31185633b52c"
}
]
}
Document Types
| Enum | Description |
|---|---|
aircraft_certificate_anac** | Registration Certificate - ANAC. |
aircraft_rab_consult** | Aircraft Consultation in Brazilian Aeronautical Registry. |
aircraft_insurance_policy** | Insurance Policy - Fund as Beneficiary. |
aircraft_appraisal_report** | Aircraft Appraisal Report. |
others | Other documents. |
(**) Required for fiduciary alienation of aircraft
Fiduciary alienation of equipment products and stock
Request Body
{
"collateral_document_key": "a14e8b2c-bda7-4f3d-aebb-ae63822428ff",
"collateral_type": "fiduciary_alienation_equipment",
"additional_documents": [
{
"document_type": "equipment_purchase_invoice",
"document_key": "1bffe8c6-0a54-4854-b693-745b3dba9e04"
},
{
"document_type": "fiduciary_depositary_declaration",
"document_key": "210c38b5-6b61-4b74-b042-19ebef77e360"
},
{
"document_type": "equipment_appraisal_report",
"document_key": "4cc6d706-551f-4d5e-8539-1b59b2f96cff"
},
{
"document_type": "equipment_insurance_policy",
"document_key": "df608f78-5293-4f96-ab60-31185633b52c"
}
]
}
Document Types
| Enum | Description |
|---|---|
equipment_purchase_invoice** | Invoice - Purchase Record. |
equipment_appraisal_report** | Equipment Appraisal Report (maximum 30-day lag). |
equipment_insurance_policy | Equipment Insurance Policy (if required in contract). |
fiduciary_depositary_declaration | Faithful Depositary Declaration. |
others | Other documents. |
(**) Required for fiduciary alienation of equipment/product/stock
Fiduciary alienation of artwork
Request Body
{
"collateral_document_key": "a14e8b2c-bda7-4f3d-aebb-ae63822428ff",
"collateral_type": "fiduciary_alienation_artwork",
"additional_documents": [
{
"document_type": "artwork_appraisal_report",
"document_key": "1bffe8c6-0a54-4854-b693-745b3dba9e04"
},
{
"document_type": "artwork_storage_certificate",
"document_key": "210c38b5-6b61-4b74-b042-19ebef77e360"
}
]
}
Document Types
| Enum | Description |
|---|---|
artwork_appraisal_report** | Artwork Appraisal Report. |
artwork_storage_certificate** | Storage Location with Adequacy Certificate. |
artwork_insurance_policy | Insurance Policy (if required in contract). |
others | Other documents. |
(**) Required for fiduciary alienation of artwork
Fiduciary alienation of securities
Request Body
{
"collateral_document_key": "a14e8b2c-bda7-4f3d-aebb-ae63822428ff",
"collateral_type": "fiduciary_alienation_securities",
"additional_documents": [
{
"document_type": "securities_negotiation_block",
"document_key": "1bffe8c6-0a54-4854-b693-745b3dba9e04"
}
]
}
Document Types
| Enum | Description |
|---|---|
securities_negotiation_block** | Trading Block with Custodian. |
securities_registration_gravame | Storage Location with Adequacy Certificate. |
others | Other documents. |
(**) Required for fiduciary alienation of securities.
Fiduciary alienation of shares and quotas
Request Body
{
"collateral_document_key": "a14e8b2c-bda7-4f3d-aebb-ae63822428ff",
"collateral_type": "fiduciary_assignment_shares",
"additional_documents": [
{
"document_type": "share_registration_book",
"document_key": "1bffe8c6-0a54-4854-b693-745b3dba9e04"
}
]
}
Document Types
| Enum | Description |
|---|---|
share_registration_book** | Nominative Shares Registration Book with Lien Annotation. |
others | Other documents. |
(**) Required for fiduciary alienation/pledge of shares/quotas
Fiduciary alienation of credit rights
Request Body
{
"collateral_document_key": "a14e8b2c-bda7-4f3d-aebb-ae63822428ff",
"collateral_type": "fiduciary_assignment_shares",
}
Document Types
| Enum | Description |
|---|---|
others | Other documents. |
Property mortgage
Request Body
{
"collateral_document_key": "a14e8b2c-bda7-4f3d-aebb-ae63822428ff",
"collateral_type": "mortgage_property",
"additional_documents": [
{
"document_type": "property_appraisal_report",
"document_key": "1bffe8c6-0a54-4854-b693-745b3dba9e04"
},
{
"document_type": "property_registration",
"document_key": "210c38b5-6b61-4b74-b042-19ebef77e360"
},
{
"document_type": "property_insurance_policy",
"document_key": "4cc6d706-551f-4d5e-8539-1b59b2f96cff"
},
{
"document_type": "property_full_content_certificate",
"document_key": "df608f78-5293-4f96-ab60-31185633b52c"
}
]
}
Document Types
| Enum | Description |
|---|---|
property_appraisal_report** | Property Appraisal Report. |
property_registration** | Updated Property Registration. |
property_full_content_certificate** | Full Content Certificate of Registration. |
property_insurance_policy | Insurance Policy (if required in contract). |
others | Other documents. |
(**) Required for property mortgage.
Ship mortgage
Request Body
{
"collateral_document_key": "a14e8b2c-bda7-4f3d-aebb-ae63822428ff",
"collateral_type": "mortgage_ship",
"additional_documents": [
{
"document_type": "ship_registration",
"document_key": "1bffe8c6-0a54-4854-b693-745b3dba9e04"
},
{
"document_type": "ship_appraisal_report",
"document_key": "210c38b5-6b61-4b74-b042-19ebef77e360"
},
{
"document_type": "ship_insurance_policy",
"document_key": "4cc6d706-551f-4d5e-8539-1b59b2f96cff"
}
]
}
Document Types
| Enum | Description |
|---|---|
ship_registration** | Updated Ship Property Registration. |
ship_appraisal_report** | Ship Appraisal Report (maximum 3-month lag). |
ship_insurance_policy | Ship Insurance Policy (if required in contract). |
others | Other documents. |
(**) Required for ship mortgage.
Guarantee
Request Body
{
"collateral_document_key": "a14e8b2c-bda7-4f3d-aebb-ae63822428ff",
"collateral_type": "guarantor",
"additional_documents": [
{
"document_type": "guarantor_civil_status_declaration",
"document_key": "1bffe8c6-0a54-4854-b693-745b3dba9e04"
},
{
"document_type": "guarantor_personal_document",
"document_key": "210c38b5-6b61-4b74-b042-19ebef77e360"
}
]
}
Document Types
| Enum | Description |
|---|---|
guarantor_civil_status_declaration** | Civil Status Declaration of Guarantor. |
guarantor_personal_document** | Personal document of Guarantor. |
guarantor_income_tax_declaration | Income Tax Declaration of Guarantor. |
others | Other documents. |
(**) Required for Guarantee.
Guarantor
Request Body
{
"collateral_document_key": "a14e8b2c-bda7-4f3d-aebb-ae63822428ff",
"collateral_type": "surety",
"additional_documents": [
{
"document_type": "surety_civil_status_declaration",
"document_key": "1bffe8c6-0a54-4854-b693-745b3dba9e04"
},
{
"document_type": "surety_personal_document",
"document_key": "210c38b5-6b61-4b74-b042-19ebef77e360"
},
{
"document_type": "surety_income_tax_declaration",
"document_key": "4cc6d706-551f-4d5e-8539-1b59b2f96cff"
}
]
}
Document Types
| Enum | Description |
|---|---|
surety_civil_status_declaration** | Civil Status Declaration of Guarantor. |
surety_personal_document** | Personal document of Guarantor. |
surety_income_tax_declaration | Income Tax Declaration of Guarantor. |
others | Other documents. |
(**) Required for Guarantor.
Bank surety
Request Body
{
"collateral_document_key": "a14e8b2c-bda7-4f3d-aebb-ae63822428ff",
"collateral_type": "bank_surety",
"additional_documents": [
{
"document_type": "others",
"document_key": "1bffe8c6-0a54-4854-b693-745b3dba9e04"
}
]
}
Document Types
| Enum | Description |
|---|---|
others | Other documents. |
Card receivables
Request Body
{
"collateral_document_key": "a14e8b2c-bda7-4f3d-aebb-ae63822428ff",
"collateral_type": "card_receivables",
"additional_documents": [
{
"document_type": "others",
"document_key": "1bffe8c6-0a54-4854-b693-745b3dba9e04"
}
]
}
Document Types
| Enum | Description |
|---|---|
others | Other documents. |
Stock guarantee
Request Body
{
"collateral_document_key": "a14e8b2c-bda7-4f3d-aebb-ae63822428ff",
"collateral_type": "stock_guarantee",
"additional_documents": [
{
"document_type": "others",
"document_key": "1bffe8c6-0a54-4854-b693-745b3dba9e04"
}
]
}
Document Types
| Enum | Description |
|---|---|
others | Other documents. |
Collateral monitoring
Request Body
{
"collateral_document_key": "a14e8b2c-bda7-4f3d-aebb-ae63822428ff",
"collateral_type": "monitoring_guarantee",
"additional_documents": [
{
"document_type": "guarantee_contract",
"document_key": "1bffe8c6-0a54-4854-b693-745b3dba9e04"
},
{
"document_type": "guarantee_agent_contract",
"document_key": "210c38b5-6b61-4b74-b042-19ebef77e360"
}
]
}
Document Types
| Enum | Description |
|---|---|
guarantee_contract** | Guarantee Contract. |
guarantee_agent_contract** | Guarantee Agent Contract. |
others | Other documents. |
(**) Required for Collateral Monitoring.
Vehicle stock collateral (Floor Plan)
Collateral model used in Floor Plan operations, in which the issuer provides a vehicle stock as collateral for the operation. Unlike the other types, this model does not use collateral_document_key — each collateral represents a single vehicle, sent in the vehicle field.
To register N vehicles, send N POST requests, one per vehicle. Each request creates its own collateral, with its own collateral_key and collateral_status.
Request Body
{
"collateral_type": "vehicle_stock",
"additional_documents": [
{
"document_type": "vehicle_crlv_certificate",
"document_key": "1bffe8c6-0a54-4854-b693-745b3dba9e04"
}
],
"vehicle": {
"chassis": "9BWZZZ377VT004251",
"plate": "ABC1D23",
"plate_state": "SP",
"renavam": "12345678901",
"value": 85000.00,
"year": 2023,
"mileage": 32000
}
}
vehicle object
| Field | Type | Description | Required |
|---|---|---|---|
chassis * | string | Vehicle chassis number. 17 uppercase alphanumeric characters. | Yes |
plate | string | Vehicle license plate, in the Mercosul or old format. | No** |
plate_state | string | State (UF) where the vehicle is registered (abbreviation). | No** |
renavam | string | Vehicle RENAVAM. 9 to 11 numeric digits. | No** |
value | number | Vehicle value. Greater than or equal to 0. | No |
year | integer | Vehicle year. Greater than or equal to 1900 and at most the year after the current one. | No |
mileage | integer | Vehicle mileage. Greater than or equal to 0. Requires plate, plate_state and renavam. | No |
(**) plate, plate_state and renavam form an all-or-nothing group: the vehicle must send all three fields together (registered/used vehicle) or none of them (brand-new vehicle, not yet registered). Sending only part of the group is rejected with a validation error (400). A brand-new vehicle also cannot send mileage.
Document Types
| Enum | Description |
|---|---|
vehicle_crlv_certificate | Vehicle Registration and Licensing Certificate (CRLV). |
The CRLV is sent in additional_documents, at the root of the request body (see additional_documents list). Sending it is optional and only the vehicle_crlv_certificate type is accepted. The document is stored in the collateral and returned in the additional_documents field of the response, not inside collateral_data.
Vehicle validation
On registration, the vehicle is consulted (not marked) in the B3 vehicle stock database:
- Free vehicle (no active reservation or not found at B3): the collateral is created as
validatedand the request returns 201 with the collateral. - Vehicle with an active reservation at B3 or consultation error: the collateral is stored as
canceledand the request returns 422 with the codeCOM000087. The canceled collateral is returned in thecollateralfield of the error body. Acanceledcollateral is not included in the contract draft or in the issuance, and does not appear in the operation's collateral list. - Chassis already present in another
validatedcollateral of the same operation: the request is rejected with 409 (COM000085) and nothing is stored. A chassis whose previous collateral was canceled can be sent again.
Response
Response Body (201)
{
"collateral_key": "8a0c6e0e-3f5b-4c2a-9d7e-1b2f3c4d5e6f",
"collateral_type": "vehicle_stock",
"collateral_status": "validated",
"collateral_data": {
"vehicle": {
"chassis": "9BWZZZ377VT004251",
"plate": "ABC1D23",
"plate_state": "SP",
"renavam": "12345678901",
"value": 85000.00,
"year": 2023,
"mileage": 32000
}
},
"collateral_document_key": null,
"collateral_instrument_document_key": null,
"additional_documents": [
{
"collateral_document_key": "c1d2e3f4-a5b6-4c7d-8e9f-0a1b2c3d4e5f",
"collateral_document_type": "vehicle_crlv_certificate",
"document_key": "1bffe8c6-0a54-4854-b693-745b3dba9e04"
}
],
"collateral_event_list": [
{
"collateral_status": "validated",
"event_type": "collateral_status_change",
"event_data": {
"from": "created",
"to": "validated",
"reason": "vehicle_consult_free",
"b3_response": {
"reservations": []
},
"b3_code": null,
"b3_description": null,
"b3_http_status": 200
},
"event_datetime": "2026-09-28T14:32:10.123456+00:00"
}
]
}
Response Body (422 — COM000087)
{
"title": "Unprocessable Entity",
"description": "Vehicle with chassis '9BWZZZ377VT004251' could not be validated on B3 (code: None, description: Vehicle has an active reservation with status 'Ativo'); the vehicle_stock collateral was registered as canceled.",
"translation": "O veiculo com chassi '9BWZZZ377VT004251' nao pode ser validado na B3 (codigo: None, descricao: Vehicle has an active reservation with status 'Ativo'); a garantia de estoque de veiculos foi registrada como cancelada.",
"code": "COM000087",
"collateral": {
"collateral_key": "8a0c6e0e-3f5b-4c2a-9d7e-1b2f3c4d5e6f",
"collateral_type": "vehicle_stock",
"collateral_status": "canceled",
"collateral_data": {
"vehicle": {
"chassis": "9BWZZZ377VT004251",
"plate": "ABC1D23",
"plate_state": "SP",
"renavam": "12345678901"
}
},
"collateral_document_key": null,
"collateral_instrument_document_key": null,
"additional_documents": [],
"collateral_event_list": [
{
"collateral_status": "canceled",
"event_type": "collateral_status_change",
"event_data": {
"from": "created",
"to": "canceled",
"reason": "vehicle_consult_marked",
"b3_response": {
"reservations": [
{
"reservation_status": "Ativo"
}
]
},
"b3_code": null,
"b3_description": "Vehicle has an active reservation with status 'Ativo'",
"b3_http_status": 200
},
"event_datetime": "2026-09-28T14:32:10.123456+00:00"
}
]
}
}
Collateral status (collateral_status)
Every collateral, of any type, returns the collateral_status field. For types that do not depend on external validation, the collateral starts as validated and moves to finished upon signature. For vehicle_stock, the full lifecycle is:
| Status | Description |
|---|---|
validated | Collateral accepted on registration. For vehicle_stock, the vehicle was consulted and is free at B3. |
canceled | Collateral canceled: vehicle with an active reservation or consultation error on registration, collateral removed or operation canceled. Not included in the contract draft or in the issuance. |
pending | Operation signed; the vehicle is waiting to be marked at B3. |
finished | Vehicle marked at B3 (or, for the other types, operation signed). |
failed | Marking the vehicle at B3 failed after the signature. |
Event history (collateral_event_list)
Every collateral returns the collateral_event_list field, with the history of status changes in chronological order.
| Field | Type | Description |
|---|---|---|
collateral_status | string | Collateral status after the event. |
event_type | string | Event type. collateral_status_change for status changes. |
event_data | object | Event data: from (previous status), to (new status), reason and, for vehicle_stock, the B3 response (b3_response, b3_code, b3_description, b3_http_status). |
event_datetime | string | Event date and time (ISO 8601, UTC). |
Flow after signature
- When all parties sign, the operation moves to
pending_collateraland each vehicle with avalidatedcollateral is consulted again and marked at B3. - If all vehicles are marked, the collaterals move to
finishedand the operation proceeds toissued. - If the consultation or the marking of any vehicle fails, the affected collaterals move to
failedand the operation moves tofailed. The operation leavesfailedthrough reprocessing performed by QI Tech or through cancellation.
Errors
| HTTP Status | Code | Description |
|---|---|---|
| 400 | — | Schema validation error (for example, incomplete plate/plate_state/renavam group). |
| 400 | COM000083 | Tenant does not have access to this collateral type. |
| 400 | COM000084 | Vehicle year later than the year after the current one. |
| 409 | COM000085 | The chassis is already in a validated collateral of the same operation. |
| 422 | COM000087 | Vehicle with an active reservation at B3 or consultation error. The collateral is stored as canceled and returned in the collateral field of the error body. |
See also the error catalog.
Request Body Params
| Field | Type | Description | Required |
|---|---|---|---|
collateral_document_key * | string | Collateral instrument key. | Yes |
collateral_type * | string | Collateral type. | collateral_type Enums |
collateral_data | object | Metadata structure related to collateral. | Yes |
additional_documents | list | Documents related to collateral. | - |
additional_documents list
| Field | Type | Description | Required |
|---|---|---|---|
document_key * | string | Collateral instrument key. | Yes |
document_type * | string | Collateral document type. | Yes |
collateral_type Enums
| Enum | Description |
|---|---|
fiduciary_alienation_property | Fiduciary alienation of property. |
fiduciary_alienation_vehicle | Fiduciary alienation of vehicle. |
fiduciary_alienation_aircraft | Fiduciary alienation of aircraft. |
fiduciary_alienation_equipment | Fiduciary alienation of equipment/products/stock. |
fiduciary_alienation_artwork | Fiduciary alienation of artwork. |
fiduciary_alienation_securities | Fiduciary alienation of securities. |
fiduciary_assignment_shares | Fiduciary alienation/pledge of shares/quotas. |
fiduciary_assignment_credit_rights | Fiduciary alienation of credit rights. |
mortgage_property | Property mortgage. |
mortgage_ship | Ship mortgage. |
guarantor | Guarantee. |
surety | Guarantor. |
bank_surety | Bank surety. |
card_receivables | Card receivables. |
stock_guarantee | Stock guarantee. |
monitoring_guarantee | Collateral monitoring. |
vehicle_stock | Vehicle stock collateral (Floor Plan). Does not use collateral_document_key — see Vehicle stock collateral (Floor Plan). |
others | Other collaterals. |