Grants, vesting & distributions
Run Batch Pre Checks
Runs pre-distribution checks (custody, network, tax config, variance) for schedules and returns results with a summary.
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
}'{
"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
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
schedulesobject[]requiredShow child attributes
scheduleIDstring<uuid>requiredscheduleTypestringrequiredAvailable options: VESTING, LOCKUP, WARRANT_LOCKUP
varianceThresholdnumberAllowed: 0 to 100
Response
200Successful response
resultsobject[]requiredShow child attributes
scheduleIDstringrequiredscheduleTypestringrequiredAvailable options: VESTING, LOCKUP, WARRANT_LOCKUP
checkResultsobject[]requiredShow child attributes
checkTypestringrequiredAvailable options: WALLET_VALIDATION, TAX_CONFIG, CUSTODY, VARIANCE, NETWORK_MISMATCH, DISTRIBUTION_RATIO
statusstringrequiredAvailable options: PASSED, FAILED, WARNING, SKIPPED, ERROR
titlestringrequiredmessagestringrequiredseveritystringrequiredAvailable options: error, warning, info
detailsobjectrequiredstatusstringrequiredAvailable options: PASSED, FAILED, WARNING, SKIPPED, ERROR
passedbooleanrequiredsummaryobjectrequiredShow child attributes
totalnumberrequiredpassednumberrequiredfailednumberrequiredwarningsnumberrequired