REremote-com
Files

Upload file

Uploads a file associated with a specified employment.

Please contact api-support@remote.com to request access to this endpoint.

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

Request

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

Headers

Authorizationstring required

An access token of one of the types listed in this endpoint's Authentication section, as Bearer <ACCESS TOKEN>.

A token from the Refresh Token flow is of the same type as the token issued with that refresh token.

Request body multipart/form-data

employment_idstring required

The unique identifier (UUID) of the employment to attach this file to.

filestring binary required

The file content, base64-encoded.

sub_typestring

A more specific classification within the type (e.g., "ir_35" for a UK contractor tax determination).

typestring

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

Example request

{
  "employment_id": "5e55386e-4f4f-4def-92f4-bdc19a5ce77d",
  "file": "base64_encoded_file_content",
  "sub_type": "ir_35",
  "type": "contract"
}

Response

Success

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.