v1

latestOpenAPI 3.1.02026-07-242735131.1 MB

Pre-Onboarding Documents

List pre-onboarding document requirements for an employment

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)

get/v1/onboarding/employments/{employment_id}/pre-onboarding-document-requirements

Path parameters

employment_idstring required

Employment ID

Response

Success

Example response

{
  "data": [
    {
      "depends_on_requirement": null,
      "description": "Agreement governing the overall terms of service for the engagement.",
      "document_constraints_ack_at": "2024-01-15T10:30:00Z",
      "freeze_employment_data": true,
      "name": "Master Service Agreement",
      "needs_constraints_ack": false,
      "redlining_help_email": "redlining-help@remote.com",
      "slug": "663e0b79-c893-45ff-a1b2-f6dcabc098b5",
      "status": "awaiting_signatures",
      "supports_redlining": true
    }
  ]
}