Assignment Collateral
Overview
The assignment_documents report lists the supporting documents of the assets of a specific assignment, with a download link for each file. It is the report used to archive the collateral of the operation: one line per document, with the key of the asset it belongs to.
It is the complement of the Assignment Assets Composition: that one carries the values and characteristics of the assigned assets, this one carries the files that support them.
What you need to provide
| Variable | Required | Description |
|---|---|---|
fund_class_key | yes | Identifier of the fund class of the assignment. |
external_id | yes | Your own reference number for the assignment to be queried. |
This report does not take a reference date — it always reflects the documents that exist at the moment of generation.
File Structure
| Attribute | Value |
|---|---|
| Format | CSV |
| Encoding | UTF-8 |
| Delimiter | , (comma) |
| Header | Yes (first line) |
| Naming | {short_fund_name}_assignment_documents_{external_id}_{YYYY-MM-DD}.csv |
Two differences in relation to the other reports:
- the assignment identifier comes before the date, and not at the end of the name — compare with
assignment_assets_wallet_composition, which appends theexternal_idat the end; - the date in the name is the file generation date (Brasília time zone), not a reference date provided by you. Generating the same report on two different days produces two different names for the same content.
Columns
| Column | Type | Format / Example | Description |
|---|---|---|---|
assignment_external_id | string | "CESSAO-2026-07-29-001" | External identifier of the assignment. The same on all the lines of the file. |
asset_key | string | "1a2b3c40-0001-4aaa-9111-000000000101" | Internal key of the asset generated by QI Tech (UUID). It repeats when the asset has more than one document. |
asset_external_id | string | "10a20b30-0001-4bbb-9222-000000000201" | External identifier of the asset. |
document_key | string | "50e60f70-0001-4fff-9666-000000000601" | Internal key of the document generated by QI Tech (UUID). |
document_type | string (enum) | "ccb", "duplicata_mercantil", "duplicata_servicos", "discounted_contract", "cte", "invoice" | Document type. It follows the asset type, except for invoice, which is the invoice of the receivable. |
document_url | string | "https://...s3.amazonaws.com/...?X-Amz-Signature=..." | Direct download link of the file. See the warning about validity below. |
document_url is a pre-signed URL, generated at the moment the report is produced and valid for 5 days (432,000 seconds). After that the link returns an error and the report has to be generated again to obtain new links.
Do not store the URLs as a permanent reference to the document. If you need to keep the collateral, download the files within the validity window and use document_key as the stable identifier of the document.
To exercise the download in sandbox with real links — and with example documents of each document_type — follow the walkthrough in Testing the Collateral Capture.
What the report carries
- The documents of all the assets of the provided assignment, except those of the discarded (
discarded) and denied (denied) assets. - One line per document. An asset with a contract and an invoice appears in two lines, with the same
asset_keyand differentdocument_type. - Assets without an attached document do not appear in the file.
asset_external_id and asset_key are the join keys with the Assignment Assets Composition. By cross-referencing the two files you check whether every assigned asset has the corresponding collateral — an asset present in the composition and absent here is an asset without an attached document.