Inserção de documentos

Envia o termo de aditamento de um aditamento em pending_document. Com o documento recebido, o aditamento passa para pending_approval.

Só é aceito quando a esteira de aditamento exige documento (amendment_configuration.requires_document: true). Em esteira sem exigência de documento, a API devolve AAM000038.

Disponível em

Perfil	Host	Permissão exigida
Consultoria	consultant-api	Lotes
Cedente	assignor-api	Escrita

URL base de cada host: Ambientes (Hosts).

Gestora

A manager-api não expõe este endpoint. Veja o que fazer com um aditamento da gestora parado em pending_document em Criação de pedido de aditamento.

Request

ENDPOINT

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

MÉTODO

POST

Request Body

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

Body Params

Campo	Tipo	Descrição
document_type *	string	Tipo do documento. Único valor aceito: amendment_term
document_b64 *	string	Arquivo PDF do termo de aditamento, codificado em Base64

Response

STATUS

201

A resposta é o aditamento atualizado, no mesmo formato da criação do pedido.

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"
        }
    ]
}

Erros

Status	Código	Quando acontece
400	AAM000038	A esteira de aditamento não exige documento
400	AAM000026	document_type diferente de amendment_term
400	AAM000025	document_b64 não é um Base64 válido
404	AAM000009	Aditamento não encontrado para esse fundo e essa esteira

Erros de autenticação, permissão e host: veja Erros da API.