Grants, vesting & distributions
Create Exercise Request
Creates an exercise request for the caller's own exercisable grant without a signing document.
Not available to API keys.
curl --request POST \
--url 'https://api.toku.com/tga/create-exercise-request' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"grantID": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"redemptionMethod": "TOKEN",
"bankInfo": {}
}'{
"exerciseRequestID": "string",
"roleInOrgID": "string",
"grantID": "string",
"status": "PENDING_AGREEMENT",
"units": "string",
"settlementMethod": "TOKEN",
"documentID": "string",
"addedByRoleInOrgID": "string",
"rejectedAt": "string",
"rejectedReason": "string",
"rejectedByRoleInOrgID": "string",
"approvedByRoleInOrgID": "string",
"approvedAt": "string",
"taxReferenceID": "string",
"settlementID": "string",
"lockedUntil": "string",
"lockupEndNotifiedAt": "string",
"paymentReceivedAt": "string",
"paymentAmount": "string",
"paymentCurrencyCode": "string",
"paymentReference": "string",
"createdAt": "string",
"updatedAt": "string",
"deletedAt": "string"
}Authorizations
AuthorizationstringheaderrequiredBearer authentication header of the form Bearer <token>, where <token> is an access token from a Toku sign-in. See Authentication in the API reference.
Body
application/json
grantIDstring<uuid>requirednumberOfUnitsToRedeemanyrequiredNOTE(ck): z.instanceof(Decimal) has no contract form; TGA still checks it
redemptionMethodstringrequiredAvailable options: TOKEN, CASH
bankInfoobjectrequiredNOTE(ck): a .refine() rule is not mirrored here; TGA still enforces it
Response
200Successful response
exerciseRequestIDstringrequiredroleInOrgIDstringgrantIDstringstatusstringAvailable options: PENDING_AGREEMENT, PENDING_TOKU_ACCEPTANCE, PENDING_TAX_APPROVAL, PENDING_SETTLEMENT, SETTLED, EXERCISE_REQUEST_IMPORTED_FROM_OFF_PLATFORM, REJECTED
unitsstringAllowed: matches ^-?\d+(?:\.\d+)?(?:e[+-]?\d+)?$
settlementMethodstringAvailable options: TOKEN, CASH
documentIDstring | nulladdedByRoleInOrgIDstring | nullrejectedAtstring | nullrejectedReasonstring | nullrejectedByRoleInOrgIDstring | nullapprovedByRoleInOrgIDstring | nullapprovedAtstring | nulltaxReferenceIDstring | nullsettlementIDstring | nulllockedUntilstring | nulllockupEndNotifiedAtstring | nullpaymentReceivedAtstring | nullpaymentAmountstring | nullAllowed: matches ^-?\d+(?:\.\d+)?(?:e[+-]?\d+)?$
paymentCurrencyCodestring | nullpaymentReferencestring | nullcreatedAtstringupdatedAtstringdeletedAtstring | null