Download a document for the employee

Authentication

This endpoint requires the following token type:

Employee-scoped access token (OAuth2Assertion) — obtained through the urn:ietf:params:oauth:grant-type:jwt-bearer grant. See Authentication for partners.

Scopes

Category	Read only Scope	Write only Scope (read access implicit)
Manage employment documents (employment_documents)	View documents (document:read)	Manage documents (document:write)

get/v1/employee/documents/{id}

Request

Base URL: https://gateway.remote.com
URL: https://gateway.remote.com/v1/employee/documents/{id}
Auth: OAuth 2 (client credentials, token URL /auth/oauth2/token, scopes: https://gateway.remote.com/employment.manage, document:read, document:write, employment_documents, all:write, all:read)

Path parameters

idstring required

Document ID

Response

Success

Example response

{
  "data": {
    "document": {
      "content": "data:application/pdf;base64,iVBORw0KGgoAAAANSUhEUgAAAJUAAACVCAYAAABRorhPAAAAGXRFWHRTb2Z0d2FyZQBBZG9iZSBJbWF...",
      "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.