Investors, warrants & staking
Get Investor Investment Detail
Read the held investment, its person and logins, investor entity and visible warrant settlement schedule.
GEThttps://api.toku.com/tga/get-investor-investment-detail
Not available to API keys.
curl --request GET \
--url 'https://api.toku.com/tga/get-investor-investment-detail?investmentID=%3CinvestmentID%3E' \
--header 'Authorization: Bearer <token>'200 response
{
"investmentID": "string",
"roleInOrgID": "string",
"investmentName": "string",
"investmentDescription": "string",
"purchasePrice": 0,
"amount": 0,
"totalValue": 0,
"investmentStatus": "PENDING",
"issueDate": "string",
"lockupPeriodMonths": 0,
"createdAt": "string",
"updatedAt": "string",
"legacyMigratedAt": "string",
"legacyModelID": 0,
"investorEntityID": "string",
"investorEntity": {
"investorEntityID": "string",
"entityName": "string",
"orgID": "string"
},
"roleInOrg": {
"person": {
"givenName": "string",
"familyName": "string",
"users": [
{
"userID": "string",
"loginEmail": "string"
}
]
},
"org": {
"hasInvestmentCapTableLockups": true
},
"warrants": [
{
"warrantID": "string",
"roleInOrgID": "string",
"warrantName": "string",
"investorEntityID": "string",
"warrantDescription": "string",
"warrantStatus": "DRAFT",
"warrantConfigurationID": "string",
"firmName": "string",
"amount": 0,
"price": 0,
"totalValue": 0,
"issueDate": "string",
"expirationDate": "string",
"lockupPeriodMonths": 0,
"lockupFrequencyType": "MONTHLY",
"unlockDateOverride": "string",
"agreementSignedAt": "string",
"exerciseNoticeTermsHash": "string",
"exerciseNoticeEnvelopeID": "string",
"exerciseNoticeEnvelopeCompletedAt": "string",
"exerciseNoticeSignedAt": "string",
"paidAt": "string",
"settledAt": "string",
"createdAt": "string",
"updatedAt": "string",
"legacyMigratedAt": "string",
"legacyModelID": 0,
"isSigned": true,
"isPaid": true,
"isExercised": true,
"isUnderLockup": true,
"isOffPlatform": true,
"isTerminated": true,
"warrantLabel": "string",
"warrantLockup": [
{
"legacyMigratedAt": "string",
"legacyModelID": 0,
"lockupID": "string",
"roleInOrgID": "string",
"investorEntityID": "string",
"warrantID": "string",
"unlockDate": "string",
"unlockUnits": "string",
"sequence": 0,
"settledUnits": "string",
"settlementID": "string",
"taxReferenceID": "string",
"createdAt": "string",
"updatedAt": "string",
"payrollReportingGroupID": "string",
"status": "string",
"taxEngineProcessingState": "string",
"taxEnginePayrollID": "string",
"taxEngineClaimID": "string",
"fiatFmv": "string",
"settlementRecord": {
"settlementID": "string",
"roleInOrgID": "string",
"recordedVia": "string",
"revision": 0,
"supersededDocumentIDs": [],
"settledUnits": "string",
"cashUnits": "string",
"settledDate": "string",
"settlementMethod": "string",
"createdAt": "string",
"updatedAt": "string",
"documentID": "string",
"legacyMigratedAt": "string",
"legacyModelID": 0,
"tokenName": "string",
"withheldUnits": "string",
"fmv": "string",
"tokenSettlement": {}
},
"taxReference": {
"taxReferenceID": "string",
"roleInOrgID": "string",
"type": "string",
"status": "string",
"payrollID": "string",
"unitsToWithhold": "string",
"totalUnits": "string",
"unitsToDistribute": "string",
"taxCurrencyCode": "string",
"valueInTaxCurrency": "string",
"amountToWithholdInTaxCurrency": "string",
"documentID": "string",
"legacyMigratedAt": "string",
"legacyModelID": 0,
"fmv": "string",
"fiatFmv": "string",
"rejectionReason": "string",
"withholdingPercentage": "string",
"stablecoinSplitPercentage": "string",
"stablecoinAmount": "string",
"stablecoinFmv": "string",
"desiredSettlementMethod": "string",
"fmvSource": "string",
"fmvAsOf": "string",
"fmvUsd": "string",
"localCurrencyCode": "string",
"fmvLocal": "string",
"finalizedWalletAddress": "string",
"settlmentDocumentID": "string",
"createdAt": "string",
"updatedAt": "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.
Query parameters
investmentIDstringrequiredResponse
200Successful response
investmentIDstringrequiredroleInOrgIDstringrequiredinvestmentNamestringrequiredinvestmentDescriptionstring | nullrequiredpurchasePricenumberrequiredamountnumberrequiredtotalValuenumberrequiredinvestmentStatusstringrequiredAvailable options: PENDING, REJECTED, ACCEPTED, COMPLETED, TERMINATED, PAUSED
issueDatestring | nullrequiredlockupPeriodMonthsinteger | nullrequiredcreatedAtstringrequiredupdatedAtstringrequiredlegacyMigratedAtstring | nullrequiredlegacyModelIDinteger | nullrequiredinvestorEntityIDstring | nullrequiredinvestorEntityobject | nullrequiredShow child attributes
investorEntityIDstringrequiredentityNamestringrequiredorgIDstringrequiredroleInOrgobjectrequiredShow child attributes
personobjectrequiredShow child attributes
givenNamestringrequiredfamilyNamestringrequiredusersobject[]requiredShow child attributes
userIDstringrequiredloginEmailstringrequiredorgobjectrequiredShow child attributes
hasInvestmentCapTableLockupsboolean | nullrequiredwarrantsobject[]requiredShow child attributes
warrantIDstringrequiredroleInOrgIDstringrequiredwarrantNamestringrequiredinvestorEntityIDstring | nullrequiredwarrantDescriptionstring | nullrequiredwarrantStatusstringrequiredAvailable options: DRAFT, AGREEMENT_SENT, AGREEMENT_SIGNED, EXERCISE_NOTICE_SENT, EXERCISE_NOTICE_SIGNED, EXERCISE_ELIGIBLE, PENDING_PAYMENT_VERIFICATION, PAID, IN_LOCKUP, SETTLED, PENDING_SETTLEMENT
warrantConfigurationIDstringrequiredfirmNamestring | nullrequiredamountnumberrequiredpricenumber | nullrequiredtotalValuenumber | nullrequiredissueDatestringrequiredexpirationDatestring | nullrequiredlockupPeriodMonthsinteger | nullrequiredlockupFrequencyTypestringrequiredAvailable options: MONTHLY, QUARTERLY, SEMIANNUALLY, YEARLY, CUSTOM, DAILY, WEEKLY
unlockDateOverridestring | nullrequiredagreementSignedAtstring | nullrequiredexerciseNoticeTermsHashstring | nullrequiredexerciseNoticeEnvelopeIDstring | nullrequiredexerciseNoticeEnvelopeCompletedAtstring | nullrequiredexerciseNoticeSignedAtstring | nullrequiredpaidAtstring | nullrequiredsettledAtstring | nullrequiredcreatedAtstringrequiredupdatedAtstringrequiredlegacyMigratedAtstring | nullrequiredlegacyModelIDinteger | nullrequiredisSignedboolean | nullrequiredisPaidboolean | nullrequiredisExercisedboolean | nullrequiredisUnderLockupboolean | nullrequiredisOffPlatformboolean | nullrequiredisTerminatedboolean | nullrequiredwarrantLabelstring | nullrequiredwarrantLockupobject[]requiredShow child attributes
legacyMigratedAtstring | nullrequiredlegacyModelIDinteger | nullrequiredlockupIDstringrequiredroleInOrgIDstringrequiredinvestorEntityIDstring | nullrequiredwarrantIDstringrequiredunlockDatestringrequiredunlockUnitsstringrequiredsequenceintegerrequiredsettledUnitsstring | nullrequiredsettlementIDstring | nullrequiredtaxReferenceIDstring | nullrequiredcreatedAtstringrequiredupdatedAtstringrequiredpayrollReportingGroupIDstring | nullrequiredstatusstring | nullrequiredtaxEngineProcessingStatestring | nullrequiredtaxEnginePayrollIDstring | nullrequiredtaxEngineClaimIDstring | nullrequiredfiatFmvstring | nullrequiredsettlementRecordobject | nullrequiredShow child attributes
settlementIDstringrequiredroleInOrgIDstringrequiredscheduleAmountsanyrequiredrecordedViastring | nullrequiredrevisionintegerrequiredsupersededDocumentIDsstring[]requiredsettledUnitsstringrequiredcashUnitsstring | nullrequiredsettledDatestringrequiredsettlementMethodstringrequiredcreatedAtstringrequiredupdatedAtstringrequireddocumentIDstring | nullrequiredlegacyMigratedAtstring | nullrequiredlegacyModelIDinteger | nullrequiredtokenNamestring | nullrequiredwithheldUnitsstring | nullrequiredfmvstring | nullrequiredtokenSettlementobject | nullrequiredShow child attributes
tokenSettlementIDstringrequiredsettlementIDstringrequiredroleInOrgIDstringrequiredaddressstring | nullrequiredtokenCurrencyCodestringrequiredtokenNetworkstring | nullrequiredpercentageOfTransactionAttributedToSettlementstringrequiredtransactionLinkstringrequiredtransactionHashstringrequiredcreatedAtstringrequiredupdatedAtstringrequiredlegacyMigratedAtstring | nullrequiredlegacyModelIDinteger | nullrequiredwalletReferenceIDstring | nullrequiredtokenWalletReferenceIDstring | nullrequiredstablecoinAmountstring | nullrequiredstablecoinSymbolstring | nullrequiredstablecoinTransactionHashstring | nullrequiredstablecoinTransactionLinkstring | nullrequiredtaxReferenceobject | nullrequiredShow child attributes
taxReferenceIDstringrequiredroleInOrgIDstringrequiredtypestringrequiredstatusstringrequiredpayrollIDstringrequiredunitsToWithholdstringrequiredtotalUnitsstringrequiredunitsToDistributestringrequiredtaxCurrencyCodestringrequiredvalueInTaxCurrencystringrequiredamountToWithholdInTaxCurrencystringrequireddocumentIDstring | nullrequiredtaxDataanyrequiredlegacyMigratedAtstring | nullrequiredlegacyModelIDinteger | nullrequiredfmvstring | nullrequiredfiatFmvstring | nullrequiredrejectionReasonstring | nullrequiredwithholdingPercentagestring | nullrequiredstablecoinSplitPercentagestring | nullrequiredstablecoinAmountstring | nullrequiredstablecoinFmvstring | nullrequireddesiredSettlementMethodstringrequiredfmvSourcestring | nullrequiredfmvAsOfstring | nullrequiredfmvUsdstring | nullrequiredlocalCurrencyCodestring | nullrequiredfmvLocalstring | nullrequiredfinalizedWalletAddressstring | nullrequiredsettlmentDocumentIDstring | nullrequiredcreatedAtstringrequiredupdatedAtstringrequired400Bad request
401Unauthorized
403Forbidden
404Not found
409Conflict
429Response 429
Was this page helpful? Suggest edits