v1

latestOpenAPI 3.1.02026-07-242735131.1 MB

Employment Agreements

Preview the Employment Agreement for an employment

Returns a base64-encoded PDF preview of the auto-generated Employment Agreement for an employment.

The document is rendered as a draft (no signatures) and is not persisted. EA preview is only available for countries that have a published Employment Agreement automation template — see the employment_agreement_preview_available flag on the Countries endpoint.

Scopes

Category	Read only Scope	Write only Scope (read access implicit)
Manage employment documents (employment_documents)	View documents (document:read)	Manage documents (document:write)

get/v1/employments/{employment_id}/employment-agreement/preview

Path parameters

employment_idstring required

Employment ID

Response

Success

Example response

{
  "data": {
    "employment_agreement": {
      "content": "data:application/pdf;base64,iVBORw0KGgoAAAANSUhEUgAAAJUAAACVCAYAAABRorhPAAAAGXRFWHRTb2Z0d2FyZQBBZG9iZSBJbWF...",
      "name": "employment_agreement.pdf"
    }
  }
}