HRMS · Reachable by link
Identifiers & Right to Work
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.
/api/hrms/person-identifiersPublished as /api/v1/person-identifiersDownload specification (OpenAPI 3.1) Screen: Identifiers & Right to Work
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 › Identifiers & Right to Work 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.person_identifiers · kept per company (and organisational unit where it has one) |
| Record | Created, changed and (where the screen allows) deleted; key id |
| Rules | The same as the screen: validation, numbering, approvals, posting, the company the caller belongs to, and the audit trail. |
API reference
6 operations. Open one for its parameters, bodies, responses and a sample request.
GET/api/hrms/person-identifiersList identifiers & right to work
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",
"person_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"identifier_type": "passport",
"number_cipher": "text",
"number_last4": "text",
"issuing_country": "US",
"issuing_authority": "text",
"issued_on": "2026-10-30",
"expires_on": "2026-10-30",
"grants_right_to_work": true,
"work_restrictions": "text",
"max_hours_per_week": "1250.00",
"restricted_to_employer": true,
"restricted_to_role": "text"
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/hrms/person-identifiers?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/hrms/person-identifiers/{id}Read one person identifiers
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",
"person_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"identifier_type": "passport",
"number_cipher": "text",
"number_last4": "text",
"issuing_country": "US",
"issuing_authority": "text",
"issued_on": "2026-10-30",
"expires_on": "2026-10-30",
"grants_right_to_work": true,
"work_restrictions": "text",
"max_hours_per_week": "1250.00",
"restricted_to_employer": true,
"restricted_to_role": "text"
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/hrms/person-identifiers/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/hrms/person-identifiersCreate a person identifiers
Request body
The record as JSON. Fields marked Yes are required.
| Field | Type | Required | Description |
|---|---|---|---|
person_id | uuid | Yes | Person |
identifier_type | text | Yes | Document Allowed: passport national_id tax_id social_security visa work_permit residence_permit driving_licence professional_licence union_membership iqama aadhaar |
number_last4 | text | No | Last four characters — The full number is encrypted. This is what a screen shows. |
issuing_country | text | No | Issuing country |
issuing_authority | text | No | Issuing authority |
issued_on | date | No | Issued |
expires_on | date | No | Expires |
grants_right_to_work | boolean | No | Grants the right to work |
work_restrictions | text | No | Restrictions |
max_hours_per_week | numeric | No | Maximum hours per week |
restricted_to_employer | boolean | No | Tied to this employer |
restricted_to_role | text | No | Restricted to role |
status | text | No | Status |
alert_days_before | integer | No | Warn this many days before |
on_expiry | text | No | When it expires Allowed: ignore alert suspend_work block_payroll |
verified_by | uuid | No | Verified by |
verified_on | date | No | Verified on |
document_id | uuid | No | Document id |
notes | text | No | Notes |
effective_from | date | No | In force from — The date this version of the row takes effect. Leave it as today unless you are dating a change ahead. |
effective_to | date | No | Until — Leave empty for open-ended. Setting it ends this version rather than deleting it. |
Sample body
{
"person_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"identifier_type": "passport",
"number_last4": "text",
"issuing_country": "US",
"issuing_authority": "text",
"issued_on": "2026-10-30"
}Response 201
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"person_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"identifier_type": "passport",
"number_cipher": "text",
"number_last4": "text",
"issuing_country": "US",
"issuing_authority": "text",
"issued_on": "2026-10-30",
"expires_on": "2026-10-30",
"grants_right_to_work": true,
"work_restrictions": "text",
"max_hours_per_week": "1250.00",
"restricted_to_employer": true,
"restricted_to_role": "text"
}Sample request
curl -X POST "https://demo.tranxact.ai/api/hrms/person-identifiers" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"person_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","identifier_type":"passport","number_last4":"text","issuing_country":"US","issuing_authority":"text","issued_on":"2026-10-30"}'PUT/api/hrms/person-identifiers/{id}Change a person identifiers
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
Only the fields to change; fields left out keep their value.
| Field | Type | Required | Description |
|---|---|---|---|
person_id | uuid | Yes | Person |
identifier_type | text | Yes | Document Allowed: passport national_id tax_id social_security visa work_permit residence_permit driving_licence professional_licence union_membership iqama aadhaar |
number_last4 | text | No | Last four characters — The full number is encrypted. This is what a screen shows. |
issuing_country | text | No | Issuing country |
issuing_authority | text | No | Issuing authority |
issued_on | date | No | Issued |
expires_on | date | No | Expires |
grants_right_to_work | boolean | No | Grants the right to work |
work_restrictions | text | No | Restrictions |
max_hours_per_week | numeric | No | Maximum hours per week |
restricted_to_employer | boolean | No | Tied to this employer |
restricted_to_role | text | No | Restricted to role |
status | text | No | Status |
alert_days_before | integer | No | Warn this many days before |
on_expiry | text | No | When it expires Allowed: ignore alert suspend_work block_payroll |
verified_by | uuid | No | Verified by |
verified_on | date | No | Verified on |
document_id | uuid | No | Document id |
notes | text | No | Notes |
effective_from | date | No | In force from — The date this version of the row takes effect. Leave it as today unless you are dating a change ahead. |
effective_to | date | No | Until — Leave empty for open-ended. Setting it ends this version rather than deleting it. |
Sample body
{
"person_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"identifier_type": "passport"
}Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"person_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"identifier_type": "passport",
"number_cipher": "text",
"number_last4": "text",
"issuing_country": "US",
"issuing_authority": "text",
"issued_on": "2026-10-30",
"expires_on": "2026-10-30",
"grants_right_to_work": true,
"work_restrictions": "text",
"max_hours_per_week": "1250.00",
"restricted_to_employer": true,
"restricted_to_role": "text"
}Sample request
curl -X PUT "https://demo.tranxact.ai/api/hrms/person-identifiers/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"person_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","identifier_type":"passport"}'DELETE/api/hrms/person-identifiers/{id}Delete a person identifiers
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Response 200
{ "deleted": true }Many documents are cancelled or reversed instead; the API refuses a delete the screen would refuse.
Sample request
curl -X DELETE "https://demo.tranxact.ai/api/hrms/person-identifiers/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/hrms/person-identifiers/{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/person-identifiers/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/copy" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"overrides":"value","preview":"value","withLines":"value"}'Data model
Every field of a person identifiers, 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 |
person_id | uuid | read, write | Person |
identifier_type | text | read, write | Document Allowed: passport national_id tax_id social_security visa work_permit residence_permit driving_licence professional_licence union_membership iqama aadhaar |
number_cipher | bytea | read only | Number cipher |
number_last4 | text | read, write | Last four characters — The full number is encrypted. This is what a screen shows. |
issuing_country | text | read, write | Issuing country |
issuing_authority | text | read, write | Issuing authority |
issued_on | date | read, write | Issued |
expires_on | date | read, write | Expires |
grants_right_to_work | boolean | read, write | Grants the right to work |
work_restrictions | text | read, write | Restrictions |
max_hours_per_week | numeric | read, write | Maximum hours per week |
restricted_to_employer | boolean | read, write | Tied to this employer |
restricted_to_role | text | read, write | Restricted to role |
status | text | read, write | Status |
alert_days_before | integer | read, write | Warn this many days before |
on_expiry | text | read, write | When it expires Allowed: ignore alert suspend_work block_payroll |
verified_by | uuid | read, write | Verified by |
verified_on | date | read, write | Verified on |
document_id | uuid | read, write | Document id |
notes | text | read, write | Notes |
created_at | timestamp with time zone | read only | Created at |
effective_from | date | read, write | In force from — The date this version of the row takes effect. Leave it as today unless you are dating a change ahead. |
effective_to | date | read, write | Until — Leave empty for open-ended. Setting it ends this version rather than deleting it. |
org_unit_id | uuid | read only | Org unit 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_by | uuid | read only | Created by |
updated_at | timestamp with time zone | read only | Updated at |
updated_by | uuid | read only | Updated by |
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 › Identifiers & Right to Work 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.