Skip to content

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.

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 os
from alter_sdk import App
from 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()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.country_codestringRequired within parentMaximum length: 2
Minimum length: 2
Pattern: ^[A-Z]{2}$
queryobjectOptionalAdditional keys: not allowed
query.include_usd_valuesbooleanOptional

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$ModelRootExpand Retrieve detailed hiring guide for a country — 200 response body

Referenced models: Retrieve detailed hiring guide for a country — 200 response body

Retrieve detailed hiring guide for a country — 200 response body
FieldTypePresenceDescription and constraints
$objectRoot
dataModelOptionalExpand 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
FieldTypePresenceDescription and constraints
$objectRoot
currencystringOptionalCountry currency.
health_insuranceJSONOptional
health_insurance (anyOf 1)ModelAlternativeExpand Retrieve detailed hiring guide for a country — 200 response body — data / health_insurance / status: REQUIRED, ENABLED, DISABLED
health_insurance (anyOf 2)nullAlternative
holidayModelOptionalExpand Retrieve detailed hiring guide for a country — 200 response body — data holiday
probationModelOptionalExpand Retrieve detailed hiring guide for a country — 200 response body — data probation
salaryModelOptionalExpand 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
FieldTypePresenceDescription and constraints
$objectRoot
providersarrayOptional
providers[]ModelEach itemExpand Retrieve detailed hiring guide for a country — 200 response body — data / health_insurance / status: REQUIRED, ENABLED, DISABLED providers item
statusstringOptionalHealth 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
FieldTypePresenceDescription and constraints
$objectRoot
maxJSONOptional
max (anyOf 1)stringAlternativeMaximum holidays.
max (anyOf 2)nullAlternativeMaximum holidays.
minJSONOptional
min (anyOf 1)stringAlternativeMinimum holidays.
min (anyOf 2)nullAlternativeMinimum holidays.
mostCommonJSONOptional
mostCommon (anyOf 1)stringAlternativeMost common holiday period.
mostCommon (anyOf 2)nullAlternativeMost common holiday period.
Retrieve detailed hiring guide for a country — 200 response body — data probation
FieldTypePresenceDescription and constraints
$objectRoot
maxJSONOptional
max (anyOf 1)JSONAlternative
max (anyOf 1) (anyOf 1)numberAlternativeMaximum probation period.
Format: double
max (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
max (anyOf 2)nullAlternativeMaximum probation period.
Format: double
minJSONOptional
min (anyOf 1)JSONAlternative
min (anyOf 1) (anyOf 1)numberAlternativeMinimum probation period.
Format: double
min (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
min (anyOf 2)nullAlternativeMinimum probation period.
Format: double
Retrieve detailed hiring guide for a country — 200 response body — data salary
FieldTypePresenceDescription and constraints
$objectRoot
frequencystringOptionalFrequency of the salary payment.
Known values: monthly, quarterly, annually, specific_month, specific_date
maxJSONOptional
max (anyOf 1)stringAlternativeMaximum salary.
max (anyOf 2)nullAlternativeMaximum salary.
max_usdJSONOptional
max_usd (anyOf 1)stringAlternativeMaximum 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)nullAlternativeMaximum salary in USD at the mid-market exchange rate. Only returned when include_usd_values is true and an exchange rate is available.
minJSONOptional
min (anyOf 1)stringAlternativeMinimum salary.
min (anyOf 2)nullAlternativeMinimum salary.
min_usdJSONOptional
min_usd (anyOf 1)stringAlternativeMinimum 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)nullAlternativeMinimum 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
FieldTypePresenceDescription and constraints
$objectRoot
idstringOptionalProvider ID.
namestringOptionalProvider name.

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"}

Official provider source

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.