v1

latestOpenAPI 3.0.22026-07-26480119.6 KB

Eligibles

Enqueue a bulk creation of eligible employees

Enqueues an asynchronous operation to create multiple eligible employees in the company group. Each item associates an employee to a specific company with optional additional info. The operation is processed asynchronously — use GET /api/v1/operations/{id} to track progress. Maximum of 200 items per request.

post/api/v1/eligibles/bulk_create

Request body

sourcestring

Optional identifier for the request origin (e.g. system name)

Example request

{
  "source": "hr-system",
  "data": [
    {
      "eligible_identifier": "12345678901",
      "company_identifier": "12345678000195",
      "additional_info": {
        "full_name": "John Doe",
        "email": "john@example.com",
        "phone_number": "11999999999"
      }
    }
  ]
}

Response

Operation enqueued successfully

idinteger required

Operation ID used to track progress

created_atstring date-time required

status'pending' | 'processing' | 'finished' | 'finished_with_errors' | 'invalidated' required

Example response

{
  "id": 42,
  "created_at": "2026-05-21T10:00:00.000Z",
  "status": "pending"
}