Skip to main content

Get a stipulation document download URL

GET 
/applications/:applicationId/creditors/:creditorId/stipulations/:stipulationId/documents/:documentId

Returns an S3 download URL valid for six hours. Fetch the returned url directly to receive the file as an attachment.

stipulationId is the id of an entry returned by the stipulation list endpoint, verbatim (for example <creditorId>_<applicantId>_CONTRACT_<templateId>). documentId selects which of that stipulation's files to download:

  • generated — the document CreditApp generated from the template. Available when the list entry reports generatedDocumentAvailable: true.
  • an id from the list entry's documents array — an uploaded document. Available when that document reports downloadAvailable: true.

Document IDs are scoped to the specified stipulation, application and creditor. Only documents visible to the caller can be downloaded; anything else returns 404.

Request​

Responses​

Download URL