v1

latestOpenAPI 3.1.02026-07-242735131.1 MB

Pre-Onboarding Documents

Retrieve a pre-onboarding document with its rendered PDF content

Returns the rendered contract PDF (base64-encoded) and the list of signatories for the given pre-onboarding document. The content field is prefixed with data:application/pdf;base64, so it can be embedded directly in a document viewer.

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/onboarding/employments/{employment_id}/pre-onboarding-documents/{id}

Path parameters

employment_idstring required

Employment ID

idstring required

Pre-onboarding document ID

Response

Success

Example response

{
  "data": {
    "pre_onboarding_document": {
      "content": "data:application/pdf;base64,JVBERi0xLjQK...",
      "name": "Master Service Agreement.pdf",
      "signatories": [
        {
          "email": "john@example.com",
          "name": "John Doe",
          "signature": "data:image/png;base64,iVBORw0KGgo...",
          "signed_at": "2024-01-15T10:30:00Z",
          "status": "signed",
          "type": "employee",
          "user_id": "0073fcb5-b669-4e4a-b963-2a47744e75a1"
        }
      ],
      "status": "draft"
    }
  }
}