HRMS · Certifications & Skills
Certifications & Licenses
What each person holds and when it expires. Alerts go at 90, 60 and 30 days and on expiry, and a renewal task is raised.
/api/hrms/employee-credentialsPublished as /api/v1/employee-credentialsDownload specification (OpenAPI 3.1) Screen: Certifications & Licenses
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 › Certifications & Licenses 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.employee_credentials · 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
8 operations. Open one for its parameters, bodies, responses and a sample request.
GET/api/hrms/employee-credentialsList certifications & licenses
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",
"credential_no": "CRE-000001",
"employee_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"credential_type": "certification",
"name": "Example",
"issuing_body": "text",
"credential_number": "CRE-000001",
"jurisdiction": "text",
"issued_on": "2026-10-30",
"expires_on": "2026-10-30",
"is_required": true,
"renewal_course_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"skill_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"status": "active"
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/hrms/employee-credentials?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/hrms/employee-credentials/{id}Read one employee credentials
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",
"credential_no": "CRE-000001",
"employee_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"credential_type": "certification",
"name": "Example",
"issuing_body": "text",
"credential_number": "CRE-000001",
"jurisdiction": "text",
"issued_on": "2026-10-30",
"expires_on": "2026-10-30",
"is_required": true,
"renewal_course_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"skill_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"status": "active"
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/hrms/employee-credentials/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/hrms/employee-credentialsCreate a employee credentials
Request body
The record as JSON. Fields marked Yes are required.
| Field | Type | Required | Description |
|---|---|---|---|
employee_id | uuid | Yes | Employee |
credential_type | text | No | Type Allowed: certification license |
name | text | Yes | Name |
issuing_body | text | No | Issued by |
credential_number | text | No | Number |
jurisdiction | text | No | Jurisdiction |
issued_on | date | No | Issued |
expires_on | date | No | Expires |
is_required | boolean | No | Required for the job |
renewal_course_id | uuid | No | Renewal course — Enrolled automatically when the renewal task is raised. |
skill_id | uuid | No | Skill it confirms |
status | text | No | Status — Expiring and expired follow from the expiry date. Allowed: active pending revoked |
document_id | uuid | No | Document id |
renewal_status | text | No | Renewal status |
notes | text | No | Notes |
Sample body
{
"employee_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"name": "Example",
"credential_type": "certification",
"issuing_body": "text",
"credential_number": "CRE-000001",
"jurisdiction": "text"
}Response 201
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"credential_no": "CRE-000001",
"employee_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"credential_type": "certification",
"name": "Example",
"issuing_body": "text",
"credential_number": "CRE-000001",
"jurisdiction": "text",
"issued_on": "2026-10-30",
"expires_on": "2026-10-30",
"is_required": true,
"renewal_course_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"skill_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"status": "active"
}Sample request
curl -X POST "https://demo.tranxact.ai/api/hrms/employee-credentials" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"employee_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","name":"Example","credential_type":"certification","issuing_body":"text","credential_number":"CRE-000001","jurisdiction":"text"}'PUT/api/hrms/employee-credentials/{id}Change a employee credentials
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 |
|---|---|---|---|
employee_id | uuid | Yes | Employee |
credential_type | text | No | Type Allowed: certification license |
name | text | Yes | Name |
issuing_body | text | No | Issued by |
credential_number | text | No | Number |
jurisdiction | text | No | Jurisdiction |
issued_on | date | No | Issued |
expires_on | date | No | Expires |
is_required | boolean | No | Required for the job |
renewal_course_id | uuid | No | Renewal course — Enrolled automatically when the renewal task is raised. |
skill_id | uuid | No | Skill it confirms |
status | text | No | Status — Expiring and expired follow from the expiry date. Allowed: active pending revoked |
document_id | uuid | No | Document id |
renewal_status | text | No | Renewal status |
notes | text | No | Notes |
Sample body
{
"employee_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"name": "Example"
}Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"credential_no": "CRE-000001",
"employee_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"credential_type": "certification",
"name": "Example",
"issuing_body": "text",
"credential_number": "CRE-000001",
"jurisdiction": "text",
"issued_on": "2026-10-30",
"expires_on": "2026-10-30",
"is_required": true,
"renewal_course_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"skill_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"status": "active"
}Sample request
curl -X PUT "https://demo.tranxact.ai/api/hrms/employee-credentials/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"employee_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","name":"Example"}'DELETE/api/hrms/employee-credentials/{id}Delete a employee credentials
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/employee-credentials/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/hrms/employee-credentials/{id}/renewRenew
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):
expires_on, issued_on, credential_numberResponse
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-credentials/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/renew" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"expires_on":"value","issued_on":"value","credential_number":"value"}'POST/api/hrms/employee-credentials/{id}/verifyVerify
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 POST "https://demo.tranxact.ai/api/hrms/employee-credentials/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/verify" \
-H "Authorization: Bearer $TOKEN"POST/api/hrms/employee-credentials/{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-credentials/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 employee credentials, 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 |
credential_no | text | read only | Credential no |
employee_id | uuid | read, write | Employee |
credential_type | text | read, write | Type Allowed: certification license |
name | text | read, write | Name |
issuing_body | text | read, write | Issued by |
credential_number | text | read, write | Number |
jurisdiction | text | read, write | Jurisdiction |
issued_on | date | read, write | Issued |
expires_on | date | read, write | Expires |
is_required | boolean | read, write | Required for the job |
renewal_course_id | uuid | read, write | Renewal course — Enrolled automatically when the renewal task is raised. |
skill_id | uuid | read, write | Skill it confirms |
status | text | read, write | Status — Expiring and expired follow from the expiry date. Allowed: active pending revoked |
verified | boolean | read only | Verified |
verified_by | uuid | read only | Verified by |
verified_on | date | read only | Verified on |
document_id | uuid | read, write | Document id |
last_alert_days | integer | read only | Last alert days |
renewal_status | text | read, write | Renewal status |
renewal_due_on | date | read only | Renewal due on |
renewal_raised_on | date | read only | Renewal raised on |
notes | text | read, write | Notes |
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 |
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 |
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 › Certifications & Licenses 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.