Get Agreement Document
Authentication
Bearer authentication of the form Bearer <token>, where token is your auth token.
Request
Response
Non-empty if the request failed
Bearer authentication of the form Bearer <token>, where token is your auth token.
Non-empty if the request failed
Available to: All authenticated users
Environments: Live
Rate Limit: No endpoint-specific limit
Retrieve the generated PDF for an agreement document tied to a customer application. Use this endpoint to display an agreement to an applicant before signing, or to archive a copy of a signed document for your records.
Identify the document with agreementDocumentId — the entity ID of an AgreementDocument record. The platform creates these records when you call prepareAgreementDocuments for a customer application, and you can list them with agreementDocumentDependents using the CustomerApplication entity ID.
On success, the response’s content field holds the Base64-encoded PDF and filename holds a name derived from the document’s template (e.g., TemplateName.pdf). On failure, errorText describes the problem and the other fields are absent — always check errorText before decoding the content.
Common Failure Scenarios
agreementDocumentId doesn’t exist or isn’t accessible to the calling user.Error Messages