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

Request

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

Headers

Authorizationstring required

This endpoint works with any of the access tokens provided. You can use an access token obtained through the Client Credentials flow, the Authorization Code flow, or the Refresh Token flow.

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 65 revisions of this API.