Skip to content

Deel: EOR worker benefits schemas

17 Deel schemas with complete fields and constraints.

← EOR worker benefits operations · All schemas

Retrieve Benefits for Employee — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parentList of contracts with their associated benefits. An employee may have benefits across multiple contracts if they have more than one active engagement.
data[]ModelEach itemExpand Retrieve Benefits for Employee — 200 response body — data item

Referenced models: Retrieve Benefits for Employee — 200 response body — data item

Retrieve Benefits for Employee — 200 response body — data item

FieldTypePresenceDescription and constraints
$objectRoot
benefitsarrayRequired within parentAll benefits associated with this contract, regardless of enrollment status. Includes benefits the employee is enrolled in, has opted out of, or is pending enrollment for.
benefits[]ModelEach itemExpand Retrieve Benefits for Employee — 200 response body — data item benefits item
contract_idstringRequired within parentUnique identifier for the employment contract these benefits are associated with. Use to correlate benefits with a specific contract when the employee has multiple active engagements.
currencystringRequired within parentISO 4217 currency code for all monetary amounts within this contract's benefits (e.g. 'USD', 'CAD', 'GBP'). Applies to all cost and contribution fields in this contract grouping.

Referenced models: Retrieve Benefits for Employee — 200 response body — data item benefits item

Retrieve Benefits for Employee — 200 response body — data item benefits item

