Skip to main content

List all active stipulations for a creditor application

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.

Path Parameters
applicationId string — REQUIRED
creditorId string — REQUIRED
Header Parameters
X-CreditApp-Creditor-ID uuid
Responses
200

The complete list of active stipulations

Schema — OPTIONAL
object[]
id string

Stipulation identifier. Pass it verbatim as stipulationId to the document download endpoint.

applicantId string,null — OPTIONAL
title string
documentTitle string
type string
subType string
status string
externalId string,null — OPTIONAL
externalStatus string,null — OPTIONAL
externalInvalidReason string,null — OPTIONAL
externalVerifiedAt string,null — OPTIONAL
titleLocalizations object[] — OPTIONAL
language string

Possible values: [EN, FR]

value string
documentTitleLocalizations object[] — OPTIONAL
language string

Possible values: [EN, FR]

value string
blockedReason object[] — OPTIONAL
language string

Possible values: [EN, FR]

value string
blocksContractGeneration boolean,null — OPTIONAL
generatedDocumentAvailable boolean

True when CreditApp has generated a document from the stipulation's template (for example the contract PDF). The generated document is not listed in documents; download it with document ID generated.

documents object[]

Documents uploaded to the stipulation. Empty when nothing has been uploaded, even if a generated document is available.

id string

Uploaded document identifier. Pass it as documentId to the document download endpoint.

fileName string,null — OPTIONAL
status string
createdAt string,null — OPTIONAL
submittedAt string,null — OPTIONAL
downloadAvailable boolean

True when the uploaded file is stored and can be downloaded.

403

Access denied

404

Application or creditor application not found