Deel: Validate offer terms for an application
Deel ats.validateOfferTermsForApplication: arguments, response, policy and SDK examples.
← ATS operations · Get started
Operation deel.ats_validateoffertermsforapplication_v2026_11_02
Provider route: POST /ats/applications/{application_id}/offer-validations. 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["ats"]["validateOfferTermsForApplication"]>[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.ats.validateOfferTermsForApplication(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.ats.validate_offer_terms_for_application(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.application_id | string | Required within parent | Format: uuid |
headers | object | Required within parent | Additional keys: not allowed |
headers.X-Beta | string | Required within parent | Default: true One of: true |
body | object | Optional | |
body.data | Model | Required within parent | Expand Validate offer terms for an application — request body — body data |
Referenced models: Validate offer terms for an application — 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 Validate offer terms for an application — 200 response body |
Referenced models: Validate offer terms for an application — 200 response body
Schemas
Section titled “Schemas”Validate offer terms for an application — request body — body data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
compensation_amount | number | Required within parent | Compensation amount for the period Format: double |
compensation_currency | string | Required within parent | ISO 4217 currency code of the compensation |
compensation_period_slug | string | Optional | Period the compensation amount covers One of: annually, monthly, semimonthly, biweekly, weekly, daily, hourly |
country_code | string | Required within parent | ISO 3166-1 alpha-2 code of the country the candidate will work in Format: country-code |
job_title | string or null | Optional | Job title offered to the candidate |
start_date | string | Required within parent | Proposed start date of the candidate Format: date-time |
state | string or null | Optional | State or region code within the country, where the rules depend on it |
worker_type | string | Required within parent | How the candidate will be hired One of: CONTRACTOR_FIXED, CONTRACTOR_PAY_AS_YOU_GO, CONTRACTOR_MILESTONE, DIRECT_EMPLOYEE, EOR_EMPLOYEE, GLOBAL_PAYROLL_EMPLOYEE, PEO_EMPLOYEE, PWAC |
Validate offer terms for an application — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand Validate offer terms for an application — 200 response body — data Outcome of the validation |
Referenced models: Validate offer terms for an application — 200 response body — data
Validate offer terms for an application — 200 response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Outcome of the validation |
errors | array | Required within parent | Rules the terms break; empty when the terms are valid |
errors[] | Model | Each item | Expand Validate offer terms for an application — 200 response body — data errors item |
is_valid | boolean | Required within parent | Whether the terms satisfy every rule |
Referenced models: Validate offer terms for an application — 200 response body — data errors item
Validate offer terms for an application — 200 response body — data errors item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
code | string | Required within parent | Machine-readable code of the broken rule |
field | JSON | Required within parent | |
field (anyOf 1) | string | Alternative | Request field the error is about, or null when it concerns the terms as a whole |
field (anyOf 2) | null | Alternative | Request field the error is about, or null when it concerns the terms as a whole |
message | string | Required within parent | Explanation of the broken rule to show to the user |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: deel.ats_validateoffertermsforapplication_v2026_11_02. Catalog operation: ats_validateoffertermsforapplication_v2026_11_02. 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: ["ats:write", "worker:write"]
Pinned headers: {"X-Version": "2026-11-02"}