Grants, vesting & distributions

Run Batch Pre Checks

Runs pre-distribution checks (custody, network, tax config, variance) for schedules and returns results with a summary.

POSThttps://api.toku.com/tga/run-batch-pre-checks

Not available to API keys yet. It will need payments:write.

curl --request POST \
  --url 'https://api.toku.com/tga/run-batch-pre-checks' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "schedules": [
    {
      "scheduleID": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "scheduleType": "VESTING"
    }
  ],
  "varianceThreshold": 0
}'
200 response
{
  "results": [
    {
      "scheduleID": "string",
      "scheduleType": "VESTING",
      "checkResults": [
        {
          "checkType": "WALLET_VALIDATION",
          "status": "PASSED",
          "title": "string",
          "message": "string",
          "severity": "error",
          "details": {}
        }
      ],
      "status": "PASSED",
      "passed": true
    }
  ],
  "summary": {
    "total": 0,
    "passed": 0,
    "failed": 0,
    "warnings": 0
  }
}

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.

Body

application/json

schedulesobject[]required
Show child attributes
scheduleIDstring<uuid>required
scheduleTypestringrequired

Available options: VESTING, LOCKUP, WARRANT_LOCKUP

varianceThresholdnumber

Allowed: 0 to 100

Response

200Successful response
resultsobject[]required
Show child attributes
scheduleIDstringrequired
scheduleTypestringrequired

Available options: VESTING, LOCKUP, WARRANT_LOCKUP

checkResultsobject[]required
Show child attributes
checkTypestringrequired

Available options: WALLET_VALIDATION, TAX_CONFIG, CUSTODY, VARIANCE, NETWORK_MISMATCH, DISTRIBUTION_RATIO

statusstringrequired

Available options: PASSED, FAILED, WARNING, SKIPPED, ERROR

titlestringrequired
messagestringrequired
severitystringrequired

Available options: error, warning, info

detailsobjectrequired
statusstringrequired

Available options: PASSED, FAILED, WARNING, SKIPPED, ERROR

passedbooleanrequired
summaryobjectrequired
Show child attributes
totalnumberrequired
passednumberrequired
failednumberrequired
warningsnumberrequired
400Bad request
401Unauthorized
403Forbidden
404Not found
409Conflict
429Response 429
Was this page helpful? Suggest edits