{
 "openapi": "3.1.0",
 "info": {
  "title": "Worker Compliance (HRMS)",
  "version": "20261030b",
  "description": "What has to be true about a worker before they may do the work — and what happens if it is not."
 },
 "servers": [
  {
   "url": "https://{tenant}.tranxact.ai",
   "variables": {
    "tenant": {
     "default": "demo"
    }
   }
  }
 ],
 "components": {
  "securitySchemes": {
   "bearer": {
    "type": "http",
    "scheme": "bearer"
   }
  },
  "schemas": {
   "compliance-items": {
    "type": "object",
    "required": [
     "requirement",
     "requirement_type"
    ],
    "properties": {
     "id": {
      "type": "string",
      "format": "uuid",
      "description": "Id",
      "readOnly": true
     },
     "org_id": {
      "type": "string",
      "format": "uuid",
      "description": "Org id",
      "readOnly": true
     },
     "employee_id": {
      "type": "string",
      "format": "uuid",
      "description": "Employee"
     },
     "person_id": {
      "type": "string",
      "format": "uuid",
      "description": "Person id"
     },
     "requirement": {
      "type": "string",
      "description": "Requirement"
     },
     "requirement_type": {
      "type": "string",
      "description": "Type",
      "enum": [
       "right_to_work",
       "background_check",
       "reference",
       "qualification",
       "licence",
       "medical",
       "training",
       "policy_acknowledgement",
       "confidentiality",
       "conflict_of_interest",
       "vaccination",
       "security_clearance"
      ]
     },
     "required_by_job_id": {
      "type": "string",
      "format": "uuid",
      "description": "Required by job id"
     },
     "required_by_position_id": {
      "type": "string",
      "format": "uuid",
      "description": "Required by position id"
     },
     "regulatory_basis": {
      "type": "string",
      "description": "Regulatory basis"
     },
     "status": {
      "type": "string",
      "description": "Status"
     },
     "satisfied_on": {
      "type": "string",
      "format": "date",
      "description": "Satisfied on"
     },
     "expires_on": {
      "type": "string",
      "format": "date",
      "description": "Expires"
     },
     "evidence_reference": {
      "type": "string",
      "description": "Evidence reference"
     },
     "document_id": {
      "type": "string",
      "format": "uuid",
      "description": "Document id"
     },
     "verified_by": {
      "type": "string",
      "format": "uuid",
      "description": "Verified by"
     },
     "verified_on": {
      "type": "string",
      "format": "date",
      "description": "Verified on"
     },
     "on_failure": {
      "type": "string",
      "description": "If it is not satisfied",
      "enum": [
       "alert",
       "block_start",
       "suspend_work",
       "block_payroll",
       "terminate"
      ]
     },
     "waived_by": {
      "type": "string",
      "format": "uuid",
      "description": "Waived by"
     },
     "waiver_reason": {
      "type": "string",
      "description": "Waiver reason"
     },
     "notes": {
      "type": "string",
      "description": "Notes"
     },
     "created_at": {
      "type": "string",
      "format": "date-time",
      "description": "Created at",
      "readOnly": true
     },
     "effective_from": {
      "type": "string",
      "format": "date",
      "description": "In force from"
     },
     "effective_to": {
      "type": "string",
      "format": "date",
      "description": "Until"
     },
     "org_unit_id": {
      "type": "string",
      "format": "uuid",
      "description": "Org unit id",
      "readOnly": true
     },
     "xf_text_1": {
      "type": "string",
      "description": "Xf text 1",
      "readOnly": true
     },
     "xf_text_2": {
      "type": "string",
      "description": "Xf text 2",
      "readOnly": true
     },
     "xf_text_3": {
      "type": "string",
      "description": "Xf text 3",
      "readOnly": true
     },
     "xf_text_4": {
      "type": "string",
      "description": "Xf text 4",
      "readOnly": true
     },
     "xf_text_5": {
      "type": "string",
      "description": "Xf text 5",
      "readOnly": true
     },
     "xf_num_1": {
      "type": "string",
      "format": "decimal",
      "description": "Xf num 1",
      "readOnly": true
     },
     "xf_num_2": {
      "type": "string",
      "format": "decimal",
      "description": "Xf num 2",
      "readOnly": true
     },
     "xf_num_3": {
      "type": "string",
      "format": "decimal",
      "description": "Xf num 3",
      "readOnly": true
     },
     "xf_date_1": {
      "type": "string",
      "format": "date",
      "description": "Xf date 1",
      "readOnly": true
     },
     "xf_date_2": {
      "type": "string",
      "format": "date",
      "description": "Xf date 2",
      "readOnly": true
     },
     "created_by": {
      "type": "string",
      "format": "uuid",
      "description": "Created by",
      "readOnly": true
     },
     "updated_at": {
      "type": "string",
      "format": "date-time",
      "description": "Updated at",
      "readOnly": true
     },
     "updated_by": {
      "type": "string",
      "format": "uuid",
      "description": "Updated by",
      "readOnly": true
     }
    }
   }
  }
 },
 "security": [
  {
   "bearer": []
  }
 ],
 "paths": {
  "/api/hrms/compliance-items": {
   "get": {
    "summary": "list compliance-items",
    "operationId": "list_compliance_items_0_4",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   },
   "post": {
    "summary": "create compliance-items",
    "operationId": "create_compliance_items_1_4",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  },
  "/api/hrms/compliance-items/{id}": {
   "get": {
    "summary": "get compliance-items",
    "operationId": "get_compliance_items_0_5",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   },
   "put": {
    "summary": "change compliance-items",
    "operationId": "change_compliance_items_1_5",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   },
   "delete": {
    "summary": "delete compliance-items",
    "operationId": "delete_compliance_items_2_5",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  },
  "/api/hrms/compliance-items/{id}/copy": {
   "post": {
    "summary": "Copy",
    "operationId": "action_compliance_items_0_6",
    "description": "Body keys: overrides, preview, withLines",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  }
 }
}