TRANXACT.AI Help

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.

Type REST7 operationsBase path /api/hrms/employee-duplicatesPublished as /api/v1/employee-duplicates

Download specification (OpenAPI 3.1) Screen: Possible Duplicate Employees

Overview

PackageHRMS
AuthenticationBearer token: a service account's token (POST /api/auth/service-token) or, for the published path, an API key
AuthorizationThe 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.
Tablehr.employees · kept per company (and organisational unit where it has one)
RecordRead only; key id
RulesThe 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

NameDescriptionExample
limitRows per page (50 by default, at most 200)limit=100
offsetRows to skipoffset=200
qFree-text search over the search columnsq=acme
sortcolumn:asc or column:desc, several separated by commassort=created_at:desc
filterA JSON condition or group (see the filter language), URL-encoded; any field below can be filtered and sortedfilter={"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

NameTypeDescription
idstring (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

NameTypeDescription
idstring (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

NameTypeDescription
idstring (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, withLines

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/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

NameTypeDescription
idstring (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

NameTypeDescription
idstring (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.

FieldTypeAccessDescription
iduuidread onlyId
org_iduuidread onlyOrg id
employee_notextread onlyEmployee no
user_iduuidread onlyUser id
first_nametextread onlyFirst name
last_nametextread onlyLast name
emailtextread onlyEmail
worker_typetextread onlyWorker type
position_iduuidread onlyPosition id
manager_iduuidread onlyManager id
hire_datedateread onlyHire date
termination_datedateread onlyTermination date
pay_typetextread onlyPay type
base_paynumericread onlyBase pay
currencytextread onlyCurrency
work_statetextread onlyWork state
statustextread onlyStatus
org_unit_iduuidread onlyOrg unit id
person_iduuidread onlyPerson id
employment_typetextread onlyEmployment type
is_primarybooleanread onlyIs primary
ftenumericread onlyFte
standard_hours_weeknumericread onlyStandard hours week
pay_frequencytextread onlyPay frequency
original_hire_datedateread onlyOriginal hire date
seniority_datedateread onlySeniority date
probation_end_datedateread onlyProbation end date
contract_end_datedateread onlyContract end date
notice_daysintegerread onlyNotice days
work_countrytextread onlyWork country
work_location_iduuidread onlyWork location id
work_emailtextread onlyWork email
work_phonetextread onlyWork phone
exemptbooleanread onlyExempt
union_codetextread onlyUnion code
termination_reasontextread onlyTermination reason
termination_typetextread onlyTermination type
eligible_for_rehirebooleanread onlyEligible for rehire
last_working_daydateread onlyLast working day
grade_iduuidread onlyGrade id
agency_nametextread onlyAgency name
agency_ratenumericread onlyAgency rate
purchase_order_iduuidread onlyPurchase order id
pay_group_iduuidread onlyPay group id
resident_statetextread onlyResident state
work_localitytextread onlyWork locality
resident_localitytextread onlyResident locality
holiday_calendar_iduuidread onlyHoliday calendar id
xf_text_1textread onlyXf text 1
xf_text_2textread onlyXf text 2
xf_text_3textread onlyXf text 3
xf_text_4textread onlyXf text 4
xf_text_5textread onlyXf text 5
xf_num_1numericread onlyXf num 1
xf_num_2numericread onlyXf num 2
xf_num_3numericread onlyXf num 3
xf_date_1dateread onlyXf date 1
xf_date_2dateread onlyXf date 2
created_attimestamp with time zoneread onlyCreated at
created_byuuidread onlyCreated by
updated_attimestamp with time zoneread onlyUpdated at
updated_byuuidread onlyUpdated by
pantextread onlyPan
aadhaar_last4textread onlyAadhaar last4
uantextread onlyUan
pf_numbertextread onlyPf number
esi_numbertextread onlyEsi number
basic_wagenumericread onlyBasic wage
dearness_allowancenumericread onlyDearness allowance
hranumericread onlyHra
special_allowancenumericread onlySpecial allowance
pt_state_codetextread onlyPt state code
is_pf_applicablebooleanread onlyIs pf applicable
is_esi_applicablebooleanread onlyIs esi applicable
tax_regimetextread onlyTax regime
ifsctextread onlyIfsc
housing_allowancenumericread onlyHousing allowance
transport_allowancenumericread onlyTransport allowance
gosi_numbertextread onlyGosi number
gosi_categorytextread onlyGosi category
gosi_registered_ondateread onlyGosi registered on
iqama_numbertextread onlyIqama number
merged_into_iduuidread onlyMerged into id
overtime_rule_iduuidread onlyOvertime rule id

Errors

StatusMeaning
400The request could not be read: a filter that is not JSON, a bad parameter
401No credential, or it is wrong, revoked or expired
403The caller's roles do not hold HRMS › Possible Duplicate Employees for this verb, or the address or origin is not allowed
404No record with that id is visible to the caller
409A conflict: a duplicate number, a document in a state that does not allow it, or a record changed or locked by someone else
422Refused 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.