Get Localized Agreement Document

View as Markdown
### Download the localized PDF content of an agreement document template. **Available to:** All authenticated users **Environments:** Live **[Rate Limit](/overview/core-concepts/rate-limits):** No endpoint-specific limit Retrieve the PDF for a specific language version of an agreement document template. Agreement document templates can carry one localized PDF rendition per locale; use this endpoint to display an agreement in the applicant's language. Identify the rendition with `localizedAgreementDocumentTemplateContentId` — the entity ID of a `LocalizedAgreementDocumentTemplateContent` record, which links an agreement document template (see [`agreementDocumentTemplateItem`](/api/rest-api-endpoints/users/agreement-document-template-item)) to the PDF content for one locale. For the default (non-localized) document generated for a customer application, use [`getAgreementDocument`](/api/rest-api-endpoints/users/get-agreement-document) instead. On success, the response's `content` field holds the Base64-encoded PDF and `filename` combines the template name with the content's timestamp (e.g., `TemplateName.20260715.093000.pdf`). On failure, `errorText` describes the problem and the other fields are absent — always check `errorText` before decoding the content. **Common Failure Scenarios** - The `localizedAgreementDocumentTemplateContentId` doesn't match an existing localized content record. - The request was sent to the Demo environment. **Error Messages** | `errorText` | Trigger | |-------------|---------| | `"The template is not assigned with PDF content."` | No localized content record exists for the given ID | | `"This endpoint should be called on live.tradovateapi.com"` | Called on the Demo environment |

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.
localizedAgreementDocumentTemplateContentIdlongRequired

Response

DocumentContentResponse
errorTextstring<=8192 characters

Non-empty if the request failed

filenamestring<=64 characters
contentstring<=8192 characters