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

Authorizationstringheaderrequired

Bearer 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

investmentIDstringrequired

Response

200Successful response
investmentIDstringrequired
roleInOrgIDstringrequired
investmentNamestringrequired
investmentDescriptionstring | nullrequired
purchasePricenumberrequired
amountnumberrequired
totalValuenumberrequired
investmentStatusstringrequired

Available options: PENDING, REJECTED, ACCEPTED, COMPLETED, TERMINATED, PAUSED

issueDatestring | nullrequired
lockupPeriodMonthsinteger | nullrequired
createdAtstringrequired
updatedAtstringrequired
legacyMigratedAtstring | nullrequired
legacyModelIDinteger | nullrequired
investorEntityIDstring | nullrequired
investorEntityobject | nullrequired
Show child attributes
investorEntityIDstringrequired
entityNamestringrequired
orgIDstringrequired
roleInOrgobjectrequired
Show child attributes
personobjectrequired
Show child attributes
givenNamestringrequired
familyNamestringrequired
usersobject[]required
Show child attributes
userIDstringrequired
loginEmailstringrequired
orgobjectrequired
Show child attributes
hasInvestmentCapTableLockupsboolean | nullrequired
warrantsobject[]required
Show child attributes
warrantIDstringrequired
roleInOrgIDstringrequired
warrantNamestringrequired
investorEntityIDstring | nullrequired
warrantDescriptionstring | nullrequired
warrantStatusstringrequired

Available options: DRAFT, AGREEMENT_SENT, AGREEMENT_SIGNED, EXERCISE_NOTICE_SENT, EXERCISE_NOTICE_SIGNED, EXERCISE_ELIGIBLE, PENDING_PAYMENT_VERIFICATION, PAID, IN_LOCKUP, SETTLED, PENDING_SETTLEMENT

warrantConfigurationIDstringrequired
firmNamestring | nullrequired
amountnumberrequired
pricenumber | nullrequired
totalValuenumber | nullrequired
issueDatestringrequired
expirationDatestring | nullrequired
lockupPeriodMonthsinteger | nullrequired
lockupFrequencyTypestringrequired

Available options: MONTHLY, QUARTERLY, SEMIANNUALLY, YEARLY, CUSTOM, DAILY, WEEKLY

unlockDateOverridestring | nullrequired
agreementSignedAtstring | nullrequired
exerciseNoticeTermsHashstring | nullrequired
exerciseNoticeEnvelopeIDstring | nullrequired
exerciseNoticeEnvelopeCompletedAtstring | nullrequired
exerciseNoticeSignedAtstring | nullrequired
paidAtstring | nullrequired
settledAtstring | nullrequired
createdAtstringrequired
updatedAtstringrequired
legacyMigratedAtstring | nullrequired
legacyModelIDinteger | nullrequired
isSignedboolean | nullrequired
isPaidboolean | nullrequired
isExercisedboolean | nullrequired
isUnderLockupboolean | nullrequired
isOffPlatformboolean | nullrequired
isTerminatedboolean | nullrequired
warrantLabelstring | nullrequired
warrantLockupobject[]required
Show child attributes
legacyMigratedAtstring | nullrequired
legacyModelIDinteger | nullrequired
lockupIDstringrequired
roleInOrgIDstringrequired
investorEntityIDstring | nullrequired
warrantIDstringrequired
unlockDatestringrequired
unlockUnitsstringrequired
sequenceintegerrequired
settledUnitsstring | nullrequired
settlementIDstring | nullrequired
taxReferenceIDstring | nullrequired
createdAtstringrequired
updatedAtstringrequired
payrollReportingGroupIDstring | nullrequired
statusstring | nullrequired
taxEngineProcessingStatestring | nullrequired
taxEnginePayrollIDstring | nullrequired
taxEngineClaimIDstring | nullrequired
fiatFmvstring | nullrequired
settlementRecordobject | nullrequired
Show child attributes
settlementIDstringrequired
roleInOrgIDstringrequired
scheduleAmountsanyrequired
recordedViastring | nullrequired
revisionintegerrequired
supersededDocumentIDsstring[]required
settledUnitsstringrequired
cashUnitsstring | nullrequired
settledDatestringrequired
settlementMethodstringrequired
createdAtstringrequired
updatedAtstringrequired
documentIDstring | nullrequired
legacyMigratedAtstring | nullrequired
legacyModelIDinteger | nullrequired
tokenNamestring | nullrequired
withheldUnitsstring | nullrequired
fmvstring | nullrequired
tokenSettlementobject | nullrequired
Show child attributes
tokenSettlementIDstringrequired
settlementIDstringrequired
roleInOrgIDstringrequired
addressstring | nullrequired
tokenCurrencyCodestringrequired
tokenNetworkstring | nullrequired
percentageOfTransactionAttributedToSettlementstringrequired
transactionLinkstringrequired
transactionHashstringrequired
createdAtstringrequired
updatedAtstringrequired
legacyMigratedAtstring | nullrequired
legacyModelIDinteger | nullrequired
walletReferenceIDstring | nullrequired
tokenWalletReferenceIDstring | nullrequired
stablecoinAmountstring | nullrequired
stablecoinSymbolstring | nullrequired
stablecoinTransactionHashstring | nullrequired
stablecoinTransactionLinkstring | nullrequired
taxReferenceobject | nullrequired
Show child attributes
taxReferenceIDstringrequired
roleInOrgIDstringrequired
typestringrequired
statusstringrequired
payrollIDstringrequired
unitsToWithholdstringrequired
totalUnitsstringrequired
unitsToDistributestringrequired
taxCurrencyCodestringrequired
valueInTaxCurrencystringrequired
amountToWithholdInTaxCurrencystringrequired
documentIDstring | nullrequired
taxDataanyrequired
legacyMigratedAtstring | nullrequired
legacyModelIDinteger | nullrequired
fmvstring | nullrequired
fiatFmvstring | nullrequired
rejectionReasonstring | nullrequired
withholdingPercentagestring | nullrequired
stablecoinSplitPercentagestring | nullrequired
stablecoinAmountstring | nullrequired
stablecoinFmvstring | nullrequired
desiredSettlementMethodstringrequired
fmvSourcestring | nullrequired
fmvAsOfstring | nullrequired
fmvUsdstring | nullrequired
localCurrencyCodestring | nullrequired
fmvLocalstring | nullrequired
finalizedWalletAddressstring | nullrequired
settlmentDocumentIDstring | nullrequired
createdAtstringrequired
updatedAtstringrequired
400Bad request
401Unauthorized
403Forbidden
404Not found
409Conflict
429Response 429
Was this page helpful? Suggest edits