Skip to content

Deel: EOR benefits schemas

9 Deel schemas with complete fields and constraints.

← EOR benefits operations · All schemas

Retrieve Benefits for EOR Contract — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataarrayOptional
data[]ModelEach itemExpand Retrieve Benefits for EOR Contract — 200 response body — data item
worker_benefits_linkModelOptionalExpand Retrieve Benefits for EOR Contract — 200 response body — worker benefits link
Short-lived link where the worker completes their benefits enrolment and manages their benefits. Only returned for organisations set up as white-label with Deel, whose workers don't use the Deel app. Redirect the worker to it from your app; call this endpoint again for a new link after expires_at. Don't store, email or share it.

Referenced models: Retrieve Benefits for EOR Contract — 200 response body — worker benefits link, Retrieve Benefits for EOR Contract — 200 response body — data item

Retrieve Benefits for EOR Contract — 200 response body — data item

FieldTypePresenceDescription and constraints
$objectRoot
enrollment_detailsModelOptionalExpand Retrieve Benefits for EOR Contract — 200 response body — data item enrollment details
idstringOptionalThe unique ID of the benefit.
namestringOptionalThe name of the benefit.
offer_statusstringOptionalIndicates whether the benefit is offered.
Known values: Offered, Not offered
planModelOptionalExpand Retrieve Benefits for EOR Contract — 200 response body — data item plan
providerModelOptionalExpand Retrieve Benefits for EOR Contract — 200 response body — data item provider

Referenced models: Retrieve Benefits for EOR Contract — 200 response body — data item plan, Retrieve Benefits for EOR Contract — 200 response body — data item provider, Retrieve Benefits for EOR Contract — 200 response body — data item enrollment details

Retrieve Benefits for EOR Contract — 200 response body — data item enrollment details

FieldTypePresenceDescription and constraints
$objectRoot
current_cycleModelOptionalExpand Retrieve Benefits for EOR Contract — 200 response body — data item enrollment details current cycle
planModelOptionalExpand Retrieve Benefits for EOR Contract — 200 response body — data item enrollment details plan
standardModelOptionalExpand Retrieve Benefits for EOR Contract — 200 response body — data item enrollment details standard
statusstringOptionalThe current enrollment status of the benefit (e.g. ENROLLED, AWAITING_ENROLLMENT, AWAITING_CONTRACT_ACTIVATION, AWAITING_CARRIER_CONFIRMATION).

Referenced models: Retrieve Benefits for EOR Contract — 200 response body — data item enrollment details current cycle, Retrieve Benefits for EOR Contract — 200 response body — data item enrollment details plan, Retrieve Benefits for EOR Contract — 200 response body — data item enrollment details standard

Retrieve Benefits for EOR Contract — 200 response body — data item enrollment details current cycle

FieldTypePresenceDescription and constraints
$objectRoot
employee_monthly_contributionstringOptionalThe monthly contribution paid by the employer (client) for the current enrollment. Note: despite the field name, this value is the employer contribution, not the employee's.
monthly_coststringOptionalThe total monthly cost of the current enrollment.

Retrieve Benefits for EOR Contract — 200 response body — data item enrollment details plan

FieldTypePresenceDescription and constraints
$objectRoot
namestringOptionalThe name of the enrolled plan.

Retrieve Benefits for EOR Contract — 200 response body — data item enrollment details standard

FieldTypePresenceDescription and constraints
$objectRoot
employee_monthly_contributionJSONOptional
employee_monthly_contribution (anyOf 1)stringAlternativeThe standard monthly contribution paid by the employer (client) toward the benefit. Note: despite the field name, this value is the employer contribution, not the employee's.
employee_monthly_contribution (anyOf 2)nullAlternativeThe standard monthly contribution paid by the employer (client) toward the benefit. Note: despite the field name, this value is the employer contribution, not the employee's.
monthly_costJSONOptional
monthly_cost (anyOf 1)stringAlternativeThe standard total monthly cost of the benefit.
monthly_cost (anyOf 2)nullAlternativeThe standard total monthly cost of the benefit.

Retrieve Benefits for EOR Contract — 200 response body — data item plan

FieldTypePresenceDescription and constraints
$objectRoot
namestringOptionalThe name of the associated plan.

Retrieve Benefits for EOR Contract — 200 response body — data item provider

FieldTypePresenceDescription and constraints
$objectRoot
namestringOptionalThe name of the benefit provider.

Retrieve Benefits for EOR Contract — 200 response body — worker benefits link

FieldTypePresenceDescription and constraints
$objectRootShort-lived link where the worker completes their benefits enrolment and manages their benefits. Only returned for organisations set up as white-label with Deel, whose workers don't use the Deel app. Redirect the worker to it from your app; call this endpoint again for a new link after expires_at. Don't store, email or share it.
expires_atstringOptionalThe date and time (UTC) after which the link no longer works.
Format: date-time
urlstringOptionalThe short-lived URL to redirect the worker to.
Format: uri

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.