Investors, warrants & staking
Invite Sub Investor
Creates a person, user and sub-investor seat with permissions, queues PropelAuth provisioning, and emails a password-reset link.
POSThttps://api.toku.com/tga/invite-sub-investor
Not available to API keys.
curl --request POST \
--url 'https://api.toku.com/tga/invite-sub-investor' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"loginEmail": "string",
"givenName": "string",
"familyName": "string",
"permissions": [
{
"permissionName": "VIEW_INVESTMENT",
"permissionDescription": "string",
"scope": "string"
}
]
}'200 response
{
"roleInOrgID": "string",
"invitedByInvestorID": "string",
"personID": "string",
"givenName": "string",
"familyName": "string",
"email": "string",
"revokedAt": "string",
"permissions": [
{
"permissionName": "string",
"permissionDescription": "string",
"scope": "string"
}
]
}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
loginEmailstringrequiredroleanygivenNamestringrequiredfamilyNamestringrequiredpermissionsobject[]requiredShow child attributes
permissionNamestringrequiredAvailable options: VIEW_INVESTMENT, VIEW_WARRANT
permissionDescriptionstringrequiredscopestringrequiredResponse
200Successful response
roleInOrgIDstringinvitedByInvestorIDstringrequiredpersonIDstringrequiredgivenNamestringrequiredfamilyNamestringrequiredemailstring | nullrequiredrevokedAtstring | nullrequiredpermissionsobject[]Show child attributes
permissionNamestringrequiredpermissionDescriptionstringscopestringrequired400Bad request
401Unauthorized
403Forbidden
404Not found
409Conflict
429Response 429
Was this page helpful? Suggest edits