REremote-com
Employee Files

Upload employee file

Uploads a file owned by the authenticated employee, for example identity documents or tax forms.

Authentication

This endpoint accepts any one of the following token types:

  • Employee-scoped access token (OAuth2Assertion) — obtained through the urn:ietf:params:oauth:grant-type:jwt-bearer grant. See OAuth Assertion.
  • Company-scoped access token (OAuth2AuthorizationCode) — obtained by the employee through the Authorization Code flow or the Refresh Token flow. See Authentication for partners.

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)
Employee-scoped access tokenManage employment documents (employment_documents)-Manage documents (document:write)
Company-scoped access tokenManage employment documents (employment_documents)-Manage documents (document:write)
post/v1/employee/documents

Request

  • Base URL
    https://gateway.remote.com
  • URL
    https://gateway.remote.com/v1/employee/documents
  • Auth
    • 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 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

Request body multipart/form-data

filestring binary required

The file content, base64-encoded.

sub_typestring

A more specific classification within the type.

typestring

The broad category of the file (e.g., "id", "tax_document").

Example request

{
  "file": "base64_encoded_file_content",
  "sub_type": "passport",
  "type": "id"
}

Response

Created

Example response

{
  "data": {
    "file": {
      "id": "9880b711-file-id-ecf8f551bd78",
      "inserted_at": "2021-07-15T18:18:17Z",
      "name": "id.pdf",
      "sub_type": "personal_id",
      "type": "id"
    }
  }
}

Changes

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