Deel: Create a request to exercise equity

← contracts operations · Get started · OpenAPI downloads

Contract 2026-10-27 · Operation deel.contracts_createarequesttoexerciseequity_v2026_01_01

Provider route: POST /equity/exercise. Alter supplies the connection’s credentials and routing.

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["contracts"]["createArequestToExerciseEquity"]>[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.contracts.createArequestToExerciseEquity(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.contracts.create_arequest_to_exercise_equity(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
body	object	Optional
body.address_city	string	Required within parent	The city of the address.
body.address_country	string	Required within parent	The country of the address.
body.address_state	string	Required within parent	The state of the address.
body.address_street	string	Required within parent	The street of the address.
body.address_zip	string	Required within parent	The zip code of the address.
body.exercise_id	string	Required within parent	The unique identifier of the exercise. Format: uuid
body.fmv	string	Required within parent	The fair market value of the equity.
body.fmv_currency_code	string	Required within parent	The currency code of the fair market value (ISO 4217).
body.issuer_id	string	Required within parent	The unique identifier of the issuer.
body.option_grant_currency	string	Required within parent	The currency of the option grant (ISO 4217).
body.option_grant_expiry_date	string	Required within parent	The expiry date of the option grant (ISO 8601 date). Format: date
body.option_grant_id	string	Required within parent	The numeric identifier of the option grant. Must contain only digits.
body.option_grant_issue	string	Required within parent	The issue of the option grant.
body.option_grant_issue_date	string	Required within parent	The issue date of the option grant (ISO 8601 date). Format: date
body.option_grant_label	string	Required within parent	The label of the option grant.
body.option_grant_strike_price	string	Required within parent	The strike price of the option grant.
body.quantity	number	Required within parent	The quantity of equity to exercise. Must be a positive number. Format: double
body.stakeholder_email	string	Required within parent	The email address of the stakeholder. Format: email
body.stakeholder_id	string	Required within parent	The unique identifier of the stakeholder.
body.stakeholder_relationship	string	Required within parent	The relationship of the stakeholder.
body.worker_id	string	Required within parent	The public UUID of the worker. Must correspond to an existing worker in the system.

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 Create a request to exercise equity — 201 response body

Referenced models: Create a request to exercise equity — 201 response body

Policy, approvals and errors

SDK function policy ID: deel.contracts_createarequesttoexerciseequity_v2026_01_01. Catalog operation: contracts_createarequesttoexerciseequity_v2026_01_01. 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