v1

latestOpenAPI 3.1.02026-07-242735131.1 MB

Pre-Onboarding Documents

Find or create a pre-onboarding document for an employment

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

Deprecated: use POST /onboarding/employments/:employment_id/pre-onboarding-requirements/:requirement_slug/documents instead.

Scopes

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

post/v1/onboarding/employments/{employment_id}/pre-onboarding-documents

Path parameters

employment_idstring required

Employment ID

Request body

constraints_ack_atstring date-time nullable

Timestamp when the customer acknowledged the hiring constraints. Required when the requirement has needs_constraints_ack: true.

pre_onboarding_document_requirement_slugstring uuid required

Identifier of the employment being terminated.

Example request

{
  "pre_onboarding_document_requirement_slug": "663e0b79-c893-45ff-a1b2-f6dcabc098b5"
}

Response

Success

Example response

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