FieldTypePresenceDescription and constraints
$objectRoot
benefit_type_codestringOptionalJurisdiction-aware classification code for this benefit. Use this (not only `type`) when product logic must differ by country — for example retirement: `401_K` in the US versus `OCCUPATIONAL_PENSION` in the UK and Ireland. Other common values include HEALTHCARE, DENTAL, VISION, LIFE_INSURANCE, ACCIDENT_INSURANCE, and CRITICAL_ILLNESS; the full set may expand as new benefit types are added.
contract_typestringOptionalWorkforce product for the contract this benefit belongs to. EOR — Employer of Record; Deel is the legal employer. GP — Global Payroll; the client is the legal employer and Deel runs payroll. PEO — Professional Employer Organization (US co-employment). EMBEDDED — payroll or HR through an embedded partner integration.
coverage_groupstringOptionalWho is covered under this benefit, derived from enrolled dependents on the contract benefit. EMPLOYEE = employee only. EMPLOYEE_AND_SPOUSE = employee plus legal spouse. EMPLOYEE_AND_DOMESTIC_PARTNER = employee plus registered domestic partner where applicable. EMPLOYEE_AND_CHILD = employee plus dependent child coverage structured as a single-child tier. EMPLOYEE_AND_CHILDREN = employee plus all enrolled children. EMPLOYEE_AND_FAMILY = employee plus spouse or partner and children (full family tier) per plan rules.
descriptionstringRequired within parentPlain-text explanation of what this benefit covers and why it matters to the employee. Suitable for display in a benefits overview UI or summary card.
effective_datestringOptionalDate from which this benefit offering is in effect for this employee in this response (ISO 8601, `YYYY-MM-DD`). The benefit offering's offered-at date when present — not the same as contract coverage start or plan-specific coverage start dates inside enrollment.
employee_contributionModelOptionalExpand Retrieve Benefits for Employee — 200 response body — data item benefits item employee contribution
Recurring portion of plan cost collected from the employee's pay for this benefit. Expressed with calculation metadata (`type`, `value`), resolved `amount`, `currency`, and `frequency`. For a given period, `employee_contribution.amount` plus `employer_contribution.amount` reflects the split of premium or plan cost represented here; use `enrollment_details` cycle fields when you need billed totals for the current cycle.
employer_contributionModelOptionalExpand Retrieve Benefits for Employee — 200 response body — data item benefits item employer contribution
Recurring employer-paid portion for this benefit, same shape as `employee_contribution`. Together with `employee_contribution.amount`, describes how premium or plan cost is split for the modeled period; billed totals for the active cycle may also appear under `enrollment_details`.
end_dateJSONOptional
end_date (anyOf 1)stringAlternativeDate on which this benefit's coverage ends (ISO 8601, `YYYY-MM-DD`). Benefit record's effective end, termination, or offer end where applicable. Null or absent when no definitive end date is set on this record (coverage may still change if the contract or offering is updated).
end_date (anyOf 2)nullAlternativeDate on which this benefit's coverage ends (ISO 8601, `YYYY-MM-DD`). Benefit record's effective end, termination, or offer end where applicable. Null or absent when no definitive end date is set on this record (coverage may still change if the contract or offering is updated).
enrollment_detailsModelRequired within parentExpand Retrieve Benefits for Employee — 200 response body — data item benefits item enrollment details
Details about the specific plan and provider the employee is currently enrolled in, along with the cost breakdown for the current billing cycle. Reflects the employee's actual enrollment, which may differ from organization_selection if the employee made their own plan choice.
enrollment_statusstringOptionalEnrollment lifecycle state for this benefit. Always matches `status` in this API version; both are returned so integrations can use the explicit `enrollment_status` name. PENDING = benefit exists but no enrollment action yet. AWAITING_ENROLLMENT = employee must complete enrollment while an enrollment window applies. AWAITING_CARRIER_CONFIRMATION = submission received; awaiting carrier or administrator confirmation. AWAITING_CONTRACT_ACTIVATION = enrollment cannot complete until the underlying employment contract is active. ENROLLED = active coverage. OPTED_OUT = employee stopped or waived the coverage. TERMINATED = stopped before natural expiry. EXPIRED = coverage window has ended.
enrollment_windowModelOptionalExpand Retrieve Benefits for Employee — 200 response body — data item benefits item enrollment window
Calendar window during which the employee may enroll in, change, or opt out of this benefit. Omitted when no window is returned (enrollment changes are then not accepted until a new window opens, for example open enrollment, a qualifying life event, or a new-hire cycle per employer configuration).
idstringOptionalUnique identifier (UUID) for this benefit instance. Use this when referencing the benefit in subsequent API calls.
Format: uuid
namestringRequired within parentHuman-readable display name of the benefit (e.g. 'Healthcare', 'Dental', '401(k)'). Suitable for display in UI.
organization_selectionModelRequired within parentExpand Retrieve Benefits for Employee — 200 response body — data item benefits item organization selection
The plan and provider the client organization has configured as the default offering for this benefit type. This reflects the employer's choice, which may differ from enrollment_details if the employee hasn't enrolled yet or selected a different option during open enrollment.
plan_urlJSONOptional
plan_url (anyOf 1)stringAlternativeURL to this specific plan's portal or documentation — for example, a plan summary PDF, carrier-hosted plan detail page, or plan materials. Distinct from `provider_website_url` (the provider organization as a whole) and `home_page_url` (employee portal for claims and ID cards).
plan_url (anyOf 2)nullAlternativeURL to this specific plan's portal or documentation — for example, a plan summary PDF, carrier-hosted plan detail page, or plan materials. Distinct from `provider_website_url` (the provider organization as a whole) and `home_page_url` (employee portal for claims and ID cards).
provider_namestringOptionalDisplay name of the insurance carrier or benefit provider administering this plan (for example Allianz, Cigna, ManuLife).
provider_website_urlstringOptionalPublic marketing or corporate website for the carrier or administrator. For the employee-facing portal (claims, ID cards, provider search), use `home_page_url` when enrolled.
statusstringRequired within parentEnrollment lifecycle state for this benefit. Populated with the same value as `enrollment_status` (both fields are returned for backward compatibility). ENROLLED = active, claimable coverage. OPTED_OUT = employee stopped or waived the coverage. TERMINATED = cancelled mid-contract. EXPIRED = coverage period ended. PENDING, AWAITING_ENROLLMENT, AWAITING_CARRIER_CONFIRMATION, and AWAITING_CONTRACT_ACTIVATION indicate transitional or pre-active states; see `enrollment_status` for the same enumeration and definitions.
typeJSONRequired within parent
type (anyOf 1)stringAlternativeHigh-level category of the benefit (e.g. HEALTHCARE, DENTAL, VISION). May be null if uncategorized. Use benefit_type_code for a more specific, jurisdiction-aware value.
type (anyOf 2)nullAlternativeHigh-level category of the benefit (e.g. HEALTHCARE, DENTAL, VISION). May be null if uncategorized. Use benefit_type_code for a more specific, jurisdiction-aware value.

