---
title: "List pre-onboarding document requirements for an employment"
method: GET
path: "/v1/onboarding/employments/{employment_id}/pre-onboarding-document-requirements"
tags: ["Pre-Onboarding Documents"]
deprecated: true
---

# List pre-onboarding document requirements for an employment

`GET /v1/onboarding/employments/{employment_id}/pre-onboarding-document-requirements`

> **Deprecated.**

Returns the list of pre-onboarding document requirements (e.g. master service agreements,
individual labour agreements) that must be fulfilled before the given employment can be onboarded.

Deprecated: use `GET /onboarding/employments/:employment_id/pre-onboarding-requirements` instead,
which returns both document and acknowledgement requirements.


## Scopes

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

## Path parameters

- `employment_id` string, required

## Response `200`

Success

- IndexPreOnboardingDocumentRequirementsResponse — List of pre-onboarding document requirements for an employment.
  - `data` PreOnboardingDocumentRequirement[], required
    - `depends_on_requirement` PreOnboardingDocumentRequirement — recursive
    - `description` string, required — Human-readable description of the requirement.
    - `document_constraints_ack_at` string, date-time, nullable — Timestamp when the customer acknowledged the constraints (if any).
    - `freeze_employment_data` boolean, nullable — Whether the employment data is frozen because a document for this requirement exists.
    - `name` string, required — Human-readable name of the requirement.
    - `needs_constraints_ack` boolean, required — Whether the customer must acknowledge the hiring constraints of the country before creating a document.
    - `redlining_help_email` string, nullable — Email address to contact for help with redlining when supported.
    - `slug` string, uuid, required — Identifier of the employment being terminated.
    - `status` 'blocked' | 'awaiting_signatures' | 'finished' | 'revised', nullable — Current status of this requirement for the given employment.
    - `supports_redlining` boolean, required — Whether the requirement supports redlining (collaborative editing) of the generated document.

## Other responses

- `401` — Unauthorized
- `403` — Forbidden
- `404` — Not Found

---

[API](https://skmtc.net/remote-com/apis/remote.md) · [All operations](https://skmtc.net/remote-com/apis/remote/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/remote-com/remote/revisions/7e6a0c61ac82/schema)