{
 "openapi": "3.1.0",
 "info": {
  "title": "Form I-9 (HRMS)",
  "version": "20261030b",
  "description": "Employment eligibility: Section 1 is the employee’s, by their first day; Section 2 is yours, within three business days of it; Supplement B when a work authorization expires. Overdue forms come first. Numbers are sealed and shown as their last four. Retain until the later of 3 years after the first day and 1 year after employment ends."
 },
 "servers": [
  {
   "url": "https://{tenant}.tranxact.ai",
   "variables": {
    "tenant": {
     "default": "demo"
    }
   }
  }
 ],
 "components": {
  "securitySchemes": {
   "bearer": {
    "type": "http",
    "scheme": "bearer"
   }
  },
  "schemas": {
   "i9-records": {
    "type": "object",
    "required": [],
    "properties": {
     "id": {
      "type": "string",
      "format": "uuid",
      "description": "Id",
      "readOnly": true
     },
     "org_id": {
      "type": "string",
      "format": "uuid",
      "description": "Org id",
      "readOnly": true
     },
     "org_unit_id": {
      "type": "string",
      "format": "uuid",
      "description": "Org unit id",
      "readOnly": true
     },
     "record_no": {
      "type": "string",
      "description": "Record no",
      "readOnly": true
     },
     "employee_id": {
      "type": "string",
      "format": "uuid",
      "description": "Employee id",
      "readOnly": true
     },
     "tax_form_id": {
      "type": "string",
      "format": "uuid",
      "description": "Tax form id",
      "readOnly": true
     },
     "first_day": {
      "type": "string",
      "format": "date",
      "description": "First day",
      "readOnly": true
     },
     "section1_due": {
      "type": "string",
      "format": "date",
      "description": "Section1 due",
      "readOnly": true
     },
     "section2_due": {
      "type": "string",
      "format": "date",
      "description": "Section2 due",
      "readOnly": true
     },
     "status": {
      "type": "string",
      "description": "Status",
      "readOnly": true
     },
     "last_name": {
      "type": "string",
      "description": "Last name",
      "readOnly": true
     },
     "first_name": {
      "type": "string",
      "description": "First name",
      "readOnly": true
     },
     "middle_initial": {
      "type": "string",
      "description": "Middle initial",
      "readOnly": true
     },
     "other_last_names": {
      "type": "string",
      "description": "Other last names",
      "readOnly": true
     },
     "address_line": {
      "type": "string",
      "description": "Address line",
      "readOnly": true
     },
     "apt_number": {
      "type": "string",
      "description": "Apt number",
      "readOnly": true
     },
     "city": {
      "type": "string",
      "description": "City",
      "readOnly": true
     },
     "state_code": {
      "type": "string",
      "description": "State code",
      "readOnly": true
     },
     "postal_code": {
      "type": "string",
      "description": "Postal code",
      "readOnly": true
     },
     "date_of_birth": {
      "type": "string",
      "format": "date",
      "description": "Date of birth",
      "readOnly": true
     },
     "ssn_last4": {
      "type": "string",
      "description": "Ssn last4",
      "readOnly": true
     },
     "email": {
      "type": "string",
      "description": "Email",
      "readOnly": true
     },
     "phone": {
      "type": "string",
      "description": "Phone",
      "readOnly": true
     },
     "citizenship_status": {
      "type": "string",
      "description": "Citizenship status",
      "readOnly": true
     },
     "a_number_cipher": {
      "type": "string",
      "description": "A number cipher",
      "readOnly": true
     },
     "a_number_last4": {
      "type": "string",
      "description": "A number last4",
      "readOnly": true
     },
     "uscis_number_cipher": {
      "type": "string",
      "description": "Uscis number cipher",
      "readOnly": true
     },
     "uscis_number_last4": {
      "type": "string",
      "description": "Uscis number last4",
      "readOnly": true
     },
     "i94_number_cipher": {
      "type": "string",
      "description": "I94 number cipher",
      "readOnly": true
     },
     "i94_number_last4": {
      "type": "string",
      "description": "I94 number last4",
      "readOnly": true
     },
     "passport_number_cipher": {
      "type": "string",
      "description": "Passport number cipher",
      "readOnly": true
     },
     "passport_number_last4": {
      "type": "string",
      "description": "Passport number last4",
      "readOnly": true
     },
     "passport_country": {
      "type": "string",
      "description": "Passport country",
      "readOnly": true
     },
     "work_auth_expires": {
      "type": "string",
      "format": "date",
      "description": "Work auth expires",
      "readOnly": true
     },
     "preparer_used": {
      "type": "boolean",
      "description": "Preparer used",
      "readOnly": true
     },
     "preparers": {
      "type": "object",
      "description": "Preparers",
      "readOnly": true
     },
     "s1_signed_name": {
      "type": "string",
      "description": "S1 signed name",
      "readOnly": true
     },
     "s1_signed_at": {
      "type": "string",
      "format": "date-time",
      "description": "S1 signed at",
      "readOnly": true
     },
     "s1_signed_ip": {
      "type": "string",
      "description": "S1 signed ip",
      "readOnly": true
     },
     "s1_sha256": {
      "type": "string",
      "description": "S1 sha256",
      "readOnly": true
     },
     "document_choice": {
      "type": "string",
      "description": "Document choice",
      "readOnly": true
     },
     "s2_first_day": {
      "type": "string",
      "format": "date",
      "description": "S2 first day",
      "readOnly": true
     },
     "s2_signer_id": {
      "type": "string",
      "format": "uuid",
      "description": "S2 signer id",
      "readOnly": true
     },
     "s2_signer_name": {
      "type": "string",
      "description": "S2 signer name",
      "readOnly": true
     },
     "s2_signer_title": {
      "type": "string",
      "description": "S2 signer title",
      "readOnly": true
     },
     "s2_employer_name": {
      "type": "string",
      "description": "S2 employer name",
      "readOnly": true
     },
     "s2_employer_address": {
      "type": "string",
      "description": "S2 employer address",
      "readOnly": true
     },
     "s2_signed_at": {
      "type": "string",
      "format": "date-time",
      "description": "S2 signed at",
      "readOnly": true
     },
     "s2_sha256": {
      "type": "string",
      "description": "S2 sha256",
      "readOnly": true
     },
     "alt_procedure": {
      "type": "boolean",
      "description": "Alt procedure",
      "readOnly": true
     },
     "additional_info": {
      "type": "string",
      "description": "Additional info",
      "readOnly": true
     },
     "reverification_due": {
      "type": "string",
      "format": "date",
      "description": "Reverification due",
      "readOnly": true
     },
     "late_reason": {
      "type": "string",
      "description": "Late reason",
      "readOnly": true
     },
     "created_by": {
      "type": "string",
      "format": "uuid",
      "description": "Created by",
      "readOnly": true
     },
     "created_at": {
      "type": "string",
      "format": "date-time",
      "description": "Created at",
      "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
     },
     "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
     }
    }
   }
  }
 },
 "security": [
  {
   "bearer": []
  }
 ],
 "paths": {
  "/api/hrms/i9-records": {
   "get": {
    "summary": "list i9-records",
    "operationId": "list_i9_records_0_4",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   },
   "post": {
    "summary": "Post form i-9",
    "operationId": "action_i9_records_1_4",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  },
  "/api/hrms/i9-records/{id}": {
   "get": {
    "summary": "get i9-records",
    "operationId": "get_i9_records_0_5",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   },
   "put": {
    "summary": "Put form i-9",
    "operationId": "action_i9_records_1_5",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   },
   "delete": {
    "summary": "Delete form i-9",
    "operationId": "action_i9_records_2_5",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  },
  "/api/hrms/i9-records/guide": {
   "get": {
    "summary": "Guide",
    "operationId": "action_i9_records_0_5",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  },
  "/api/hrms/i9-records/reminders": {
   "get": {
    "summary": "Reminders",
    "operationId": "action_i9_records_0_5",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  },
  "/api/hrms/i9-records/start": {
   "post": {
    "summary": "Start",
    "operationId": "action_i9_records_0_5",
    "description": "Body keys: employeeId, employee_id, firstDay",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  },
  "/api/hrms/i9-records/{id}/section2": {
   "post": {
    "summary": "Section2",
    "operationId": "action_i9_records_0_6",
    "description": "Body keys: documentChoice, document_choice, attest, signerTitle, signer_title, firstDay, lateReason, employerName, employerAddress, altProcedure, alt_procedure, additionalInfo",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  },
  "/api/hrms/i9-records/{id}/reverify": {
   "post": {
    "summary": "Reverify",
    "operationId": "action_i9_records_0_6",
    "description": "Body keys: list, title, issuer, number, expires, file, attest, newLastName, newFirstName, rehireDate; list one of A|C",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  },
  "/api/hrms/i9-records/{id}/void": {
   "post": {
    "summary": "Void",
    "operationId": "action_i9_records_0_6",
    "description": "Body keys: reason*",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  },
  "/api/hrms/i9-records/{id}/pdf": {
   "get": {
    "summary": "Pdf",
    "operationId": "action_i9_records_0_6",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  },
  "/api/hrms/i9-records/{id}/documents": {
   "get": {
    "summary": "Documents",
    "operationId": "action_i9_records_0_6",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  },
  "/api/hrms/i9-records/{id}/copy": {
   "post": {
    "summary": "Copy",
    "operationId": "action_i9_records_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"
     }
    }
   }
  }
 }
}