Skip to main content

List all active stipulations for a creditor application

GET 
/applications/:applicationId/creditors/:creditorId/stipulations

Retailers and integrations authorized for that retailer can access stipulations regardless of user assignment. Hidden stipulations are excluded. Creditor visibility follows the portal resolver: retailer-originated deals expose submitted documents and requirements available to sign or generating; creditor-owned deals retain their existing visibility. Projection updates after uploads are eventually consistent.

This endpoint never returns file contents or download URLs. Each stipulation can carry two kinds of files, and each is fetched from the document download endpoint using the stipulation's id plus a document ID:

  • Generated document — the PDF CreditApp produces from the creditor's document template (for example a CONTRACT stipulation's contract). It is not listed in documents; its presence is signalled by generatedDocumentAvailable. Download it with the literal document ID generated.
  • Uploaded documents — files a user or integration attached to the stipulation. Each appears in documents with its own id, which is the document ID to download it with when downloadAvailable is true.

A stipulation whose generatedDocumentAvailable is true and whose documents array is empty therefore does have a downloadable file: the generated one.

Request​

Responses​

The complete list of active stipulations