Document Insertion

Sends the amendment term of an amendment in pending_document. Once the document is received, the amendment moves to pending_approval.

It is only accepted when the amendment pipeline requires a document (amendment_configuration.requires_document: true). In a pipeline that does not require a document, the API returns AAM000038.

Available on

Profile	Host	Required permission
Consultant	consultant-api	Batches
Assignor	assignor-api	Write

Base URL for each host: Environments (Hosts).

Manager

manager-api does not expose this endpoint. See what to do with a manager's amendment stuck in pending_document in Amendment Request Creation.

Request

ENDPOINT

/asset_amendment/fund_class/FUND_CLASS_KEY/amendment_configuration/AMENDMENT_CONFIGURATION_KEY/asset_amendment/ASSET_AMENDMENT_KEY/document

METHOD

POST

Request Body

{
    "document_type": "amendment_term",
    "document_b64": "JVBERi0xLjQKJcOkw7zDtsOfCjIgMCBvYmoKPDwvTGVuZ3RoIDMgMCBSPj4Kc3RyZWFtCg=="
}

Body Params

Field	Type	Description
document_type *	string	Document type. Only accepted value: amendment_term
document_b64 *	string	PDF file of the amendment term, encoded in Base64

Response

STATUS

201

The response is the updated amendment, in the same format as the request creation.

Response Body

{
    "asset_amendment_key": "a914aac6-93ff-45ee-8574-f4dbaf6c0642",
    "status": "pending_approval",
    "amendment_type": "all_contract",
    "amendment_configuration": {
        "amendment_configuration_key": "5f0d3a52-8c1e-4b8e-9a51-2f6a8f0c1d22",
        "fund_class": {
            "fund_class_key": "<fund_class_key>",
            "document_number": "11.222.333/0001-81",
            "name": "FUNDO EXEMPLO FIDC",
            "manager": {
                "manager_key": "<manager_key>",
                "document_number": "22.333.444/0001-81",
                "manager_name": "GESTORA EXEMPLO LTDA"
            },
            "accounting_date": "2024-04-01"
        },
        "requires_document": true
    },
    "asset_type": "ccb",
    "asset_key": "0b6f6c55-5d1b-4b6e-8f3a-6c1f0f7f2b10",
    "amendment_date": "2024-04-01",
    "asset_external_id": "931e9437-d025-41ab-bb53-6b94e10fd361",
    "source": "api_integration",
    "status_history": [
        {
            "status": "pending_document",
            "event_datetime": "2024-04-01T13:02:45Z"
        },
        {
            "status": "pending_approval",
            "event_datetime": "2024-04-01T13:10:02Z"
        }
    ]
}

Errors

Status	Code	When it happens
400	AAM000038	The amendment pipeline does not require a document
400	AAM000026	document_type other than amendment_term
400	AAM000025	document_b64 is not valid Base64
404	AAM000009	Amendment not found for this fund and this pipeline

Authentication, permission and host errors: see API errors.