Referenced models: Retrieve Benefits for Employee — 200 response body — data item benefits item employee contribution, Retrieve Benefits for Employee — 200 response body — data item benefits item employer contribution, Retrieve Benefits for Employee — 200 response body — data item benefits item enrollment details, Retrieve Benefits for Employee — 200 response body — data item benefits item enrollment window, Retrieve Benefits for Employee — 200 response body — data item benefits item organization selection

Retrieve Benefits for Employee — 200 response body — data item benefits item employee contribution

FieldTypePresenceDescription and constraints
$objectRootRecurring portion of plan cost collected from the employee's pay for this benefit. Expressed with calculation metadata (`type`, `value`), resolved `amount`, `currency`, and `frequency`. For a given period, `employee_contribution.amount` plus `employer_contribution.amount` reflects the split of premium or plan cost represented here; use `enrollment_details` cycle fields when you need billed totals for the current cycle.
amountJSONRequired within parent
amount (anyOf 1)JSONAlternative
amount (anyOf 1) (anyOf 1)numberAlternativeResolved employee contribution in `currency` for each `frequency` period (for example `100` with `USD` and `MONTHLY` means one hundred US dollars per month).
Format: double
amount (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
amount (anyOf 2)nullAlternativeResolved employee contribution in `currency` for each `frequency` period (for example `100` with `USD` and `MONTHLY` means one hundred US dollars per month).
Format: double
currencystringRequired within parentISO 4217 currency code for `amount` (for example USD, CAD, GBP). Matches the parent contract's `currency` for this benefits payload.
frequencyJSONRequired within parent
frequency (anyOf 1)stringAlternativePayroll or billing cadence for this contribution. Typical values include MONTHLY, SEMI_MONTHLY (twice per month), BIWEEKLY, WEEKLY, and ANNUALLY; exact strings follow Deel payroll configuration.
frequency (anyOf 2)nullAlternativePayroll or billing cadence for this contribution. Typical values include MONTHLY, SEMI_MONTHLY (twice per month), BIWEEKLY, WEEKLY, and ANNUALLY; exact strings follow Deel payroll configuration.
typeJSONRequired within parent
type (anyOf 1)stringAlternativeHow the employee contribution is derived. FIXED_AMOUNT = flat currency per `frequency`. PERCENTAGE = percent of an earnings or cost basis defined by the plan. Additional values (for example employer match shapes on retirement benefits) can appear for specialized products.
type (anyOf 2)nullAlternativeHow the employee contribution is derived. FIXED_AMOUNT = flat currency per `frequency`. PERCENTAGE = percent of an earnings or cost basis defined by the plan. Additional values (for example employer match shapes on retirement benefits) can appear for specialized products.
valueJSONRequired within parentRaw contribution input from configuration or upstream systems; may be a number or string (for example `"1.23"`). Use `amount` for display and arithmetic — it is the normalized numeric value in `currency` per `frequency`.
value (anyOf 1)JSONAlternative
value (anyOf 1) (anyOf 1)ModelAlternativeExpand Retrieve Benefits for Employee — 200 response body — data item benefits item employee contribution value value value
value (anyOf 1) (anyOf 2)nullAlternative
value (anyOf 2)nullAlternative

Referenced models: Retrieve Benefits for Employee — 200 response body — data item benefits item employee contribution value value value

Retrieve Benefits for Employee — 200 response body — data item benefits item employee contribution value value value

FieldTypePresenceDescription and constraints
$JSONRootRaw contribution input from configuration or upstream systems; may be a number or string (for example `"1.23"`). Use `amount` for display and arithmetic — it is the normalized numeric value in `currency` per `frequency`.
$ (anyOf 1)JSONAlternative
$ (anyOf 1) (anyOf 1)numberAlternativeFormat: double
$ (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
$ (anyOf 2)stringAlternative

Retrieve Benefits for Employee — 200 response body — data item benefits item employer contribution

FieldTypePresenceDescription and constraints
$objectRootRecurring employer-paid portion for this benefit, same shape as `employee_contribution`. Together with `employee_contribution.amount`, describes how premium or plan cost is split for the modeled period; billed totals for the active cycle may also appear under `enrollment_details`.
amountJSONRequired within parent
amount (anyOf 1)JSONAlternative
amount (anyOf 1) (anyOf 1)numberAlternativeResolved employer contribution in `currency` per `frequency` period.
Format: double
amount (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
amount (anyOf 2)nullAlternativeResolved employer contribution in `currency` per `frequency` period.
Format: double
currencystringRequired within parentISO 4217 currency code for `amount`. Matches the parent contract's `currency`.
frequencyJSONRequired within parent
frequency (anyOf 1)stringAlternativeCadence at which the employer contribution is applied. Same vocabulary as `employee_contribution.frequency`.
frequency (anyOf 2)nullAlternativeCadence at which the employer contribution is applied. Same vocabulary as `employee_contribution.frequency`.
typeJSONRequired within parent
type (anyOf 1)stringAlternativeHow the employer contribution is derived. FIXED_AMOUNT = flat currency per `frequency`. PERCENTAGE = percent of an earnings or cost basis. Additional values may appear for specialized products.
type (anyOf 2)nullAlternativeHow the employer contribution is derived. FIXED_AMOUNT = flat currency per `frequency`. PERCENTAGE = percent of an earnings or cost basis. Additional values may appear for specialized products.
valueJSONRequired within parentRaw employer contribution input; may be number or string depending on source. Prefer `amount` for calculations and UI.
value (anyOf 1)JSONAlternative
value (anyOf 1) (anyOf 1)ModelAlternativeExpand Retrieve Benefits for Employee — 200 response body — data item benefits item employer contribution value value value
value (anyOf 1) (anyOf 2)nullAlternative
value (anyOf 2)nullAlternative

Referenced models: Retrieve Benefits for Employee — 200 response body — data item benefits item employer contribution value value value

Retrieve Benefits for Employee — 200 response body — data item benefits item employer contribution value value value

FieldTypePresenceDescription and constraints
$JSONRootRaw employer contribution input; may be number or string depending on source. Prefer `amount` for calculations and UI.
$ (anyOf 1)JSONAlternative
$ (anyOf 1) (anyOf 1)numberAlternativeFormat: double
$ (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
$ (anyOf 2)stringAlternative

Retrieve Benefits for Employee — 200 response body — data item benefits item enrollment details

FieldTypePresenceDescription and constraints
$objectRootDetails about the specific plan and provider the employee is currently enrolled in, along with the cost breakdown for the current billing cycle. Reflects the employee's actual enrollment, which may differ from organization_selection if the employee made their own plan choice.
current_cycle_employer_contributionJSONRequired within parent
current_cycle_employer_contribution (anyOf 1)JSONAlternative
current_cycle_employer_contribution (anyOf 1) (anyOf 1)numberAlternativeAmount the employer contributes toward the plan cost for the current billing cycle, in the contract's currency. This is the portion the company pays on the employee's behalf. The employee's actual cost is current_cycle_plan_cost minus this value. Null when no contribution has been calculated for the current cycle yet.
Format: double
current_cycle_employer_contribution (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
current_cycle_employer_contribution (anyOf 2)nullAlternativeAmount the employer contributes toward the plan cost for the current billing cycle, in the contract's currency. This is the portion the company pays on the employee's behalf. The employee's actual cost is current_cycle_plan_cost minus this value. Null when no contribution has been calculated for the current cycle yet.
Format: double
current_cycle_plan_costJSONRequired within parent
current_cycle_plan_cost (anyOf 1)JSONAlternative
current_cycle_plan_cost (anyOf 1) (anyOf 1)numberAlternativeTotal cost of the selected plan for the current billing cycle, in the contract's currency. This is the gross plan cost before employer contributions are applied. Subtract current_cycle_employer_contribution to get the employee's net out-of-pocket cost. Null when no cost has been calculated for the current cycle yet.
Format: double
current_cycle_plan_cost (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
current_cycle_plan_cost (anyOf 2)nullAlternativeTotal cost of the selected plan for the current billing cycle, in the contract's currency. This is the gross plan cost before employer contributions are applied. Subtract current_cycle_employer_contribution to get the employee's net out-of-pocket cost. Null when no cost has been calculated for the current cycle yet.
Format: double
selected_planJSONRequired within parentThe specific benefit plan the employee is enrolled in (e.g. 'Gold', 'Silver', 'Bronze'). Contains the plan's ID, display name, and downloadable plan documents.
selected_plan (anyOf 1)ModelAlternativeExpand Retrieve Benefits for Employee — 200 response body — data item benefits item enrollment details selected plan attachments, id, name
selected_plan (anyOf 2)nullAlternative
selected_providerJSONRequired within parentThe insurance carrier or benefit administrator managing the employee's currently enrolled plan. Includes portal access URL and provider-level documents.
selected_provider (anyOf 1)ModelAlternativeExpand Retrieve Benefits for Employee — 200 response body — data item benefits item enrollment details selected provider attachments, home page url, id, is unisure, name
selected_provider (anyOf 2)nullAlternative

Referenced models: Retrieve Benefits for Employee — 200 response body — data item benefits item enrollment details selected plan attachments, id, name, Retrieve Benefits for Employee — 200 response body — data item benefits item enrollment details selected provider attachments, home page url, id, is unisure, name

Retrieve Benefits for Employee — 200 response body — data item benefits item enrollment details selected plan attachments, id, name

FieldTypePresenceDescription and constraints
$objectRootThe specific benefit plan the employee is enrolled in (e.g. 'Gold', 'Silver', 'Bronze'). Contains the plan's ID, display name, and downloadable plan documents.
attachmentsarrayRequired within parentDownloadable documents associated with this plan (e.g. Summary of Benefits and Coverage, Certificate of Coverage, plan brochure). Render each item as a labeled download link.
attachments[]ModelEach itemExpand Retrieve Benefits for Employee — 200 response body — data item benefits item enrollment details selected plan attachments, id, name attachments item
idstringRequired within parentUnique identifier for this benefit plan. Use when referencing the plan in enrollment or amendment API calls.
namestringRequired within parentDisplay name of the plan tier (e.g. 'Gold', 'Silver', 'Bronze'). Shown to employees during enrollment selection and in benefits summaries.

Referenced models: Retrieve Benefits for Employee — 200 response body — data item benefits item enrollment details selected plan attachments, id, name attachments item

Retrieve Benefits for Employee — 200 response body — data item benefits item enrollment details selected plan attachments, id, name attachments item

FieldTypePresenceDescription and constraints
$objectRoot
idstringRequired within parentUnique identifier for this attachment document.
labelstringRequired within parentHuman-readable filename or label for the attachment (e.g. 'Canada_Benefits.pdf'). Use as the visible text for download links.
urlstringRequired within parentDirect URL to download or view the attachment. Typically a PDF. Use as the href for a download link.

Retrieve Benefits for Employee — 200 response body — data item benefits item enrollment details selected provider attachments, home page url, id, is unisure, name

FieldTypePresenceDescription and constraints
$objectRootThe insurance carrier or benefit administrator managing the employee's currently enrolled plan. Includes portal access URL and provider-level documents.
attachmentsarrayRequired within parentProvider-level documents such as general coverage guides, network directories, or enrollment guides. Render each as a labeled download link.
attachments[]ModelEach itemExpand Retrieve Benefits for Employee — 200 response body — data item benefits item enrollment details selected provider attachments, home page url, id, is unisure, name attachments item
home_page_urlstringRequired within parentURL to the employee-facing provider portal where the employee can view claims, access ID cards, find in-network providers, and manage coverage details.
idstringRequired within parentUnique identifier for this provider.
is_unisurebooleanOptionalTrue if this benefit is administered through Unisure, a global group insurance platform Deel uses to deliver international EOR benefits. Relevant for understanding the benefit's administration model and claims process.
namestringRequired within parentDisplay name of the insurance carrier or benefit provider (e.g. 'ManuLife', 'Aetna'). Use for labeling in UI.

Referenced models: Retrieve Benefits for Employee — 200 response body — data item benefits item enrollment details selected provider attachments, home page url, id, is unisure, name attachments item

Retrieve Benefits for Employee — 200 response body — data item benefits item enrollment details selected provider attachments, home page url, id, is unisure, name attachments item

FieldTypePresenceDescription and constraints
$objectRoot
idstringRequired within parentUnique identifier for this attachment document.
labelstringRequired within parentHuman-readable filename or label for the attachment. Use as the visible text for download links.
urlstringRequired within parentDirect URL to download or view the attachment. Use as the href for a download link.

Retrieve Benefits for Employee — 200 response body — data item benefits item enrollment window

FieldTypePresenceDescription and constraints
$objectRootCalendar window during which the employee may enroll in, change, or opt out of this benefit. Omitted when no window is returned (enrollment changes are then not accepted until a new window opens, for example open enrollment, a qualifying life event, or a new-hire cycle per employer configuration).
ends_atstringRequired within parentLast date the enrollment window is open (ISO 8601, `YYYY-MM-DD`). After this date, enrollment is locked until a new window is triggered.
starts_atstringRequired within parentFirst date the enrollment window is open (ISO 8601, `YYYY-MM-DD`). Enrollment actions are accepted on or after this date only.
triggerJSONRequired within parent
trigger (anyOf 1)stringAlternativeBusiness reason this window was opened. new_hire = initial enrollment after onboarding completes. open_enrollment = scheduled annual election period. qualifying_life_event = permitted mid-year change after a life event (for example marriage, birth, divorce) per plan rules. termination = window tied to offboarding, often for continuation or COBRA-style elections in applicable jurisdictions.
trigger (anyOf 2)nullAlternativeBusiness reason this window was opened. new_hire = initial enrollment after onboarding completes. open_enrollment = scheduled annual election period. qualifying_life_event = permitted mid-year change after a life event (for example marriage, birth, divorce) per plan rules. termination = window tied to offboarding, often for continuation or COBRA-style elections in applicable jurisdictions.

Retrieve Benefits for Employee — 200 response body — data item benefits item organization selection

FieldTypePresenceDescription and constraints
$objectRootThe plan and provider the client organization has configured as the default offering for this benefit type. This reflects the employer's choice, which may differ from enrollment_details if the employee hasn't enrolled yet or selected a different option during open enrollment.
selected_planJSONRequired within parentThe plan tier the organization has chosen to offer employees by default for this benefit.
selected_plan (anyOf 1)ModelAlternativeExpand Retrieve Benefits for Employee — 200 response body — data item benefits item organization selection selected plan attachments, id, name
selected_plan (anyOf 2)nullAlternative
selected_providerModelRequired within parentExpand Retrieve Benefits for Employee — 200 response body — data item benefits item organization selection selected provider
The insurance carrier or benefit provider the organization has contracted with to administer this benefit.

Referenced models: Retrieve Benefits for Employee — 200 response body — data item benefits item organization selection selected plan attachments, id, name, Retrieve Benefits for Employee — 200 response body — data item benefits item organization selection selected provider

Retrieve Benefits for Employee — 200 response body — data item benefits item organization selection selected plan attachments, id, name

FieldTypePresenceDescription and constraints
$objectRootThe plan tier the organization has chosen to offer employees by default for this benefit.
attachmentsarrayRequired within parentDownloadable plan documents for the organization's selected plan.
attachments[]ModelEach itemExpand Retrieve Benefits for Employee — 200 response body — data item benefits item organization selection selected provider attachments item
idstringRequired within parentUnique identifier for the organization's selected plan.
namestringRequired within parentDisplay name of the plan tier the organization has selected (e.g. 'Gold', 'Silver'). Shown to employees as the employer-offered default.

Referenced models: Retrieve Benefits for Employee — 200 response body — data item benefits item organization selection selected provider attachments item

Retrieve Benefits for Employee — 200 response body — data item benefits item organization selection selected provider

FieldTypePresenceDescription and constraints
$objectRootThe insurance carrier or benefit provider the organization has contracted with to administer this benefit.
attachmentsarrayRequired within parentProvider-level documents associated with the organization's selected provider.
attachments[]ModelEach itemExpand Retrieve Benefits for Employee — 200 response body — data item benefits item organization selection selected provider attachments item
home_page_urlstringRequired within parentURL to the employee-facing portal for the organization's selected provider.
idstringRequired within parentUnique identifier for the organization's selected provider.
is_unisurebooleanOptionalTrue if this provider is Unisure, a global group insurance platform used by Deel for international EOR benefits.
namestringRequired within parentDisplay name of the provider the organization has selected (e.g. 'ManuLife', 'Aetna').

Referenced models: Retrieve Benefits for Employee — 200 response body — data item benefits item organization selection selected provider attachments item

Retrieve Benefits for Employee — 200 response body — data item benefits item organization selection selected provider attachments item

FieldTypePresenceDescription and constraints
$objectRoot
idstringRequired within parentUnique identifier for this attachment document.
labelstringRequired within parentHuman-readable filename or label for the attachment.
urlstringRequired within parentDirect URL to download or view the attachment.

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.