{
 "openapi": "3.1.0",
 "info": {
  "title": "Identifiers & Right to Work (HRMS)",
  "version": "20261030b",
  "description": "Passports, visas, work permits and licences. The status follows the expiry date, and the consequence column is what makes a lapse stop work rather than merely be noticed."
 },
 "servers": [
  {
   "url": "https://{tenant}.tranxact.ai",
   "variables": {
    "tenant": {
     "default": "demo"
    }
   }
  }
 ],
 "components": {
  "securitySchemes": {
   "bearer": {
    "type": "http",
    "scheme": "bearer"
   }
  },
  "schemas": {
   "person-identifiers": {
    "type": "object",
    "required": [
     "person_id",
     "identifier_type"
    ],
    "properties": {
     "id": {
      "type": "string",
      "format": "uuid",
      "description": "Id",
      "readOnly": true
     },
     "org_id": {
      "type": "string",
      "format": "uuid",
      "description": "Org id",
      "readOnly": true
     },
     "person_id": {
      "type": "string",
      "format": "uuid",
      "description": "Person"
     },
     "identifier_type": {
      "type": "string",
      "description": "Document",
      "enum": [
       "passport",
       "national_id",
       "tax_id",
       "social_security",
       "visa",
       "work_permit",
       "residence_permit",
       "driving_licence",
       "professional_licence",
       "union_membership",
       "iqama",
       "aadhaar",
       "pan",
       "emirates_id",
       "other"
      ]
     },
     "number_cipher": {
      "type": "string",
      "description": "Number cipher",
      "readOnly": true
     },
     "number_last4": {
      "type": "string",
      "description": "Last four characters"
     },
     "issuing_country": {
      "type": "string",
      "description": "Issuing country"
     },
     "issuing_authority": {
      "type": "string",
      "description": "Issuing authority"
     },
     "issued_on": {
      "type": "string",
      "format": "date",
      "description": "Issued"
     },
     "expires_on": {
      "type": "string",
      "format": "date",
      "description": "Expires"
     },
     "grants_right_to_work": {
      "type": "boolean",
      "description": "Grants the right to work"
     },
     "work_restrictions": {
      "type": "string",
      "description": "Restrictions"
     },
     "max_hours_per_week": {
      "type": "string",
      "format": "decimal",
      "description": "Maximum hours per week"
     },
     "restricted_to_employer": {
      "type": "boolean",
      "description": "Tied to this employer"
     },
     "restricted_to_role": {
      "type": "string",
      "description": "Restricted to role"
     },
     "status": {
      "type": "string",
      "description": "Status"
     },
     "alert_days_before": {
      "type": "integer",
      "description": "Warn this many days before"
     },
     "on_expiry": {
      "type": "string",
      "description": "When it expires",
      "enum": [
       "ignore",
       "alert",
       "suspend_work",
       "block_payroll"
      ]
     },
     "verified_by": {
      "type": "string",
      "format": "uuid",
      "description": "Verified by"
     },
     "verified_on": {
      "type": "string",
      "format": "date",
      "description": "Verified on"
     },
     "document_id": {
      "type": "string",
      "format": "uuid",
      "description": "Document id"
     },
     "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/person-identifiers": {
   "get": {
    "summary": "list person-identifiers",
    "operationId": "list_person_identifiers_0_4",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   },
   "post": {
    "summary": "create person-identifiers",
    "operationId": "create_person_identifiers_1_4",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  },
  "/api/hrms/person-identifiers/{id}": {
   "get": {
    "summary": "get person-identifiers",
    "operationId": "get_person_identifiers_0_5",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   },
   "put": {
    "summary": "change person-identifiers",
    "operationId": "change_person_identifiers_1_5",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   },
   "delete": {
    "summary": "delete person-identifiers",
    "operationId": "delete_person_identifiers_2_5",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  },
  "/api/hrms/person-identifiers/{id}/copy": {
   "post": {
    "summary": "Copy",
    "operationId": "action_person_identifiers_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"
     }
    }
   }
  }
 }
}