TRANXACT.AI Help

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.

Type REST8 operationsBase path /api/hrms/employee-credentialsPublished as /api/v1/employee-credentials

Download specification (OpenAPI 3.1) Screen: Certifications & Licenses

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 › 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.
Tablehr.employee_credentials · 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

8 operations. Open one for its parameters, bodies, responses and a sample request.

GET/api/hrms/employee-credentialsList certifications & licenses

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",
      "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

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

FieldTypeRequiredDescription
employee_iduuidYesEmployee
credential_typetextNoType
Allowed: certification license
nametextYesName
issuing_bodytextNoIssued by
credential_numbertextNoNumber
jurisdictiontextNoJurisdiction
issued_ondateNoIssued
expires_ondateNoExpires
is_requiredbooleanNoRequired for the job
renewal_course_iduuidNoRenewal course — Enrolled automatically when the renewal task is raised.
skill_iduuidNoSkill it confirms
statustextNoStatus — Expiring and expired follow from the expiry date.
Allowed: active pending revoked
document_iduuidNoDocument id
renewal_statustextNoRenewal status
notestextNoNotes

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

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_iduuidYesEmployee
credential_typetextNoType
Allowed: certification license
nametextYesName
issuing_bodytextNoIssued by
credential_numbertextNoNumber
jurisdictiontextNoJurisdiction
issued_ondateNoIssued
expires_ondateNoExpires
is_requiredbooleanNoRequired for the job
renewal_course_iduuidNoRenewal course — Enrolled automatically when the renewal task is raised.
skill_iduuidNoSkill it confirms
statustextNoStatus — Expiring and expired follow from the expiry date.
Allowed: active pending revoked
document_iduuidNoDocument id
renewal_statustextNoRenewal status
notestextNoNotes

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

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/employee-credentials/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/hrms/employee-credentials/{id}/renewRenew

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):

expires_on, issued_on, credential_number

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

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

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

FieldTypeAccessDescription
iduuidread onlyId
org_iduuidread onlyOrg id
credential_notextread onlyCredential no
employee_iduuidread, writeEmployee
credential_typetextread, writeType
Allowed: certification license
nametextread, writeName
issuing_bodytextread, writeIssued by
credential_numbertextread, writeNumber
jurisdictiontextread, writeJurisdiction
issued_ondateread, writeIssued
expires_ondateread, writeExpires
is_requiredbooleanread, writeRequired for the job
renewal_course_iduuidread, writeRenewal course — Enrolled automatically when the renewal task is raised.
skill_iduuidread, writeSkill it confirms
statustextread, writeStatus — Expiring and expired follow from the expiry date.
Allowed: active pending revoked
verifiedbooleanread onlyVerified
verified_byuuidread onlyVerified by
verified_ondateread onlyVerified on
document_iduuidread, writeDocument id
last_alert_daysintegerread onlyLast alert days
renewal_statustextread, writeRenewal status
renewal_due_ondateread onlyRenewal due on
renewal_raised_ondateread onlyRenewal raised on
notestextread, writeNotes
created_attimestamp with time zoneread onlyCreated at
created_byuuidread onlyCreated by
updated_attimestamp with time zoneread onlyUpdated at
updated_byuuidread onlyUpdated by
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

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 › Certifications & Licenses 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.