Send Operation Collateral

This endpoint allows adding collateral to a Debenture operation. The collateral is submitted for signature together with the operation documents. Each collateral type (collateral_type) has its own required-document rules, listed below.

Where document_key comes from

The collateral_document_key and document_key (in additional_documents) reference previously uploaded documents. Each key is obtained from the Send document endpoint (POST /debenture/upload), which receives the file in Base64 and returns the corresponding document_key.

Request

ENDPOINT

/debenture/operation/OPERATION-KEY/collateral

METHOD

POST

Path Params

Field	Type	Description	Characters
`OPERATION-KEY` *	string	Unique operation key (UUID v4).	36

Collateral types

warning

Documents marked as required are mandatory for the respective collateral type.

Fiduciary alienation of property (`fiduciary_alienation_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": "1bffe8c6-0a54-4854-b693-745b3dba9e04" },
        { "document_type": "property_registration_updated", "document_key": "1bffe8c6-0a54-4854-b693-745b3dba9e04" },
        { "document_type": "property_full_content_certificate", "document_key": "1bffe8c6-0a54-4854-b693-745b3dba9e04" }
    ]
}

Document types

Enum	Description	Required
`property_appraisal_report`	Property appraisal report.	Yes
`property_registration_updated`	Updated property registration.	Yes
`property_full_content_certificate`	Full content certificate of registration.	Yes
`property_insurance_policy`	Insurance policy (if required by contract).	-
`others`	Other documents.	-

Fiduciary alienation of vehicle (`fiduciary_alienation_vehicle`)

Request Body

{
    "collateral_document_key": "25dd10b8-7364-4abe-b0e8-0e419b04194b",
    "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": "1bffe8c6-0a54-4854-b693-745b3dba9e04" },
        { "document_type": "vehicle_crv_certificate", "document_key": "1bffe8c6-0a54-4854-b693-745b3dba9e04" }
    ]
}

Document types

Enum	Description	Required
`vehicle_appraisal_report`	Vehicle appraisal report or FIPE table.	Yes
`vehicle_inspection_report`	Inspection report.	Yes
`vehicle_crv_certificate`	Updated vehicle registration certificate (CRLV).	Yes
`others`	Other documents.	-

Fiduciary alienation of aircraft (`fiduciary_alienation_aircraft`)

Request Body

{
    "collateral_document_key": "25dd10b8-7364-4abe-b0e8-0e419b04194b",
    "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": "1bffe8c6-0a54-4854-b693-745b3dba9e04" },
        { "document_type": "aircraft_insurance_policy", "document_key": "1bffe8c6-0a54-4854-b693-745b3dba9e04" },
        { "document_type": "aircraft_appraisal_report", "document_key": "1bffe8c6-0a54-4854-b693-745b3dba9e04" }
    ]
}

Document types

Enum	Description	Required
`aircraft_certificate_anac`	Registration certificate - ANAC.	Yes
`aircraft_rab_consult`	Brazilian Aeronautical Registry (RAB) consultation.	Yes
`aircraft_insurance_policy`	Insurance policy - fund as beneficiary.	Yes
`aircraft_appraisal_report`	Aircraft appraisal report.	Yes
`others`	Other documents.	-

Fiduciary alienation of equipment/products/inventory (`fiduciary_alienation_equipment`)

Request Body

{
    "collateral_document_key": "25dd10b8-7364-4abe-b0e8-0e419b04194b",
    "collateral_type": "fiduciary_alienation_equipment",
    "additional_documents": [
        { "document_type": "equipment_purchase_invoice", "document_key": "1bffe8c6-0a54-4854-b693-745b3dba9e04" },
        { "document_type": "equipment_appraisal_report", "document_key": "1bffe8c6-0a54-4854-b693-745b3dba9e04" }
    ]
}

Document types

Enum	Description	Required
`equipment_purchase_invoice`	Purchase invoice.	Yes
`equipment_appraisal_report`	Equipment appraisal report.	Yes
`equipment_insurance_policy`	Equipment insurance policy (if required).	-
`fiduciary_depositary_declaration`	Bona fide depositary declaration.	-
`others`	Other documents.	-

Fiduciary alienation of artwork (`fiduciary_alienation_artwork`)

Request Body

{
    "collateral_document_key": "25dd10b8-7364-4abe-b0e8-0e419b04194b",
    "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": "1bffe8c6-0a54-4854-b693-745b3dba9e04" }
    ]
}

Document types

Enum	Description	Required
`artwork_appraisal_report`	Artwork appraisal report.	Yes
`artwork_storage_certificate`	Storage location adequacy certificate.	Yes
`artwork_insurance_policy`	Insurance policy (if required).	-
`others`	Other documents.	-

Fiduciary alienation of securities (`fiduciary_alienation_securities`)

Request Body

{
    "collateral_document_key": "25dd10b8-7364-4abe-b0e8-0e419b04194b",
    "collateral_type": "fiduciary_alienation_securities",
    "additional_documents": [
        { "document_type": "securities_negotiation_block", "document_key": "1bffe8c6-0a54-4854-b693-745b3dba9e04" }
    ]
}

Document types

Enum	Description	Required
`securities_negotiation_block`	Trading block at the custodian.	Yes
`securities_registration_gravame`	Lien registration.	-
`others`	Other documents.	-

Fiduciary assignment of shares/quotas (`fiduciary_assignment_shares`)

Request Body

{
    "collateral_document_key": "25dd10b8-7364-4abe-b0e8-0e419b04194b",
    "collateral_type": "fiduciary_assignment_shares",
    "additional_documents": [
        { "document_type": "share_registration_book", "document_key": "1bffe8c6-0a54-4854-b693-745b3dba9e04" }
    ]
}

Document types

Enum	Description	Required
`share_registration_book`	Registered shares book with lien annotation.	Yes
`others`	Other documents.	-

Property mortgage (`mortgage_property`)

Request Body

{
    "collateral_document_key": "25dd10b8-7364-4abe-b0e8-0e419b04194b",
    "collateral_type": "mortgage_property",
    "additional_documents": [
        { "document_type": "property_appraisal_report", "document_key": "1bffe8c6-0a54-4854-b693-745b3dba9e04" },
        { "document_type": "property_registration", "document_key": "1bffe8c6-0a54-4854-b693-745b3dba9e04" },
        { "document_type": "property_full_content_certificate", "document_key": "1bffe8c6-0a54-4854-b693-745b3dba9e04" }
    ]
}

Document types

Enum	Description	Required
`property_appraisal_report`	Property appraisal report.	Yes
`property_registration`	Updated property record.	Yes
`property_full_content_certificate`	Full content certificate of registration.	Yes
`property_insurance_policy`	Insurance policy (if required by contract).	-
`others`	Other documents.	-

Ship mortgage (`mortgage_ship`)

Request Body

{
    "collateral_document_key": "25dd10b8-7364-4abe-b0e8-0e419b04194b",
    "collateral_type": "mortgage_ship",
    "additional_documents": [
        { "document_type": "ship_registration", "document_key": "1bffe8c6-0a54-4854-b693-745b3dba9e04" },
        { "document_type": "ship_appraisal_report", "document_key": "1bffe8c6-0a54-4854-b693-745b3dba9e04" }
    ]
}

Document types

Enum	Description	Required
`ship_registration`	Updated ship ownership record.	Yes
`ship_appraisal_report`	Ship appraisal report.	Yes
`ship_insurance_policy`	Ship insurance policy (if required).	-
`others`	Other documents.	-

Guaranty (aval) (`guarantor`)

Request Body

{
    "collateral_document_key": "25dd10b8-7364-4abe-b0e8-0e419b04194b",
    "collateral_type": "guarantor",
    "additional_documents": [
        { "document_type": "guarantor_civil_status_declaration", "document_key": "1bffe8c6-0a54-4854-b693-745b3dba9e04" }
    ]
}

Document types

Enum	Description	Required
`guarantor_civil_status_declaration`	Guarantor civil status declaration.	Yes
`guarantor_personal_document`	Guarantor personal document.	-
`guarantor_income_tax_declaration`	Guarantor income tax declaration.	-
`others`	Other documents.	-

Surety (`surety`)

Request Body

{
    "collateral_document_key": "25dd10b8-7364-4abe-b0e8-0e419b04194b",
    "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": "1bffe8c6-0a54-4854-b693-745b3dba9e04" },
        { "document_type": "surety_income_tax_declaration", "document_key": "1bffe8c6-0a54-4854-b693-745b3dba9e04" }
    ]
}

Document types

Enum	Description	Required
`surety_civil_status_declaration`	Surety civil status declaration.	Yes
`surety_personal_document`	Surety personal document.	Yes
`surety_income_tax_declaration`	Surety income tax declaration.	Yes
`others`	Other documents.	-

Insurance (`insurance`)

Request Body

{
    "collateral_document_key": "25dd10b8-7364-4abe-b0e8-0e419b04194b",
    "collateral_type": "insurance",
    "additional_documents": [
        { "document_type": "insurance_policy_endorsed", "document_key": "1bffe8c6-0a54-4854-b693-745b3dba9e04" },
        { "document_type": "insurance_policy_with_expiration_and_renewal", "document_key": "1bffe8c6-0a54-4854-b693-745b3dba9e04" }
    ]
}

Document types

Enum	Description	Required
`insurance_policy_endorsed`	Endorsed insurance policy.	Yes
`insurance_policy_with_expiration_and_renewal`	Insurance policy with expiration and renewal.	Yes
`others`	Other documents.	-

Guarantee monitoring (`monitoring_guarantee`)

Request Body

{
    "collateral_document_key": "25dd10b8-7364-4abe-b0e8-0e419b04194b",
    "collateral_type": "monitoring_guarantee",
    "additional_documents": [
        { "document_type": "guarantee_contract", "document_key": "1bffe8c6-0a54-4854-b693-745b3dba9e04" },
        { "document_type": "guarantee_agent_contract", "document_key": "1bffe8c6-0a54-4854-b693-745b3dba9e04" }
    ]
}

Document types

Enum	Description	Required
`guarantee_contract`	Guarantee contract.	Yes
`guarantee_agent_contract`	Guarantee agent contract.	Yes
`others`	Other documents.	-

Request Body Params

Field	Type	Description	Required
`collateral_document_key` *	string	Key of the collateral instrument document.	Yes
`collateral_type` *	string	Collateral type.	collateral_type Enumerators
`additional_documents`	array	Additional collateral documents.	-

additional_documents

Field	Type	Description	Required
`document_key` *	string	Document key.	Yes
`document_type` *	string	Document type.	Yes

collateral_type Enumerators

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/inventory.
`fiduciary_alienation_artwork`	Fiduciary alienation of artwork.
`fiduciary_alienation_securities`	Fiduciary alienation of securities.
`fiduciary_assignment_shares`	Fiduciary assignment of shares/quotas.
`mortgage_property`	Property mortgage.
`mortgage_ship`	Ship mortgage.
`guarantor`	Guaranty (aval).
`surety`	Surety.
`insurance`	Insurance.
`monitoring_guarantee`	Guarantee monitoring.
`bank_surety`	Bank surety.
`fiduciary_assignment_credit_rights`	Fiduciary assignment of credit rights.
`card_receivables`	Card receivables.
`stock_guarantee`	Inventory guarantee.
`others`	Other collaterals.

Response

The response body is a complete JSON of the updated operation, with the new collateral in collateral_list.

Request​

Path Params​

Collateral types​

Fiduciary alienation of property (fiduciary_alienation_property)​

Document types​

Fiduciary alienation of vehicle (fiduciary_alienation_vehicle)​

Document types​

Fiduciary alienation of aircraft (fiduciary_alienation_aircraft)​

Document types​

Fiduciary alienation of equipment/products/inventory (fiduciary_alienation_equipment)​

Document types​

Fiduciary alienation of artwork (fiduciary_alienation_artwork)​

Document types​

Fiduciary alienation of securities (fiduciary_alienation_securities)​

Document types​

Fiduciary assignment of shares/quotas (fiduciary_assignment_shares)​

Document types​

Property mortgage (mortgage_property)​

Document types​

Ship mortgage (mortgage_ship)​

Document types​

Guaranty (aval) (guarantor)​

Document types​

Surety (surety)​

Document types​

Insurance (insurance)​

Document types​

Guarantee monitoring (monitoring_guarantee)​

Document types​

Request Body Params​

additional_documents​

collateral_type Enumerators​

Response​

Request

Path Params

Collateral types

Fiduciary alienation of property (`fiduciary_alienation_property`)

Document types

Fiduciary alienation of vehicle (`fiduciary_alienation_vehicle`)

Document types

Fiduciary alienation of aircraft (`fiduciary_alienation_aircraft`)

Document types

Fiduciary alienation of equipment/products/inventory (`fiduciary_alienation_equipment`)

Document types

Fiduciary alienation of artwork (`fiduciary_alienation_artwork`)

Document types

Fiduciary alienation of securities (`fiduciary_alienation_securities`)

Document types

Fiduciary assignment of shares/quotas (`fiduciary_assignment_shares`)

Document types

Property mortgage (`mortgage_property`)

Document types

Ship mortgage (`mortgage_ship`)

Document types

Guaranty (aval) (`guarantor`)

Document types

Surety (`surety`)

Document types

Insurance (`insurance`)

Document types

Guarantee monitoring (`monitoring_guarantee`)

Document types

Request Body Params

additional_documents

collateral_type Enumerators

Response