Grants, vesting & distributions

Get Documents

Lists the caller's non-archived documents including signature request and signator details.

GEThttps://api.toku.com/hris/get-documents

Not available to API keys.

curl --request GET \
  --url 'https://api.toku.com/hris/get-documents' \
  --header 'Authorization: Bearer <token>'
200 response
[
  {
    "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

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.

Response

200Successful response
supersededAtstring | nullrequired
documentIDstringrequired
roleInOrgIDstringrequired
investorEntityIDstring | nullrequired
documentNamestringrequired
documentDescriptionstring | nullrequired
documentTypestringrequired

Available 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

fileIDstringrequired
signedAtstring | nullrequired
archivedAtstring | nullrequired
createdAtstringrequired
updatedAtstringrequired
deletedAtstring | nullrequired
grantIDstring | nullrequired
warrantIDstring | nullrequired
legacyMigratedAtstring | nullrequired
legacyModelIDnumber | nullrequired
visibleToRolebooleanrequired
visibleToClientAdminbooleanrequired
fileobjectrequired
Show child attributes
fileIDstringrequired
orgIDstringrequired
fileNamestringrequired
mimeTypestringrequired
fileKeystringrequired
fileBucketstringrequired
fileUploadedstring | nullrequired
fileSizeInBytesstring | nullrequired

Allowed: matches ^-?\d+$

createdByUserIDstring | nullrequired
createdAtstringrequired
updatedAtstringrequired
legacyMigratedAtstring | nullrequired
legacyModelIDnumber | nullrequired
typestringrequired
fileURLstringrequired
fileDownloadURLstringrequired
generatedTemplateInstancesobject[]required
Show child attributes
statusstringrequired

Available options: CREATED, SENT, SIGNED, DECLINED, FAILED, SUPERSEDED, DELIVERED, VOIDED, EXPIRED

signingProfileKeySnapshotstringrequired

Available options: EMPLOYEE_ONLY, EMPLOYEE_AND_COUNTERSIGNER, COUNTERSIGNER_ONLY, NO_SIGNATURE, CLIENT_AND_COUNTERSIGNERS

employeeCompletedAtstring | nullrequired
countersignerCompletedAtstring | nullrequired
signedFileobject | nullrequired
Show child attributes
fileIDstringrequired
orgIDstringrequired
fileNamestringrequired
mimeTypestringrequired
fileKeystringrequired
fileBucketstringrequired
fileUploadedstring | nullrequired
fileSizeInBytesstring | nullrequired

Allowed: matches ^-?\d+$

createdByUserIDstring | nullrequired
createdAtstringrequired
updatedAtstringrequired
legacyMigratedAtstring | nullrequired
legacyModelIDnumber | nullrequired
typestringrequired
fileURLstringrequired
fileDownloadURLstringrequired
documentSignatureRequestobject | nullrequired
Show child attributes
documentSignatureRequestIDstringrequired
roleInOrgIDstringrequired
investorEntityIDstring | nullrequired
documentIDstringrequired
signedFileIDstring | nullrequired
docusignEnvelopeIDstringrequired
signatureBoxesanyrequired
documentSignatorsobject[]required
Show child attributes
documentSignatorIDstringrequired
roleInOrgIDstringrequired
documentSignatureRequestIDstringrequired
namestringrequired
emailstringrequired
docusignRecipientIDstringrequired
signedAtstring | nullrequired
rejectedAtstring | nullrequired
createdAtstringrequired
updatedAtstringrequired
signedFileobject | nullrequired
Show child attributes
fileIDstringrequired
orgIDstringrequired
fileNamestringrequired
mimeTypestringrequired
fileKeystringrequired
fileBucketstringrequired
fileUploadedstring | nullrequired
fileSizeInBytesstring | nullrequired

Allowed: matches ^-?\d+$

createdByUserIDstring | nullrequired
createdAtstringrequired
updatedAtstringrequired
legacyMigratedAtstring | nullrequired
legacyModelIDnumber | nullrequired
typestringrequired
fileURLstringrequired
fileDownloadURLstringrequired
400Bad request
401Unauthorized
403Forbidden
404Not found
409Conflict
429Response 429
Was this page helpful? Suggest edits