Agreement Document L Dependents

View as Markdown
### List the agreement documents belonging to multiple customer applications. **Available to:** All authenticated users **Environments:** Demo, Live **[Rate Limit](/overview/core-concepts/rate-limits):** 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`](/api/rest-api-endpoints/users/prepare-agreement-documents) for a customer application; you can't create or modify them directly through the API. Pass their IDs to [`signAgreementDocuments`](/api/rest-api-endpoints/users/sign-agreement-documents) as `agreementIds` when the applicant signs, and download the generated PDF with [`getAgreementDocument`](/api/rest-api-endpoints/users/get-agreement-document). <Note> The endpoints that create and populate agreement documents — [`startCustomerApplication`](/api/rest-api-endpoints/users/start-customer-application) and [`prepareAgreementDocuments`](/api/rest-api-endpoints/users/prepare-agreement-documents) — are available on Live only, so you'll typically query these records on the Live environment. </Note> To list the agreement documents for a single application, use [`agreementDocumentDependents`](/api/rest-api-endpoints/users/agreement-document-dependents). To fetch specific records by their entity IDs, use [`agreementDocumentItems`](/api/rest-api-endpoints/users/agreement-document-items). **Common Failure Scenarios** - A `masterids` customer application doesn't exist or isn't accessible to the calling user (returns `HTTP 404`). - The access token is missing or invalid (returns `HTTP 401`).

Authentication

AuthorizationBearer

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

Query parameters

masteridslist of longsRequired
List of CustomerApplication entity IDs

Response

AgreementDocument
customerApplicationIdlong
timestampdatetime
agreementDocumentTemplateIdlong
idlong
signedTimestampdatetime
localestring<=64 characters