Employments
Pre-Onboarding Requirements

Find or create a document for a pre-onboarding requirement

Changed on

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.

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-requirements/{requirement_slug}/documents

Request

  • Base URL: https://gateway.remote.com
  • URL: https://gateway.remote.com/v1/onboarding/employments/{employment_id}/pre-onboarding-requirements/{requirement_slug}/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

requirement_slugstring required

Pre-onboarding requirement slug

Query parameters

skip_initial_signature_emailboolean

When true, skips the email that asks the company signatory to sign the newly created document. Signature reminders are still sent while the document remains unsigned.

The company signatory is the authenticated user when they are allowed to sign, otherwise the company's legal representative or owner. This parameter only takes effect when the signatory is the authenticated user, who is about to sign the document themselves. When the signatory is someone else, they are emailed right away as usual, since they still need to know about the document.

Response

Success

Example response

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

Changes