Assignment Documents

Retrieves the download links for the Assignment Term — both the original version and the signed version. This endpoint becomes available from the moment the Term is generated, i.e., after the batch reaches pending_assignment_term_signature status.

When to use

After receiving the webhook with status pending_assignment_term_signature, use this endpoint to obtain the Assignment Term link and track whether the signature has been completed.

Request

ENDPOINT

/trade_receivables/fund_class/{fund_class_key}/assignment_configuration/{assignment_configuration_key}/assignment/{assignment_external_id}/assignment_term_link

METHOD

GET

Path params

Parameter	Type	Description
fund_class_key	string	Unique fund key (UUID).
assignment_configuration_key	string	Assignment configuration key (UUID).
assignment_external_id	string	The external_id provided at batch creation.

Response

STATUS

200

Response Body

{
    "assignment_term_url": "https://storage.example.com/term/abc123.pdf",
    "signed_assignment_term_url": "https://storage.example.com/term/abc123_signed.pdf"
}

Response attributes

Field	Type	Description
assignment_term_url	string	URL that directs to the term signature page on CertifiQI.
signed_assignment_term_url	string | null	URL for the signed Assignment Term. Returns null while the document has not yet been signed by all parties.

Note

The signed_assignment_term_url field will be null while the Assignment Term has not yet been signed by all involved parties. After the signature is completed, the batch will advance to pending_payment status and a webhook will be sent.