Employments
Pre-Onboarding Requirements

Acknowledge a pre-onboarding acknowledgement requirement

Changed on

Records an acknowledgement for an acknowledgement requirement. Rejected if the requirement is blocked by an unmet dependency or has already been acknowledged.

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}/acknowledge

Request

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

Response

Success

Example response

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

Changes