Skip to navigation
REST API EndpointsCustomer Applications

Download User Document Preview

View as Markdown

Return a funding-disclosure document as a base64 PDF for the user to read.

Available to: All authenticated users

Environments: Live

Rate Limit: No endpoint-specific limit

Send the agreementDocumentTemplateId of the document the funding flow requires. The response returns the rendered PDF in content, base64-encoded. There is no URL to link to — decode the payload and display it in your own viewer.

Send pdfFields as {} for both funding disclosures. The field exists for templates that take filled values; neither funding disclosure does.

Resolve the template ID at runtime from agreementDocumentTemplateList, matching on the document name and preferring the row whose clearingHouseId matches the account’s. The same document carries a different ID in each environment and for each clearing house, so an ID that works in one place will fetch the wrong document — or nothing — in another.

Warning: A successful response is not evidence the user saw the document. Enable your sign control only once the PDF has actually rendered. Collecting a signature on a disclosure that silently failed to display is the failure mode this endpoint exists to prevent.

Not every template can be previewed here. A template that is not enabled for generic preview is refused by name rather than returning an empty document.

Common Failure Scenarios

  • The template is not enabled for preview through this endpoint
  • The agreementDocumentTemplateId belongs to another clearing house, or to another environment
  • The ID was hard-coded from a different environment

Error Messages

MessageResponseTrigger
"This endpoint does not support previewing <template name>"200 (in errorText)The template is not enabled for generic preview.
"Access is denied"401The session is not permitted to read document content.

Related Endpoints

  • Use agreementDocumentTemplateList to resolve the template ID by name.
  • Use signUserDocument to record the signature once the user has read the document.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
agreementDocumentTemplateIdlongRequired
pdfFieldsobjectRequired

Response

DownloadUserDocumentPreviewResponse
errorTextstringOptional<=8192 characters

Non-empty if the request failed

contentstringOptional<=8192 characters