EndpointsContracts

Create a request to exercise equity.

Create a request to exercise equity. Token scopes: contracts:write

Authentication

AuthorizationBearer
## Authentication Deel API uses API tokens to authenticate requests. A bearer token is required to authenticate all API requests. All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. ``` curl -X GET 'api.letsdeel.com/rest/v2/contracts' \ -H 'Authorization: Bearer YOUR-TOKEN-HERE' ``` ### Generating Access Tokens 1. Navigate to **Apps & Perks > Developer Center**. 2. Click on the “Generate New Token” button. 3. In the popup, click “Generate Token” button to generate a new token. Your newly generated token is visible on the screen. 4. Make sure to copy and save your token once is generated. You won't be able to see it again!
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.
issuer_idstringRequired
The unique identifier of the issuer.
worker_idstringRequired
The unique identifier of the worker.
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 unique identifier of the option grant.
fmv_currency_codestringRequired
The currency code of the fair market value.
stakeholder_emailstringRequiredformat: "email"
The email 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.
option_grant_issue_datestringRequiredformat: "date"
The issue date of the option grant.
option_grant_expiry_datestringRequiredformat: "date"
The expiry date of the option grant.
stakeholder_relationshipstringRequired
The relationship of the stakeholder.
option_grant_strike_pricestringRequired
The strike price of the option grant.

Response

Successful operation
idstringformat: "uuid"
The unique identifier of the request.
statusstring
The status of the request.
created_atstringformat: "date-time"
The date and time when the request was created.
updated_atstringformat: "date-time"
The date and time when the request was last updated.
employer_approvalstring
The approval status of the employer.

Errors