Employments
Pre-Onboarding Documents

Find or create a pre-onboarding document for an employment

Changed on

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.

Authentication

This endpoint accepts any one of the following token types:

  • Company-scoped access token (OAuth2AuthorizationCode) — obtained through the Authorization Code flow or the Refresh Token flow. See Authentication for partners.
  • Customer API token (CustomerAPIToken) — generated by the customer on their Integration Settings page. See Authorization for customers.

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-documents

Request

  • Base URL: https://gateway.remote.com
  • URL: https://gateway.remote.com/v1/onboarding/employments/{employment_id}/pre-onboarding-documents
  • Auth: HTTP bearer and OAuth 2 (authorization code, authorization URL /auth/oauth2/authorize, token URL /auth/oauth2/token, scopes: https://gateway.remote.com/company.manage, document:write, employment_documents, all:write)

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

Slug of the pre-onboarding document requirement to fulfil. Obtain this from the GET .../pre-onboarding-document-requirements endpoint.

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"
    }
  }
}

Changes

  • 80e3dace341eRevision changes
    • breaking

      the request property type changed from no type to string, and format from no format to uuid

    • warning

      removed from the request property allOf list

  • 368362078830Revision changes
    • breaking

      added to the request property allOf list

    • breaking

      the request property type changed from string to no type, and format from uuid to no format

    • info

      endpoint deprecated