Sign in

v1

latestOpenAPI 3.1.02026-07-242735131.1 MB
Pre-Onboarding Requirements

Find or create a document for a pre-onboarding requirement

Finds an existing unsigned pre-onboarding document for the given document requirement, or creates a new one. Idempotent: repeated calls return the same document until it is signed.

Scopes

CategoryRead only ScopeWrite only Scope (read access implicit)
Manage employment documents (employment_documents)-Manage documents (document:write)
post/v1/onboarding/employments/{employment_id}/pre-onboarding-requirements/{requirement_slug}/documents

Path parameters

employment_idstring required

Employment ID

requirement_slugstring required

Pre-onboarding requirement slug

Response

Success

Example response

{
  "data": {
    "pre_onboarding_document": {
      "id": "663e0b79-c893-45ff-a1b2-f6dcabc098b5"
    }
  }
}