For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
SupportDeel Home
OverviewPlatformEmployer of RecordContractorsGlobal PayrollHREmbeddedDeel ITAPI ReferenceChangelog
OverviewPlatformEmployer of RecordContractorsGlobal PayrollHREmbeddedDeel ITAPI ReferenceChangelog
  • Resources
    • Blog
    • Community
    • API spec
  • Endpoints
      • PATCHAdd external Id
      • PATCHApprove an equity exercise
      • POSTCreate a new contract
      • POSTCreate a request to exercise equity.
      • GETGet an estimate of withholding amount given an equity event.
      • GETList contract termination reasons
      • GETList of contracts
      • POSTReject contract
      • GETRetrieve a single contract
      • GETRetrieve contract PDF download link
      • GETRetrieve contract templates
      • POSTSign amendment
      • POSTSign worker contract
    • PATCHProfiles
LogoLogo
SupportDeel Home
EndpointsContracts

Create a request to exercise equity.

POST
/equity/exercise
POST
/rest/v2/equity/exercise
$curl -X POST https://api.letsdeel.com/rest/v2/equity/exercise \
>     -H "Authorization: Bearer <token>" \
>     -H "Content-Type: application/json" \
>     -d '{
>  "fmv": "100.00",
>  "quantity": 100,
>  "issuer_id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
>  "worker_id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
>  "address_zip": "94107",
>  "exercise_id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
>  "address_city": "San Francisco",
>  "address_state": "CA",
>  "address_street": "123 Main St",
>  "stakeholder_id": "SH-001234",
>  "address_country": "US",
>  "option_grant_id": "12345",
>  "fmv_currency_code": "USD",
>  "stakeholder_email": "stakeholder@example.com",
>  "option_grant_issue": "Series A",
>  "option_grant_label": "Stock Option Grant #1",
>  "option_grant_currency": "USD",
>  "option_grant_issue_date": "2022-01-01",
>  "option_grant_expiry_date": "2032-01-01",
>  "stakeholder_relationship": "employee",
>  "option_grant_strike_price": "10.50"
>}'
1{
2  "data": {
3    "id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
4    "status": "WTH_TAX_CALCULATION_REQUESTED",
5    "created_at": "2023-05-01T12:00:00.000Z",
6    "updated_at": "2023-05-01T12:00:00.000Z"
7  }
8}

Submits a new equity exercise request, associating the specified option grant and stakeholder details with a worker. The request is created in a pending state; employer approval is handled as a separate operation. Token scopes: contracts:write

Was this page helpful?
Previous

Get an estimate of withholding amount given an equity event.

Next
Built with

Authentication

AuthorizationBearer
## Authentication The Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail. ```curl curl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \ -H 'Authorization: Bearer YOUR-TOKEN-HERE' ``` [Learn more about authentication](/api/authentication)
OR
AuthorizationBearer
Standard OAuth2 security scheme based on https://swagger.io/docs/specification/authentication/

Request

This endpoint expects an object.
fmvstringRequired
The fair market value of the equity.
quantitydoubleRequired
The quantity of equity to exercise. Must be a positive number.
issuer_idstringRequired
The unique identifier of the issuer.
worker_idstringRequired
The public UUID of the worker. Must correspond to an existing worker in the system.
address_zipstringRequired
The zip code of the address.
exercise_idstringRequiredformat: "uuid"
The unique identifier of the exercise.
address_citystringRequired
The city of the address.
address_statestringRequired
The state of the address.
address_streetstringRequired
The street of the address.
stakeholder_idstringRequired
The unique identifier of the stakeholder.
address_countrystringRequired
The country of the address.
option_grant_idstringRequired
The numeric identifier of the option grant. Must contain only digits.
fmv_currency_codestringRequired

The currency code of the fair market value (ISO 4217).

stakeholder_emailstringRequiredformat: "email"
The email address of the stakeholder.
option_grant_issuestringRequired
The issue of the option grant.
option_grant_labelstringRequired
The label of the option grant.
option_grant_currencystringRequired

The currency of the option grant (ISO 4217).

option_grant_issue_datestringRequiredformat: "date"

The issue date of the option grant (ISO 8601 date).

option_grant_expiry_datestringRequiredformat: "date"

The expiry date of the option grant (ISO 8601 date).

stakeholder_relationshipstringRequired
The relationship of the stakeholder.
option_grant_strike_pricestringRequired
The strike price of the option grant.

Response

Equity exercise request created successfully.
dataobject

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
422
Unprocessable Entity Error
429
Too Many Requests Error
500
Internal Server Error

Authentication

The Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.

1curl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \
2  -H 'Authorization: Bearer YOUR-TOKEN-HERE'

Learn more about authentication

Standard OAuth2 security scheme based on https://swagger.io/docs/specification/authentication/