Agreement Document L Dependents
List the agreement documents belonging to multiple customer applications.
Available to: All authenticated users
Environments: Demo, Live
Rate Limit: No endpoint-specific limit
Returns the AgreementDocument entities attached to several customer applications in one call. Identify the applications with the masterids query parameter — a comma-separated list of CustomerApplication entity IDs. The response contains one record per agreement prepared for each of those applications; use each record’s customerApplicationId to group the results by application.
Each record reports the application it belongs to (customerApplicationId), the template the document was generated from (agreementDocumentTemplateId), and the document’s language (locale). 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 list the agreement documents for a single application, use agreementDocumentDependents. To fetch specific records by their entity IDs, use agreementDocumentItems.
Common Failure Scenarios
- A
masteridscustomer application doesn’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.