Documents

Get My Hris Documents

Lists the caller's employee-visible documents with signed download URLs plus pending-countersignature and finalizing items.

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

Not available to API keys.

curl --request GET \
  --url 'https://api.toku.com/hris/get-my-hris-documents' \
  --header 'Authorization: Bearer <token>'
200 response
{
  "documents": [
    {
      "id": "string",
      "category": "string",
      "stepId": "string",
      "displayName": "string",
      "fileName": "string",
      "downloadUrl": "string",
      "createdAt": "string",
      "fileSizeInBytes": 0,
      "liveTemplateInstanceId": "string",
      "signingDelivery": "IN_APP",
      "signingStatus": "NOT_SENT",
      "documentSource": "ADMIN_UPLOAD"
    }
  ],
  "pendingCountersignatureCategories": [
    "string"
  ],
  "pendingCountersignatureDocuments": [
    {
      "category": "string",
      "templateInstanceId": "string",
      "displayName": "string"
    }
  ],
  "finalizingDocuments": [
    {
      "category": "string",
      "templateInstanceId": "string",
      "displayName": "string",
      "envelopeId": "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
documentsobject[]required
Show child attributes
idstringrequired
categorystringrequired
stepIdstring | nullrequired
displayNamestring | nullrequired
fileNamestringrequired
downloadUrlstringrequired
createdAtstringrequired
fileSizeInBytesnumber | nullrequired
liveTemplateInstanceIdstring | nullrequired
signingDeliverystring | nullrequired

Available options: IN_APP, EMAIL, null

signingStatusstring | nullrequired

Available options: NOT_SENT, AWAITING_SIGNATURE, AWAITING_COUNTERSIGNATURE, FINALIZING, SIGNED, DELIVERED, DECLINED, CANCELLED, VOIDED, EXPIRED, SUPERSEDED, null

documentSourcestring | nullrequired

Available options: ADMIN_UPLOAD, WORKER_UPLOAD, LEGACY_MIGRATION, LEGACY_SIGNED, LEGACY_VOIDED, LEGACY_DECLINED, LEGACY_UNSIGNED, null

pendingCountersignatureCategoriesstring[]required
pendingCountersignatureDocumentsobject[]required
Show child attributes
categorystringrequired
templateInstanceIdstringrequired
displayNamestringrequired
finalizingDocumentsobject[]required
Show child attributes
categorystringrequired
templateInstanceIdstringrequired
displayNamestringrequired
envelopeIdstringrequired
400Bad request
401Unauthorized
403Forbidden
404Not found
409Conflict
429Response 429
Was this page helpful? Suggest edits