{
 "openapi": "3.1.0",
 "info": {
  "title": "Identity Verifications (HRMS)",
  "version": "20261030b",
  "description": "Checks of an employee’s identity and right to work with the government service of your country: E-Verify (United States, from the Form I-9), PAN, Aadhaar e-KYC, UAN and DigiLocker (India), Iqama, GOSI, Qiwa and Absher (Saudi Arabia). Without a live connection (Platform › Connections) checks run in the sandbox. Only references, statuses and last four digits are kept -- never an Aadhaar number."
 },
 "servers": [
  {
   "url": "https://{tenant}.tranxact.ai",
   "variables": {
    "tenant": {
     "default": "demo"
    }
   }
  }
 ],
 "components": {
  "securitySchemes": {
   "bearer": {
    "type": "http",
    "scheme": "bearer"
   }
  },
  "schemas": {
   "identity-verifications": {
    "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
     },
     "verification_no": {
      "type": "string",
      "description": "Verification no",
      "readOnly": true
     },
     "employee_id": {
      "type": "string",
      "format": "uuid",
      "description": "Employee id",
      "readOnly": true
     },
     "i9_record_id": {
      "type": "string",
      "format": "uuid",
      "description": "I9 record id",
      "readOnly": true
     },
     "country": {
      "type": "string",
      "description": "Country",
      "readOnly": true
     },
     "kind": {
      "type": "string",
      "description": "Kind",
      "readOnly": true
     },
     "provider": {
      "type": "string",
      "description": "Provider",
      "readOnly": true
     },
     "mode": {
      "type": "string",
      "description": "Mode",
      "readOnly": true
     },
     "connection_id": {
      "type": "string",
      "format": "uuid",
      "description": "Connection id",
      "readOnly": true
     },
     "case_number": {
      "type": "string",
      "description": "Case number",
      "readOnly": true
     },
     "reference": {
      "type": "string",
      "description": "Reference",
      "readOnly": true
     },
     "subject_last4": {
      "type": "string",
      "description": "Subject last4",
      "readOnly": true
     },
     "status": {
      "type": "string",
      "description": "Status",
      "readOnly": true
     },
     "status_detail": {
      "type": "string",
      "description": "Status detail",
      "readOnly": true
     },
     "due_by": {
      "type": "string",
      "format": "date",
      "description": "Due by",
      "readOnly": true
     },
     "tnc_notified_at": {
      "type": "string",
      "format": "date-time",
      "description": "Tnc notified at",
      "readOnly": true
     },
     "further_action_notice_id": {
      "type": "string",
      "format": "uuid",
      "description": "Further action notice id",
      "readOnly": true
     },
     "employee_decision": {
      "type": "string",
      "description": "Employee decision",
      "readOnly": true
     },
     "employee_decided_at": {
      "type": "string",
      "format": "date-time",
      "description": "Employee decided at",
      "readOnly": true
     },
     "referred_at": {
      "type": "string",
      "format": "date-time",
      "description": "Referred at",
      "readOnly": true
     },
     "referral_due": {
      "type": "string",
      "format": "date",
      "description": "Referral due",
      "readOnly": true
     },
     "closure_reason": {
      "type": "string",
      "description": "Closure reason",
      "readOnly": true
     },
     "closed_at": {
      "type": "string",
      "format": "date-time",
      "description": "Closed at",
      "readOnly": true
     },
     "late_reason": {
      "type": "string",
      "description": "Late reason",
      "readOnly": true
     },
     "request_summary": {
      "type": "object",
      "description": "Request summary",
      "readOnly": true
     },
     "result": {
      "type": "object",
      "description": "Result",
      "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/identity-verifications": {
   "get": {
    "summary": "list identity-verifications",
    "operationId": "list_identity_verifications_0_4",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   },
   "post": {
    "summary": "Post identity verifications",
    "operationId": "action_identity_verifications_1_4",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  },
  "/api/hrms/identity-verifications/{id}": {
   "get": {
    "summary": "get identity-verifications",
    "operationId": "get_identity_verifications_0_5",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   },
   "put": {
    "summary": "Put identity verifications",
    "operationId": "action_identity_verifications_1_5",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   },
   "delete": {
    "summary": "Delete identity verifications",
    "operationId": "action_identity_verifications_2_5",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  },
  "/api/hrms/identity-verifications/kinds": {
   "get": {
    "summary": "Kinds",
    "operationId": "action_identity_verifications_0_5",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  },
  "/api/hrms/identity-verifications/start": {
   "post": {
    "summary": "Start",
    "operationId": "action_identity_verifications_0_5",
    "description": "Body keys: kind, employeeId, employee_id, pan, aadhaar, shareCode, consent*, uan, docType, iqama; kind one of everify|pan|aadhaar_ekyc|aadhaar_offline|uan|digilocker|iqama|gosi|qiwa|absher",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  },
  "/api/hrms/identity-verifications/{id}/photo-match": {
   "post": {
    "summary": "Photo match",
    "operationId": "action_identity_verifications_0_6",
    "description": "Body keys: matches",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  },
  "/api/hrms/identity-verifications/{id}/notify-employee": {
   "post": {
    "summary": "Notify employee",
    "operationId": "action_identity_verifications_0_6",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  },
  "/api/hrms/identity-verifications/{id}/refer": {
   "post": {
    "summary": "Refer",
    "operationId": "action_identity_verifications_0_6",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  },
  "/api/hrms/identity-verifications/{id}/refresh": {
   "post": {
    "summary": "Refresh",
    "operationId": "action_identity_verifications_0_6",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  },
  "/api/hrms/identity-verifications/{id}/close": {
   "post": {
    "summary": "Close",
    "operationId": "action_identity_verifications_0_6",
    "description": "Body keys: reason; reason one of no_action_continues|no_action_terminated",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  },
  "/api/hrms/identity-verifications/{id}/events": {
   "get": {
    "summary": "Events",
    "operationId": "action_identity_verifications_0_6",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  },
  "/api/hrms/identity-verifications/{id}/notice": {
   "get": {
    "summary": "Notice",
    "operationId": "action_identity_verifications_0_6",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  },
  "/api/hrms/identity-verifications/{id}/copy": {
   "post": {
    "summary": "Copy",
    "operationId": "action_identity_verifications_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"
     }
    }
   }
  }
 }
}