Skip to main content
POST
Record Settlement

Authorizations

Authorization
string
header
required

Personal API token. Create via createUserApiToken endpoint.

Headers

x-role-type
enum<string>
required

Role context for the request. Use CLIENT_ORG_ADMIN for most integrations.

Available options:
CLIENT_ORG_ADMIN,
PAYROLL_ADMIN,
FINANCE_ADMIN,
TOKU_ADMIN

Body

application/json
taxReferenceID
string<uuid>
required
scheduleType
enum<string>
required
Available options:
VESTING,
LOCKUP,
WARRANT_LOCKUP
Example:

"VESTING"

settlementDate
string<date-time>
required
Example:

"2026-04-15T00:00:00.000Z"

transactionHash
string
Example:

"0xabc123..."

Example:

"https://etherscan.io/tx/0xabc123..."

walletAddress
string
tokenNetwork
string

Response

Settlement recorded

success
boolean
Example:

true