Agreement Document Items

View as Markdown
### Return multiple agreement document records by their entity IDs. **Available to:** All authenticated users **Environments:** Demo, Live **[Rate Limit](/overview/core-concepts/rate-limits):** No endpoint-specific limit Returns several `AgreementDocument` entities in one call. Identify them with the `ids` query parameter — a comma-separated list of integer entity IDs. Each record 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`](/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 fetch a single record by ID, use [`agreementDocumentItem`](/api/rest-api-endpoints/users/agreement-document-item). To list every agreement document for a customer application, use [`agreementDocumentDependents`](/api/rest-api-endpoints/users/agreement-document-dependents). **Common Failure Scenarios** - An ID in the list 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

idslist of longsRequired

Response

AgreementDocument
customerApplicationIdlong
timestampdatetime
agreementDocumentTemplateIdlong
idlong
signedTimestampdatetime
localestring<=64 characters