Contractors
Contract Documents

Return a base64 encoded version of the contract document

Changed on

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)View documents (document:read)Manage documents (document:write)
get/v1/contractors/employments/{employment_id}/contract-documents/{id}

Request

  • Base URL: https://gateway.remote.com
  • URL: https://gateway.remote.com/v1/contractors/employments/{employment_id}/contract-documents/{id}
  • 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:read, document:write, employment_documents, all:write, all:read)

Path parameters

employment_idstring required

Employment ID

idstring required

Document ID

Response

Success

Example response

{
  "data": {
    "contract_document": {
      "content": "data:application/pdf;base64,iVBORw0KGgoAAAANSUhEUgAAAJUAAACVCAYAAABRorhPAAAAGXRFWHRTb2Z0d2FyZQBBZG9iZSBJbWF...",
      "name": "id.pdf",
      "signatories": [
        {
          "email": "john@example.com",
          "name": "John Doe",
          "signature": "data:image/png;base64,iVBORw0KGgo...",
          "signed_at": "2024-01-15T10:30:00Z",
          "status": "signed",
          "type": "employee",
          "user_id": "0073fcb5-b669-4e4a-b963-2a47744e75a1"
        }
      ],
      "status": "finished"
    }
  }
}

Changes

  • c9d3f8b8186aRevision changes
    • warning

      added the new deadline_passed enum value to the // response property for the response status