Agreement Document Item
Return a single agreement document record by its entity ID.
Available to: All authenticated users
Environments: Demo, Live
Rate Limit: No endpoint-specific limit
Returns one AgreementDocument entity. Identify it with the id query parameter (the integer entity ID). An agreement document ties a customer application to one agreement required for it: customerApplicationId identifies the application, agreementDocumentTemplateId identifies the template the document was generated from, and locale records the document’s language. The timestamp field marks when the record was created, and signedTimestamp appears once the document has been signed — an unsigned document has no signedTimestamp.
The platform creates these records when you call prepareAgreementDocuments for a customer application; you can’t create or modify them directly through the API. Pass their IDs to signAgreementDocuments as agreementIds when the applicant signs, and download the generated PDF with getAgreementDocument.
The endpoints that create and populate agreement documents — startCustomerApplication and prepareAgreementDocuments — are available on Live only, so you’ll typically query these records on the Live environment.
To fetch several records at once by ID, use agreementDocumentItems. To list every agreement document for a customer application, use agreementDocumentDependents.
Common Failure Scenarios
- The
iddoesn’t exist or isn’t accessible to the calling user (returnsHTTP 404). - The access token is missing or invalid (returns
HTTP 401).
Authentication
Bearer authentication of the form Bearer <token>, where token is your auth token.