Generate secure, time-limited magic links that enable password-free, seamless worker authentication for quick and safe access. Ideal for temporary sessions or low-friction login flows.
Prerequisites: Requires a worker session token created via the existing POST /rest/v2/workers/session endpoint using an organization token with admin:worker scope.
Provides a list of Actionable Journeys for Workers
Returns a paginated list of actionable journeys assigned to the authenticated worker. Actionable journeys are learning paths or training programs that require active participation from the worker, such as completing courses, assessments, or other learning activities. The response includes journey details, completion status, and pagination metadata to support efficient data retrieval.
These journeys are personalised for the specific worker based on their role, department, and organisational requirements
Returns a list of all documents that are available for the given EOR contract, expecting client signature. The response will contain the document types and additional signature details when available.
These documents are intended for the client to review and sign, but not the employee, and are available only for certain countries, such as Framework Agreement for Belgium.
Signs a document with the provided signature and title. Can be used after the client has reviewed the document and is ready to sign. A document can only be signed once - otherwise the signature will be rejected and the endpoint will return an error.
After signature, the responses for both this endpoint and for fetching all documents will contain the signature details.
{
"id": "550e8400-e29b-41d4-a716-446655440000",
"name": "Passport Requirement",
"description": "Passport document required for verification",
"status": "COMPLETED", // 'PENDING', 'IN_REVIEW', 'REJECTED', 'COMPLETED', 'FAILED', 'PROCESSING'
"document": { // can be null if no document has been uploaded
"id": "550e8400-e29b-41d4-a716-446655440000",
"name": "Proof of employment document",
"status": "EXPIRING", // "EXPIRED" or "EXPIRING" or "ACTIVE" or "IN_REVIEW"
"expiry_date": "2025-09-31"
},
"previous_document_request": { // only available if the current document request does not have a document and the current uploaded document was rejected
"id": "550e8400-e29b-41d4-a716-446655440000",
"status": "REJECTED", // 'REJECTED' only
"rejection_reason": "File / photo poor quality",
"rejection_note": "Please provide a clear scan"
}
}
POST /v2/immigration/workers/documents
Change: Request body requirements have been updated. Before:
Cost Centers management for contracts and legal entities
Assign Cost Centers
Register the allocation of active cost centers of a legal entity to an employment contract of that entity. The new configuration requires an effective day to become valid and the allocation must add up exactly to 1 (100% allocated). The returned id represents an employment term where this information is registered.
Fetches a list of all available cost centers for a legal entity, which does not includes archived cost centers. Does not include cost centers allocations by contract, even if the legal entity is a part on these contracts.
Define the active cost center data for a legal entity. This will delete existing items that are not present on the payload, create new items, and finally update cost centers that maintain the same name. Please be aware that is not possible to delete cost centers that are currently allocated to one or more contracts.
Updates additional information for an EOR employee agreement. Only works if the employeeās contract status is new, under_review, or waiting_for_employee_contract. Using other statuses can cause errors.
āNote: This endpoint works with dynamic properties. To retrieve the available properties, use the following endpoint: Get worker additional fields for (EOR). There are no required properties when updating additional worker information.
