Grants, vesting & distributions
Get Documents
Lists the caller's non-archived documents including signature request and signator details.
Not available to API keys.
curl --request GET \
--url 'https://api.toku.com/hris/get-documents' \
--header 'Authorization: Bearer <token>'[
{
"supersededAt": "string",
"documentID": "string",
"roleInOrgID": "string",
"investorEntityID": "string",
"documentName": "string",
"documentDescription": "string",
"documentType": "WARRANT_AGREEMENT",
"fileID": "string",
"signedAt": "string",
"archivedAt": "string",
"createdAt": "string",
"updatedAt": "string",
"deletedAt": "string",
"grantID": "string",
"warrantID": "string",
"legacyMigratedAt": "string",
"legacyModelID": 0,
"visibleToRole": true,
"visibleToClientAdmin": true,
"file": {
"fileID": "string",
"orgID": "string",
"fileName": "string",
"mimeType": "string",
"fileKey": "string",
"fileBucket": "string",
"fileUploaded": "string",
"fileSizeInBytes": "string",
"createdByUserID": "string",
"createdAt": "string",
"updatedAt": "string",
"legacyMigratedAt": "string",
"legacyModelID": 0,
"type": "string",
"fileURL": "string",
"fileDownloadURL": "string",
"generatedTemplateInstances": [
{
"status": "CREATED",
"signingProfileKeySnapshot": "EMPLOYEE_ONLY",
"employeeCompletedAt": "string",
"countersignerCompletedAt": "string",
"signedFile": {
"fileID": "string",
"orgID": "string",
"fileName": "string",
"mimeType": "string",
"fileKey": "string",
"fileBucket": "string",
"fileUploaded": "string",
"fileSizeInBytes": "string",
"createdByUserID": "string",
"createdAt": "string",
"updatedAt": "string",
"legacyMigratedAt": "string",
"legacyModelID": 0,
"type": "string",
"fileURL": "string",
"fileDownloadURL": "string"
}
}
]
},
"documentSignatureRequest": {
"documentSignatureRequestID": "string",
"roleInOrgID": "string",
"investorEntityID": "string",
"documentID": "string",
"signedFileID": "string",
"docusignEnvelopeID": "string",
"documentSignators": [
{
"documentSignatorID": "string",
"roleInOrgID": "string",
"documentSignatureRequestID": "string",
"name": "string",
"email": "string",
"docusignRecipientID": "string",
"signedAt": "string",
"rejectedAt": "string",
"createdAt": "string",
"updatedAt": "string"
}
],
"signedFile": {
"fileID": "string",
"orgID": "string",
"fileName": "string",
"mimeType": "string",
"fileKey": "string",
"fileBucket": "string",
"fileUploaded": "string",
"fileSizeInBytes": "string",
"createdByUserID": "string",
"createdAt": "string",
"updatedAt": "string",
"legacyMigratedAt": "string",
"legacyModelID": 0,
"type": "string",
"fileURL": "string",
"fileDownloadURL": "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.
Response
200Successful response
supersededAtstring | nullrequireddocumentIDstringrequiredroleInOrgIDstringrequiredinvestorEntityIDstring | nullrequireddocumentNamestringrequireddocumentDescriptionstring | nullrequireddocumentTypestringrequiredAvailable options: WARRANT_AGREEMENT, EXERCISE_NOTICE, PAYMENT_PROOF, GRANT_AGREEMENT, EIGHTY_THREE_B_ELECTION, EIGHTY_THREE_B_ELECTION_RECIEPT, RECIEPTS, SETTLEMENT_STATEMENT, SECTION_431_ELECTION_EMPLOYEE, SECTION_431_ELECTION_EMPLOYER, OTHER
fileIDstringrequiredsignedAtstring | nullrequiredarchivedAtstring | nullrequiredcreatedAtstringrequiredupdatedAtstringrequireddeletedAtstring | nullrequiredgrantIDstring | nullrequiredwarrantIDstring | nullrequiredlegacyMigratedAtstring | nullrequiredlegacyModelIDnumber | nullrequiredvisibleToRolebooleanrequiredvisibleToClientAdminbooleanrequiredfileobjectrequiredShow child attributes
fileIDstringrequiredorgIDstringrequiredfileNamestringrequiredmimeTypestringrequiredfileKeystringrequiredfileBucketstringrequiredfileUploadedstring | nullrequiredfileSizeInBytesstring | nullrequiredAllowed: matches ^-?\d+$
createdByUserIDstring | nullrequiredcreatedAtstringrequiredupdatedAtstringrequiredlegacyMigratedAtstring | nullrequiredlegacyModelIDnumber | nullrequiredtypestringrequiredfileURLstringrequiredfileDownloadURLstringrequiredgeneratedTemplateInstancesobject[]requiredShow child attributes
statusstringrequiredAvailable options: CREATED, SENT, SIGNED, DECLINED, FAILED, SUPERSEDED, DELIVERED, VOIDED, EXPIRED
signingProfileKeySnapshotstringrequiredAvailable options: EMPLOYEE_ONLY, EMPLOYEE_AND_COUNTERSIGNER, COUNTERSIGNER_ONLY, NO_SIGNATURE, CLIENT_AND_COUNTERSIGNERS
employeeCompletedAtstring | nullrequiredcountersignerCompletedAtstring | nullrequiredsignedFileobject | nullrequiredShow child attributes
fileIDstringrequiredorgIDstringrequiredfileNamestringrequiredmimeTypestringrequiredfileKeystringrequiredfileBucketstringrequiredfileUploadedstring | nullrequiredfileSizeInBytesstring | nullrequiredAllowed: matches ^-?\d+$
createdByUserIDstring | nullrequiredcreatedAtstringrequiredupdatedAtstringrequiredlegacyMigratedAtstring | nullrequiredlegacyModelIDnumber | nullrequiredtypestringrequiredfileURLstringrequiredfileDownloadURLstringrequireddocumentSignatureRequestobject | nullrequiredShow child attributes
documentSignatureRequestIDstringrequiredroleInOrgIDstringrequiredinvestorEntityIDstring | nullrequireddocumentIDstringrequiredsignedFileIDstring | nullrequireddocusignEnvelopeIDstringrequiredsignatureBoxesanyrequireddocumentSignatorsobject[]requiredShow child attributes
documentSignatorIDstringrequiredroleInOrgIDstringrequireddocumentSignatureRequestIDstringrequirednamestringrequiredemailstringrequireddocusignRecipientIDstringrequiredsignedAtstring | nullrequiredrejectedAtstring | nullrequiredcreatedAtstringrequiredupdatedAtstringrequiredsignedFileobject | nullrequiredShow child attributes
fileIDstringrequiredorgIDstringrequiredfileNamestringrequiredmimeTypestringrequiredfileKeystringrequiredfileBucketstringrequiredfileUploadedstring | nullrequiredfileSizeInBytesstring | nullrequiredAllowed: matches ^-?\d+$
createdByUserIDstring | nullrequiredcreatedAtstringrequiredupdatedAtstringrequiredlegacyMigratedAtstring | nullrequiredlegacyModelIDnumber | nullrequiredtypestringrequiredfileURLstringrequiredfileDownloadURLstringrequired