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

ENDPOINT

/commercial_paper/operation/OPERATION-KEY/collateral

METHOD

POST

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

9 - Property mortgage

10 - Ship mortgage

11 - Guarantee

12 - Guarantor

13 - Bank surety

14 - Card receivables

15 - Stock guarantee

16 - Collateral monitoring

17 - Other collaterals

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.

warning

(**) 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.

warning

(**) 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.

warning

(**) 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.

warning

(**) 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.

warning

(**) 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.

warning

(**) 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.

warning

(**) 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.

warning

(**) 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.

warning

(**) 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.

warning

(**) 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.

warning

(**) 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.

warning

(**) Required for Collateral Monitoring.

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.
`others`	Other collaterals.

Send Collateral (POST)​

Request​

Path Params​

Collateral Types​

Fiduciary alienation of property​

Document Types​

Fiduciary alienation of vehicle​

Document Types​

Fiduciary alienation of aircraft​

Document Types​

Fiduciary alienation of equipment products and stock​

Document Types​

Fiduciary alienation of artwork​

Document Types​

Fiduciary alienation of securities​

Document Types​

Fiduciary alienation of shares and quotas​

Document Types​

Fiduciary alienation of credit rights​

Document Types​

Property mortgage​

Document Types​

Ship mortgage​

Document Types​

Guarantee​

Document Types​

Guarantor​

Document Types​

Bank surety​

Document Types​

Card receivables​

Document Types​

Stock guarantee​

Document Types​

Collateral monitoring​

Document Types​

Request Body Params​

additional_documents list​

collateral_type Enums​

Send Collateral (POST)

Request

Path Params

Collateral Types

Fiduciary alienation of property

Document Types

Fiduciary alienation of vehicle

Document Types

Fiduciary alienation of aircraft

Document Types

Fiduciary alienation of equipment products and stock

Document Types

Fiduciary alienation of artwork

Document Types

Fiduciary alienation of securities

Document Types

Fiduciary alienation of shares and quotas

Document Types

Fiduciary alienation of credit rights

Document Types

Property mortgage

Document Types

Ship mortgage

Document Types

Guarantee

Document Types

Guarantor

Document Types

Bank surety

Document Types

Card receivables

Document Types

Stock guarantee

Document Types

Collateral monitoring

Document Types

Request Body Params

additional_documents list

collateral_type Enums