Grants, vesting & distributions

Get Grant Configuration By ID

Returns one grant configuration with signing tabs and a presigned exercise-form download URL.

GEThttps://api.toku.com/tga/get-grant-configuration-by-id

Not available to API keys yet. It will need grants:read.

curl --request GET \
  --url 'https://api.toku.com/tga/get-grant-configuration-by-id?grantConfigurationID=%3CgrantConfigurationID%3E' \
  --header 'Authorization: Bearer <token>'
200 response
{
  "grantConfigurationID": "string",
  "name": "string",
  "kind": "RTU",
  "isExercisable": true,
  "useStrike": true,
  "hasDiscountFMV": true,
  "redemptionHold": 0,
  "redemptionCap": 0,
  "redemptionLiftPeriod": 0,
  "exerciseLockupMonths": 0,
  "optionExpiryYears": 0,
  "optionExerciseWindowDays": 0,
  "exercisedOptionsPastTenseLabel": "string",
  "exercisedOptionsPresentTenseLabel": "string",
  "exercisedOptionActionLabel": "string",
  "exercisedOptionPotentialActionLabel": "string",
  "cashRedemptionMethod": true,
  "unitsRedemptionMethod": true,
  "coinMarketCapID": "string",
  "showLtipRedemptionProcessingAlert": true,
  "signingTabs": {
    "prefilledTextTabs": [
      {
        "type": "fullLegalName",
        "pageNumber": "string",
        "xPosition": "string",
        "yPosition": "string"
      }
    ],
    "bankTabs": [
      {
        "label": "string",
        "pageNumber": "string",
        "xPosition": "string",
        "yPosition": "string"
      }
    ],
    "signerTabs": [
      {
        "type": "signature",
        "pageNumber": "string",
        "xPosition": "string",
        "yPosition": "string",
        "isRecipient": true,
        "name": "string",
        "email": "string"
      }
    ]
  },
  "exerciseFormDownloadUrl": "string"
}

Authorizations

Authorizationstringheaderrequired

Bearer authentication header of the form Bearer <token>, where <token> is an access token from a Toku sign-in. See Authentication in the API reference.

Query parameters

grantConfigurationIDstring<uuid>required

Response

200Successful response
grantConfigurationIDstringrequired
namestringrequired
kindstringrequired

Available options: RTU, RTA, TOKEN_BONUS, TPA, OPTION, WARRANT, LTIP, TSA, FTIA, PHANTOMUNITS, FOUNDERROUND, FTI, TOKENSUB, PERFORMANCE

isExercisablebooleanrequired
useStrikeboolean
hasDiscountFMVboolean
redemptionHoldnumber
redemptionCapnumber
redemptionLiftPeriodnumber
exerciseLockupMonthsnumber | null
optionExpiryYearsnumber | null
optionExerciseWindowDaysnumber | null
exercisedOptionsPastTenseLabelstring
exercisedOptionsPresentTenseLabelstring
exercisedOptionActionLabelstring
exercisedOptionPotentialActionLabelstring
cashRedemptionMethodboolean
unitsRedemptionMethodboolean
coinMarketCapIDstring
showLtipRedemptionProcessingAlertboolean
signingTabsobject | null
Show child attributes
prefilledTextTabsobject[]required
Show child attributes
typestringrequired

Available options: fullLegalName, exerciseDate, grantDate, numberOfUnitsToRedeem, redemptionMethod

pageNumberstringrequired
xPositionstringrequired
yPositionstringrequired
bankTabsobject[]required
Show child attributes
labelstringrequired
pageNumberstringrequired
xPositionstringrequired
yPositionstringrequired
signerTabsobject[]required
Show child attributes
typestring

Available options: signature, initial, dateSigned

pageNumberstringrequired
xPositionstringrequired
yPositionstringrequired
isRecipientbooleanrequired
namestringrequired
emailstringrequired
exerciseFormDownloadUrlstring
400Bad request
401Unauthorized
403Forbidden
404Not found
409Conflict
429Response 429
Was this page helpful? Suggest edits