REremote-com
Pre-Onboarding Documents

Sign a pre-onboarding document

Signs the latest contract document associated with the given pre-onboarding document on behalf of the company signatory.

Authentication

This endpoint accepts any one of the following token types:

  • Company-scoped access token (OAuth2AuthorizationCode) — obtained by a company manager through the Authorization Code flow or the Refresh Token flow. See Authentication for partners.
  • Company-scoped access token (assertion) (OAuth2CompanyManagerAssertion) — obtained through the urn:ietf:params:oauth:grant-type:jwt-bearer grant for a company manager. See OAuth Assertion.
  • Customer API token (CustomerAPIToken) — generated by the customer on their Integration Settings page, with the scopes they choose there. See Authorization for customers.

Scopes

Any one of the scopes in a token type's row is enough. all:write works too.

Token typeCategoryRead only ScopeWrite only Scope (read access implicit)
Company-scoped access tokenManage employment documents (employment_documents)-Manage documents (document:write)
Company-scoped access token (assertion)Manage employment documents (employment_documents)-Manage documents (document:write)
Customer API tokenManage employment documents (employment_documents)-Manage documents (document:write)
post/v1/onboarding/employments/{employment_id}/pre-onboarding-documents/{id}/sign

Request

  • Base URL
    https://gateway.remote.com
  • URL
    https://gateway.remote.com/v1/onboarding/employments/{employment_id}/pre-onboarding-documents/{id}/sign
  • Auth
    • OAuth 2
      Authorization code: /auth/oauth2/authorize
      Token URL: /auth/oauth2/token scopes: https://gateway.remote.com/company.manage
    • or OAuth 2
      Authorization code: /auth/oauth2/authorize
      Token URL: /auth/oauth2/token scopes: document:write
    • or OAuth 2
      Authorization code: /auth/oauth2/authorize
      Token URL: /auth/oauth2/token scopes: all:write
    • or OAuth 2
      Client credentials
      Token URL: /auth/oauth2/token scopes: document:write
    • or OAuth 2
      Client credentials
      Token URL: /auth/oauth2/token scopes: all:write
    • or HTTP bearer

Path parameters

employment_idstring required

Employment ID

idstring required

Pre-onboarding document ID

Request body

signaturestring required

The signer's full legal name as their electronic signature.

Example request

{
  "signature": "Don Van Vliet"
}

Response

Success

Example response

{
  "data": {
    "status": "ok"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.