TRANXACT.AI Help

HRMS · Reachable by link

Worker Compliance

What has to be true about a worker before they may do the work — and what happens if it is not.

Type REST6 operationsBase path /api/hrms/compliance-itemsPublished as /api/v1/compliance-items

Download specification (OpenAPI 3.1) Screen: Worker Compliance

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 › Worker Compliance 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.compliance_items · kept per company (and organisational unit where it has one)
RecordCreated, changed and (where the screen allows) deleted; key id
RulesThe 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/compliance-itemsList worker compliance

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_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "person_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "requirement": "text",
      "requirement_type": "right_to_work",
      "required_by_job_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "required_by_position_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "regulatory_basis": "text",
      "status": "draft",
      "satisfied_on": "2026-10-30",
      "expires_on": "2026-10-30",
      "evidence_reference": "text",
      "document_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "verified_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
    }
  ],
  "count": 1
}

Sample request

curl "https://demo.tranxact.ai/api/hrms/compliance-items?limit=20" \
  -H "Authorization: Bearer $TOKEN"
GET/api/hrms/compliance-items/{id}Read one compliance items

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "employee_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "person_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "requirement": "text",
  "requirement_type": "right_to_work",
  "required_by_job_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "required_by_position_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "regulatory_basis": "text",
  "status": "draft",
  "satisfied_on": "2026-10-30",
  "expires_on": "2026-10-30",
  "evidence_reference": "text",
  "document_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "verified_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}

404 when no record with that id is visible to the caller.

Sample request

curl "https://demo.tranxact.ai/api/hrms/compliance-items/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/hrms/compliance-itemsCreate a compliance items

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
employee_iduuidNoEmployee
person_iduuidNoPerson id
requirementtextYesRequirement
requirement_typetextYesType
Allowed: right_to_work background_check reference qualification licence medical training policy_acknowledgement confidentiality conflict_of_interest vaccination security_clearance
required_by_job_iduuidNoRequired by job id
required_by_position_iduuidNoRequired by position id
regulatory_basistextNoRegulatory basis
statustextNoStatus
satisfied_ondateNoSatisfied on
expires_ondateNoExpires
evidence_referencetextNoEvidence reference
document_iduuidNoDocument id
verified_byuuidNoVerified by
verified_ondateNoVerified on
on_failuretextNoIf it is not satisfied — This is the column that turns a checklist into a control.
Allowed: alert block_start suspend_work block_payroll terminate
waived_byuuidNoWaived by
waiver_reasontextNoWaiver reason
notestextNoNotes
effective_fromdateNoIn force from — The date this version of the row takes effect. Leave it as today unless you are dating a change ahead.
effective_todateNoUntil — Leave empty for open-ended. Setting it ends this version rather than deleting it.

Sample body

{
  "requirement": "text",
  "requirement_type": "right_to_work",
  "employee_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "person_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "required_by_job_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "required_by_position_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "employee_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "person_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "requirement": "text",
  "requirement_type": "right_to_work",
  "required_by_job_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "required_by_position_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "regulatory_basis": "text",
  "status": "draft",
  "satisfied_on": "2026-10-30",
  "expires_on": "2026-10-30",
  "evidence_reference": "text",
  "document_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "verified_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/hrms/compliance-items" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"requirement":"text","requirement_type":"right_to_work","employee_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","person_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","required_by_job_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","required_by_position_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"}'
PUT/api/hrms/compliance-items/{id}Change a compliance items

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Request body

Only the fields to change; fields left out keep their value.

FieldTypeRequiredDescription
employee_iduuidNoEmployee
person_iduuidNoPerson id
requirementtextYesRequirement
requirement_typetextYesType
Allowed: right_to_work background_check reference qualification licence medical training policy_acknowledgement confidentiality conflict_of_interest vaccination security_clearance
required_by_job_iduuidNoRequired by job id
required_by_position_iduuidNoRequired by position id
regulatory_basistextNoRegulatory basis
statustextNoStatus
satisfied_ondateNoSatisfied on
expires_ondateNoExpires
evidence_referencetextNoEvidence reference
document_iduuidNoDocument id
verified_byuuidNoVerified by
verified_ondateNoVerified on
on_failuretextNoIf it is not satisfied — This is the column that turns a checklist into a control.
Allowed: alert block_start suspend_work block_payroll terminate
waived_byuuidNoWaived by
waiver_reasontextNoWaiver reason
notestextNoNotes
effective_fromdateNoIn force from — The date this version of the row takes effect. Leave it as today unless you are dating a change ahead.
effective_todateNoUntil — Leave empty for open-ended. Setting it ends this version rather than deleting it.

Sample body

{
  "requirement": "text",
  "requirement_type": "right_to_work"
}

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "employee_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "person_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "requirement": "text",
  "requirement_type": "right_to_work",
  "required_by_job_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "required_by_position_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "regulatory_basis": "text",
  "status": "draft",
  "satisfied_on": "2026-10-30",
  "expires_on": "2026-10-30",
  "evidence_reference": "text",
  "document_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "verified_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}

Sample request

curl -X PUT "https://demo.tranxact.ai/api/hrms/compliance-items/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"requirement":"text","requirement_type":"right_to_work"}'
DELETE/api/hrms/compliance-items/{id}Delete a compliance items

Path parameters

NameTypeDescription
idstring (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/compliance-items/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/hrms/compliance-items/{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/compliance-items/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 compliance items, 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_iduuidread, writeEmployee
person_iduuidread, writePerson id
requirementtextread, writeRequirement
requirement_typetextread, writeType
Allowed: right_to_work background_check reference qualification licence medical training policy_acknowledgement confidentiality conflict_of_interest vaccination security_clearance
required_by_job_iduuidread, writeRequired by job id
required_by_position_iduuidread, writeRequired by position id
regulatory_basistextread, writeRegulatory basis
statustextread, writeStatus
satisfied_ondateread, writeSatisfied on
expires_ondateread, writeExpires
evidence_referencetextread, writeEvidence reference
document_iduuidread, writeDocument id
verified_byuuidread, writeVerified by
verified_ondateread, writeVerified on
on_failuretextread, writeIf it is not satisfied — This is the column that turns a checklist into a control.
Allowed: alert block_start suspend_work block_payroll terminate
waived_byuuidread, writeWaived by
waiver_reasontextread, writeWaiver reason
notestextread, writeNotes
created_attimestamp with time zoneread onlyCreated at
effective_fromdateread, writeIn force from — The date this version of the row takes effect. Leave it as today unless you are dating a change ahead.
effective_todateread, writeUntil — Leave empty for open-ended. Setting it ends this version rather than deleting it.
org_unit_iduuidread onlyOrg unit 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_byuuidread onlyCreated by
updated_attimestamp with time zoneread onlyUpdated at
updated_byuuidread onlyUpdated by

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 › Worker Compliance 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.