Deel: Request job scope validation
Deel eorJobScopes.validateJobScope: arguments, response, policy and SDK examples.
← EOR job scopes operations · Get started
Operation deel.eorjobscopes_validatejobscope
Provider route: POST /eor/job-scopes/validate. 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["eorJobScopes"]["validateJobScope"]>[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.eorJobScopes.validateJobScope(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_job_scopes.validate_job_scope(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
body | object | Optional | |
body.data | Model | Required within parent | Expand Request job scope validation — request body — body data details of job scope |
Referenced models: Request job scope validation — request body — body data
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 Request job scope validation — 200 response body |
Referenced models: Request job scope validation — 200 response body
Schemas
Section titled “Schemas”Request job scope validation — request body — body data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | details of job scope |
client_legal_entity_id | string | Required within parent | The ID of the client's legal entity. Format: uuid |
client_name | string | Optional | Optional client name. The validation refuses a job scope if it includes the client name. If not provided, it will be inferred from the legal entity instead. |
employee_name | string | Required within parent | The name of the employee. |
employee_nationality | string | Optional | The nationality of the employee. |
employment_country | string | Required within parent | The country of employment. |
employment_state | string or null | Optional | The state of employment. |
job_scope | string | Required within parent | The scope of the job. Maximum length: 10000 Minimum length: 100 |
job_title | string | Required within parent | The title of the job. |
special_job_id | string or null | Optional | The ID of the special job. Format: uuid |
team_id | string | Required within parent | The ID of the team. Format: uuid |
work_visa | boolean | Optional | Indicates if a work visa is required. |
Request job scope validation — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data_for_corrected_job_scope_endpoint | Model | Optional | Expand Request job scope validation — 200 response body — data for corrected job scope endpoint Data for corrected job scope endpoint. |
errors | array | Optional | List of validation errors, if empty the validation was successfully. |
errors[] | Model | Each item | Expand Request job scope validation — 200 response body — errors item |
quote_validation_log_public_id | string | Optional | Id from validation request. |
Referenced models: Request job scope validation — 200 response body — errors item, Request job scope validation — 200 response body — data for corrected job scope endpoint
Request job scope validation — 200 response body — errors item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
message | string | Optional | A description of the returned error |
path | string | Optional | The JSON path where input validation failed |
Request job scope validation — 200 response body — data for corrected job scope endpoint
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Data for corrected job scope endpoint. |
anonymized_job_scope | JSON | Optional | |
anonymized_job_scope (anyOf 1) | string | Alternative | Anonymized job scope. |
anonymized_job_scope (anyOf 2) | null | Alternative | Anonymized job scope. |
errors_for_correct_job_scope | array | Optional | List of errors for corrected job scope. |
errors_for_correct_job_scope[] | Model | Each item | Expand Request job scope validation — 200 response body — data for corrected job scope endpoint errors for correct job scope item |
must_create_correct_job_scope | boolean | Optional | Indicates if a corrected job scope is required. |
Referenced models: Request job scope validation — 200 response body — data for corrected job scope endpoint errors for correct job scope item
Request job scope validation — 200 response body — data for corrected job scope endpoint errors for correct job scope item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
message | string | Optional | Message with error description |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: deel.eorjobscopes_validatejobscope. Catalog operation: eorjobscopes_validatejobscope. 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:write"]
Pinned headers: {"X-Version": "2026-01-01"}