HRMS · People
Possible Duplicate Employees
Every employee whose name matches another record together with an email, a national identifier (such as an Iqama number), the same position and hire date, or the same person record; every employee with the same email, or simply the same name, as another current employee (namesakes stay listed until somebody records that they are different people) -- and every current employee who looks like a FORMER employee held as a different person (a possible rehire). Open both to compare. The same person hired back: choose Same person -- link as rehire, and the employment joins the person of the former employee, keeping its own pay and records. Different people: choose Not a duplicate and say why (or say why when saving with Create anyway), and the pair leaves this list.
/api/hrms/employee-duplicatesPublished as /api/v1/employee-duplicatesDownload specification (OpenAPI 3.1) Screen: Possible Duplicate Employees
Overview
| Package | HRMS |
|---|---|
| Authentication | Bearer token: a service account's token (POST /api/auth/service-token) or, for the published path, an API key |
| Authorization | The caller's roles must hold HRMS › Possible Duplicate Employees on the Roles screen: display for GET, add for POST, change for PUT, delete for DELETE; an action needs the grant of the button that runs it on the screen. |
| Table | hr.employees · kept per company (and organisational unit where it has one) |
| Record | Read only; key id |
| Rules | The same as the screen: validation, numbering, approvals, posting, the company the caller belongs to, and the audit trail. |
API reference
7 operations. Open one for its parameters, bodies, responses and a sample request.
GET/api/hrms/employee-duplicatesList possible duplicate employees
Query parameters
| Name | Description | Example |
|---|---|---|
limit | Rows per page (50 by default, at most 200) | limit=100 |
offset | Rows to skip | offset=200 |
q | Free-text search over the search columns | q=acme |
sort | column:asc or column:desc, several separated by commas | sort=created_at:desc |
filter | A JSON condition or group (see the filter language), URL-encoded; any field below can be filtered and sorted | filter={"col":"status","op":"eq","value":"open"} |
<field>=<value> | Shorthand for "field is value" |
Response 200
{
"rows": [
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"employee_no": "EMP-000001",
"user_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"first_name": "Example",
"last_name": "Example",
"email": "someone@example.com",
"worker_type": "text",
"position_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"manager_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"hire_date": "2026-10-30",
"termination_date": "2026-10-30",
"pay_type": "text",
"base_pay": "1250.00",
"currency": "USD"
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/hrms/employee-duplicates?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/hrms/employee-duplicates/{id}Read one employee duplicates
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"employee_no": "EMP-000001",
"user_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"first_name": "Example",
"last_name": "Example",
"email": "someone@example.com",
"worker_type": "text",
"position_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"manager_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"hire_date": "2026-10-30",
"termination_date": "2026-10-30",
"pay_type": "text",
"base_pay": "1250.00",
"currency": "USD"
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/hrms/employee-duplicates/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/hrms/employee-duplicates/{id}/not-duplicateNot duplicate
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
The keys this action reads (* = required; "one of" lists the only values):
reason*Response
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/hrms/employee-duplicates/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/not-duplicate" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"reason":"value"}'POST/api/hrms/employee-duplicatesPost possible duplicate employees
No body is required.
Response
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/hrms/employee-duplicates" \
-H "Authorization: Bearer $TOKEN"POST/api/hrms/employee-duplicates/{id}/copyCopy
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
The keys this action reads (* = required; "one of" lists the only values):
overrides, preview, withLinesResponse
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/hrms/employee-duplicates/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/copy" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"overrides":"value","preview":"value","withLines":"value"}'PUT/api/hrms/employee-duplicates/{id}Put possible duplicate employees
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
No body is required.
Response
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X PUT "https://demo.tranxact.ai/api/hrms/employee-duplicates/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"DELETE/api/hrms/employee-duplicates/{id}Delete possible duplicate employees
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
No body is required.
Response
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X DELETE "https://demo.tranxact.ai/api/hrms/employee-duplicates/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"Data model
Every field of a employee duplicates, as the API returns it. Field names are the JSON keys; any of them can be filtered and sorted on a list.
| Field | Type | Access | Description |
|---|---|---|---|
id | uuid | read only | Id |
org_id | uuid | read only | Org id |
employee_no | text | read only | Employee no |
user_id | uuid | read only | User id |
first_name | text | read only | First name |
last_name | text | read only | Last name |
email | text | read only | |
worker_type | text | read only | Worker type |
position_id | uuid | read only | Position id |
manager_id | uuid | read only | Manager id |
hire_date | date | read only | Hire date |
termination_date | date | read only | Termination date |
pay_type | text | read only | Pay type |
base_pay | numeric | read only | Base pay |
currency | text | read only | Currency |
work_state | text | read only | Work state |
status | text | read only | Status |
org_unit_id | uuid | read only | Org unit id |
person_id | uuid | read only | Person id |
employment_type | text | read only | Employment type |
is_primary | boolean | read only | Is primary |
fte | numeric | read only | Fte |
standard_hours_week | numeric | read only | Standard hours week |
pay_frequency | text | read only | Pay frequency |
original_hire_date | date | read only | Original hire date |
seniority_date | date | read only | Seniority date |
probation_end_date | date | read only | Probation end date |
contract_end_date | date | read only | Contract end date |
notice_days | integer | read only | Notice days |
work_country | text | read only | Work country |
work_location_id | uuid | read only | Work location id |
work_email | text | read only | Work email |
work_phone | text | read only | Work phone |
exempt | boolean | read only | Exempt |
union_code | text | read only | Union code |
termination_reason | text | read only | Termination reason |
termination_type | text | read only | Termination type |
eligible_for_rehire | boolean | read only | Eligible for rehire |
last_working_day | date | read only | Last working day |
grade_id | uuid | read only | Grade id |
agency_name | text | read only | Agency name |
agency_rate | numeric | read only | Agency rate |
purchase_order_id | uuid | read only | Purchase order id |
pay_group_id | uuid | read only | Pay group id |
resident_state | text | read only | Resident state |
work_locality | text | read only | Work locality |
resident_locality | text | read only | Resident locality |
holiday_calendar_id | uuid | read only | Holiday calendar id |
xf_text_1 | text | read only | Xf text 1 |
xf_text_2 | text | read only | Xf text 2 |
xf_text_3 | text | read only | Xf text 3 |
xf_text_4 | text | read only | Xf text 4 |
xf_text_5 | text | read only | Xf text 5 |
xf_num_1 | numeric | read only | Xf num 1 |
xf_num_2 | numeric | read only | Xf num 2 |
xf_num_3 | numeric | read only | Xf num 3 |
xf_date_1 | date | read only | Xf date 1 |
xf_date_2 | date | read only | Xf date 2 |
created_at | timestamp with time zone | read only | Created at |
created_by | uuid | read only | Created by |
updated_at | timestamp with time zone | read only | Updated at |
updated_by | uuid | read only | Updated by |
pan | text | read only | Pan |
aadhaar_last4 | text | read only | Aadhaar last4 |
uan | text | read only | Uan |
pf_number | text | read only | Pf number |
esi_number | text | read only | Esi number |
basic_wage | numeric | read only | Basic wage |
dearness_allowance | numeric | read only | Dearness allowance |
hra | numeric | read only | Hra |
special_allowance | numeric | read only | Special allowance |
pt_state_code | text | read only | Pt state code |
is_pf_applicable | boolean | read only | Is pf applicable |
is_esi_applicable | boolean | read only | Is esi applicable |
tax_regime | text | read only | Tax regime |
ifsc | text | read only | Ifsc |
housing_allowance | numeric | read only | Housing allowance |
transport_allowance | numeric | read only | Transport allowance |
gosi_number | text | read only | Gosi number |
gosi_category | text | read only | Gosi category |
gosi_registered_on | date | read only | Gosi registered on |
iqama_number | text | read only | Iqama number |
merged_into_id | uuid | read only | Merged into id |
overtime_rule_id | uuid | read only | Overtime rule id |
Errors
| Status | Meaning |
|---|---|
| 400 | The request could not be read: a filter that is not JSON, a bad parameter |
| 401 | No credential, or it is wrong, revoked or expired |
| 403 | The caller's roles do not hold HRMS › Possible Duplicate Employees for this verb, or the address or origin is not allowed |
| 404 | No record with that id is visible to the caller |
| 409 | A conflict: a duplicate number, a document in a state that does not allow it, or a record changed or locked by someone else |
| 422 | Refused by the same validation as the screen; the error names the field and why |
Every error is JSON: {"error": "a sentence saying what was wrong"}, with field where it applies.