Skip to main content
POST
Create Grant for New Hire

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
email
string<email>
required
givenName
string
required
familyName
string
required
employmentType
enum<string>
required

TGA employment type.

Available options:
CONTRACTOR,
EMPLOYEE,
EX_EMPLOYEE,
ADVISOR,
SERVICE_PROVIDER,
OTHER
grantName
string
required
grantDescription
string
required
grantConfigurationID
string<uuid>
required
grantAmount
number
required
vestingStartDate
string<date-time>
required
vestingFrequencyType
enum<string>
required
Available options:
MONTHLY,
QUARTERLY,
ANNUALLY
vestingCliffPercentage
number
required
vestingCliffPeriods
number
required
vestingPeriods
number
required
lockup
number
required
offPlatformDate
string<date-time>
required
tags
string[]
required
isSection83bElectionEligible
boolean

Response

Grant created for new hire

grantID
string<uuid>