Deel: Retrieve detailed hiring guide for a country
Deel eorHiring.getEorhiringGuideByCountry: arguments, response, policy and SDK examples.
← EOR hiring operations · Get started
Operation deel.eorhiring_geteorhiringguidebycountry
Provider route: GET /eor/validations/{country_code}. Alter supplies the connection’s credentials and routing.
Call through Alter
Section titled “Call through Alter”Install @alter-ai/sdk @alter-ai/deel with npm, or alter-sdk-deel with pip. Supply your connected customer’s grant ID and the arguments described below.
import { App } from "@alter-ai/sdk";import { DeelIntegration } from "@alter-ai/deel";
async function execute(input: Parameters<DeelIntegration["eorHiring"]["getEorhiringGuideByCountry"]>[0]) { const app = new App({ apiKey: process.env.ALTER_API_KEY! }); try { const provider = new DeelIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! }); const call = await provider.eorHiring.getEorhiringGuideByCountry(input); const result = await call.wait(); return result.bodyJson(); } finally { await app.close(); }}import osfrom alter_sdk import Appfrom alter_sdk_deel import DeelIntegration
async def execute(arguments): async with App(api_key=os.environ["ALTER_API_KEY"]) as app: provider = DeelIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]}) call = await provider.eor_hiring.get_eorhiring_guide_by_country(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
path | object | Required within parent | Additional keys: not allowed |
path.country_code | string | Required within parent | Maximum length: 2 Minimum length: 2 Pattern: ^[A-Z]{2}$ |
query | object | Optional | Additional keys: not allowed |
query.include_usd_values | boolean | Optional |
Response
Section titled “Response”Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | Model | Root | Expand Retrieve detailed hiring guide for a country — 200 response body |
Referenced models: Retrieve detailed hiring guide for a country — 200 response body
Schemas
Section titled “Schemas”Retrieve detailed hiring guide for a country — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Optional | Expand Retrieve detailed hiring guide for a country — 200 response body — data |
Referenced models: Retrieve detailed hiring guide for a country — 200 response body — data
Retrieve detailed hiring guide for a country — 200 response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
currency | string | Optional | Country currency. |
health_insurance | JSON | Optional | |
health_insurance (anyOf 1) | Model | Alternative | Expand Retrieve detailed hiring guide for a country — 200 response body — data / health_insurance / status: REQUIRED, ENABLED, DISABLED |
health_insurance (anyOf 2) | null | Alternative | |
holiday | Model | Optional | Expand Retrieve detailed hiring guide for a country — 200 response body — data holiday |
probation | Model | Optional | Expand Retrieve detailed hiring guide for a country — 200 response body — data probation |
salary | Model | Optional | Expand Retrieve detailed hiring guide for a country — 200 response body — data salary |
Referenced models: Retrieve detailed hiring guide for a country — 200 response body — data / health_insurance / status: REQUIRED, ENABLED, DISABLED, Retrieve detailed hiring guide for a country — 200 response body — data holiday, Retrieve detailed hiring guide for a country — 200 response body — data probation, Retrieve detailed hiring guide for a country — 200 response body — data salary
Retrieve detailed hiring guide for a country — 200 response body — data / health_insurance / status: REQUIRED, ENABLED, DISABLED
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
providers | array | Optional | |
providers[] | Model | Each item | Expand Retrieve detailed hiring guide for a country — 200 response body — data / health_insurance / status: REQUIRED, ENABLED, DISABLED providers item |
status | string | Optional | Health insurance status. Known values: REQUIRED, ENABLED, DISABLED |
Referenced models: Retrieve detailed hiring guide for a country — 200 response body — data / health_insurance / status: REQUIRED, ENABLED, DISABLED providers item
Retrieve detailed hiring guide for a country — 200 response body — data holiday
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
max | JSON | Optional | |
max (anyOf 1) | string | Alternative | Maximum holidays. |
max (anyOf 2) | null | Alternative | Maximum holidays. |
min | JSON | Optional | |
min (anyOf 1) | string | Alternative | Minimum holidays. |
min (anyOf 2) | null | Alternative | Minimum holidays. |
mostCommon | JSON | Optional | |
mostCommon (anyOf 1) | string | Alternative | Most common holiday period. |
mostCommon (anyOf 2) | null | Alternative | Most common holiday period. |
Retrieve detailed hiring guide for a country — 200 response body — data probation
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
max | JSON | Optional | |
max (anyOf 1) | JSON | Alternative | |
max (anyOf 1) (anyOf 1) | number | Alternative | Maximum probation period. Format: double |
max (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
max (anyOf 2) | null | Alternative | Maximum probation period. Format: double |
min | JSON | Optional | |
min (anyOf 1) | JSON | Alternative | |
min (anyOf 1) (anyOf 1) | number | Alternative | Minimum probation period. Format: double |
min (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
min (anyOf 2) | null | Alternative | Minimum probation period. Format: double |
Retrieve detailed hiring guide for a country — 200 response body — data salary
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
frequency | string | Optional | Frequency of the salary payment. Known values: monthly, quarterly, annually, specific_month, specific_date |
max | JSON | Optional | |
max (anyOf 1) | string | Alternative | Maximum salary. |
max (anyOf 2) | null | Alternative | Maximum salary. |
max_usd | JSON | Optional | |
max_usd (anyOf 1) | string | Alternative | Maximum salary in USD at the mid-market exchange rate. Only returned when include_usd_values is true and an exchange rate is available. |
max_usd (anyOf 2) | null | Alternative | Maximum salary in USD at the mid-market exchange rate. Only returned when include_usd_values is true and an exchange rate is available. |
min | JSON | Optional | |
min (anyOf 1) | string | Alternative | Minimum salary. |
min (anyOf 2) | null | Alternative | Minimum salary. |
min_usd | JSON | Optional | |
min_usd (anyOf 1) | string | Alternative | Minimum salary in USD at the mid-market exchange rate. Only returned when include_usd_values is true and an exchange rate is available. |
min_usd (anyOf 2) | null | Alternative | Minimum salary in USD at the mid-market exchange rate. Only returned when include_usd_values is true and an exchange rate is available. |
Retrieve detailed hiring guide for a country — 200 response body — data / health_insurance / status: REQUIRED, ENABLED, DISABLED providers item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
id | string | Optional | Provider ID. |
name | string | Optional | Provider name. |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: deel.eorhiring_geteorhiringguidebycountry. Catalog operation: eorhiring_geteorhiringguidebycountry. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.
Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.
Required provider scopes: ["contracts:read"]
Pinned headers: {"X-Version": "2026-01-01"}