WorkMotion Documents API

openapi: 3.0.3
info:
  title: WorkMotion Partner Absences Documents API
  description: 'Partner / Open API for the WorkMotion global employment and Employer of Record (EOR) platform. It exposes employees (talents), employment contracts, onboarding workflows, absences and time-off, documents, employment cost calculations, and webhook subscriptions so that HRIS and payroll systems can integrate with WorkMotion''s managed employment infrastructure across 160+ countries.

    NOTE: WorkMotion''s partner API is access-gated and its reference documentation is not fully published to the open web. The paths and schemas below are a faithful, honest model of the documented product surfaces (employees, contracts, onboarding, absences, documents, cost calculator, webhooks) rather than a verbatim copy of an official OpenAPI file. Verify exact paths, fields, and semantics against the WorkMotion partner documentation during reconciliation.'
  termsOfService: https://workmotion.com/terms-and-conditions/
  contact:
    name: WorkMotion
    url: https://workmotion.com/integrations/
  version: '1.0'
servers:
- url: https://api.workmotion.com/v1
  description: Production (modeled base URL; confirm with partner documentation)
security:
- bearerAuth: []
tags:
- name: Documents
  description: Employment documents attached to a talent.
paths:
  /employees/{employeeId}/documents:
    parameters:
    - $ref: '#/components/parameters/EmployeeIdParam'
    get:
      operationId: listDocuments
      tags:
      - Documents
      summary: List documents for an employee
      responses:
        '200':
          description: Documents attached to the employee.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DocumentList'
    post:
      operationId: uploadDocument
      tags:
      - Documents
      summary: Upload a document for an employee
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                file:
                  type: string
                  format: binary
                type:
                  type: string
                  description: Document category (e.g., contract, payslip, compliance).
              required:
              - file
      responses:
        '201':
          description: Document uploaded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Document'
  /documents/{documentId}:
    parameters:
    - $ref: '#/components/parameters/DocumentIdParam'
    get:
      operationId: downloadDocument
      tags:
      - Documents
      summary: Download a document
      responses:
        '200':
          description: The document binary.
          content:
            application/octet-stream:
              schema:
                type: string
                format: binary
        '404':
          $ref: '#/components/responses/NotFound'
components:
  responses:
    NotFound:
      description: Resource not found.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  schemas:
    DocumentList:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/Document'
    Document:
      type: object
      properties:
        id:
          type: string
        employeeId:
          type: string
        type:
          type: string
        fileName:
          type: string
        contentType:
          type: string
        createdAt:
          type: string
          format: date-time
    Error:
      type: object
      properties:
        code:
          type: string
        message:
          type: string
  parameters:
    DocumentIdParam:
      name: documentId
      in: path
      required: true
      schema:
        type: string
    EmployeeIdParam:
      name: employeeId
      in: path
      required: true
      schema:
        type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: OAuth 2.0 access token supplied as a Bearer token in the Authorization header. Partner credentials are issued by WorkMotion.