Skip to content

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.

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 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_job_scopes.validate_job_scope(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
bodyobjectOptional
body.dataModelRequired within parentExpand Request job scope validation — request body — body data
details of job scope

Referenced models: Request job scope validation — request body — body data

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

FieldTypePresenceDescription and constraints
$ModelRootExpand Request job scope validation — 200 response body

Referenced models: Request job scope validation — 200 response body

Request job scope validation — request body — body data
FieldTypePresenceDescription and constraints
$objectRootdetails of job scope
client_legal_entity_idstringRequired within parentThe ID of the client's legal entity.
Format: uuid
client_namestringOptionalOptional 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_namestringRequired within parentThe name of the employee.
employee_nationalitystringOptionalThe nationality of the employee.
employment_countrystringRequired within parentThe country of employment.
employment_statestring or nullOptionalThe state of employment.
job_scopestringRequired within parentThe scope of the job.
Maximum length: 10000
Minimum length: 100
job_titlestringRequired within parentThe title of the job.
special_job_idstring or nullOptionalThe ID of the special job.
Format: uuid
team_idstringRequired within parentThe ID of the team.
Format: uuid
work_visabooleanOptionalIndicates if a work visa is required.
Request job scope validation — 200 response body
FieldTypePresenceDescription and constraints
$objectRoot
data_for_corrected_job_scope_endpointModelOptionalExpand Request job scope validation — 200 response body — data for corrected job scope endpoint
Data for corrected job scope endpoint.
errorsarrayOptionalList of validation errors, if empty the validation was successfully.
errors[]ModelEach itemExpand Request job scope validation — 200 response body — errors item
quote_validation_log_public_idstringOptionalId 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
FieldTypePresenceDescription and constraints
$objectRoot
messagestringOptionalA description of the returned error
pathstringOptionalThe JSON path where input validation failed
Request job scope validation — 200 response body — data for corrected job scope endpoint
FieldTypePresenceDescription and constraints
$objectRootData for corrected job scope endpoint.
anonymized_job_scopeJSONOptional
anonymized_job_scope (anyOf 1)stringAlternativeAnonymized job scope.
anonymized_job_scope (anyOf 2)nullAlternativeAnonymized job scope.
errors_for_correct_job_scopearrayOptionalList of errors for corrected job scope.
errors_for_correct_job_scope[]ModelEach itemExpand Request job scope validation — 200 response body — data for corrected job scope endpoint errors for correct job scope item
must_create_correct_job_scopebooleanOptionalIndicates 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
FieldTypePresenceDescription and constraints
$objectRoot
messagestringOptionalMessage with error description

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

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.