HR Lite API for developers

Send personnel data to IQ.HR straight from your system

The HR Lite API is how HR systems, ERPs and group platforms such as Workday send new hires, contract changes, suspensions and terminations to IQ.HR. Every request is received, validated and placed in HR review before it reaches the employee file, payroll or REGES Online.

POST /new-employees/{badge}
POST /hr-lite/v1/new-employees/E2400
Authorization: Bearer <token>
Idempotency-Key: 3f0c…b71e
Content-Type: application/json

{
  "fields": [
    { "fieldKey": "lastName",  "value": "Popescu" },
    { "fieldKey": "firstName", "value": "Ana-Maria" },
    { "fieldKey": "hireDate",  "value": "2026-11-03" },
    { "fieldKey": "grossSalary", "value": "8500" }
  ]
}

201 Created · stored for HR review
  • OpenAPI 3.0Machine-readable specification
  • OAuth 2.0Client credentials, per environment
  • JSON over HTTPSREST resources, problem+json errors
  • IdempotentSafe retries, optional Idempotency-Key
  • 300 / minDefault write limit per integration

How it works

From your system to payroll, with HR in control

A successful response means the data was received and stored for HR review. It does not create or change an employee on its own, and nothing is sent to REGES Online automatically.

  1. You send

    Your system calls the API when a hire, contract change, suspension or termination happens, using identifiers you choose.

  2. We validate

    Fields are checked against the published catalogue and dictionaries. You receive a receipt, or a clear error for each rejected field.

  3. HR reviews

    HR completes the data required in Romania and resolves any conflicts between your values and their own edits.

  4. It is applied

    The approved change reaches the employee file, payroll and, through the Revisal module, REGES Online.

Resources

Four resources, plus the catalogue

Identifiers are chosen by your system and stay stable for the life of the record. New-employee and contract-change data travel as a list of field and value pairs, so new fields never break your integration.

Before sending, read GET /catalogue for the accepted fields and GET /dictionaries/{key} for valid codes, such as companies, contract types or absence reasons. External values from your system can be mapped once by IQ.HR.

HR Lite resources
ResourceCreateUpdate
New employeePOST /new-employees/{badge}PUT full replacement
Contract changePOST /cim-changes/{id}PUT full replacement
SuspensionPOST /suspensions/{id}PATCH partial
TerminationPOST /terminations/{id}PATCH partial
Any of the aboveGET current statePOST …/withdrawals

Integration essentials

What your developers need to know

Authentication

OAuth 2.0 client credentials. Request a token with the client ID and secret issued by IQ.HR and send it as a bearer token. The company and integration are bound to the credential.

Safe retries

Repeating an identical request returns UNCHANGED. An optional UUID Idempotency-Key replays the original receipt, so a retry after a timeout never duplicates data.

Clear errors

Errors have a stable code, a correlationId to quote to us and, for validation, an errors list naming each field exactly as you sent it.

Field values

Values are strings or null: dates as YYYY-MM-DD, decimals with a dot, booleans as "true"/"false". Missing business fields do not block intake.

Limits

Up to 300 write requests per minute per integration, 500 field entries and 1 MiB per request. 429 responses include Retry-After.

Security

HTTPS only, credentials per environment, data separated per client. IQ.HR is certified to ISO/IEC 27001, ISO/IEC 27701 and ISO 9001 and holds an ISAE 3402 report on independently audited controls.

Getting started

From first call to go-live

The URLs in the published specification are placeholders. We send the base URLs, token URL and credentials for each environment when your integration is set up.

Request API access

Technical questions: office@iqhr.ro

  1. Request access

    Tell us which system will send data and which events you plan to send.

  2. Map your values

    Compare your codes with the catalogue and dictionaries; we configure mappings for your system's values.

  3. Test

    Send real-looking data to the test environment and review the results together with HR.

  4. Go live

    Switch to production credentials. Every request remains traceable by its correlation ID.

API reference

HR Lite External Ingestion API

Every endpoint, parameter, schema and example. The reference is read-only: requests cannot be sent from this page.

Download OpenAPI (YAML)