Skip to main content
GET
/
adminPortal#downloadDocument
downloadDocument
curl --request GET \
  --url 'https://sandbox.rollfi.xyz/adminPortal#downloadDocument' \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "method": "downloadDocument",
  "documentId": "24A9F639-689C-4E7D-80CB-14AD3A608B21"
}
'
{
  "documentId": "24A9F639-689C-4E7D-80CB-14AD3A608B21",
  "companyId": "6FFBAEFF-020F-4F63-A140-0348BD0F0FCB",
  "employeeId": "161978BD-C696-495A-87DC-226B9D0D5A3B",
  "payPeriodId": null,
  "fileName": "sample-document.pdf",
  "documentType": "Team Documents",
  "fileBase64": "JVeLjz9MKMSAwIG9iago8PAovVHlwZSAvQ2F0YWxvZwovUGFnZXMgMiAwIFIKPj4KZW5kb2JqCjIgMCBvYmoKPDwKL1R5cGUgL1BhZ2sssVzCi9LaWRzIFszIDAgUl0KL0NvdW50IDEKPD4KZW5kb2JqCjMgMCBvYmoKPDwKL1R5cGUgL1BhZ2UKL1BhcmVudCAyIDAgUgovTWVkaWFCb3ggWzAgMCA2MTIgNzkyXQovUmVzb3VyY2VzIDw8ChegHl80UERGIC9UZXh0IC9JbWFnZUIgL0ltYWdlQyAvSW1hZ2VJXQo+PgovQ29udGVudHMgNCAwIFIKPj4KZW5kb2JqCjQgMCBvYmoKPDwKL0xlbmd0aCA0NAo+PgpzdHJlYW0KQlQKL0YxIDEyIFRmCjcyIDcyMCBUZAooSGVsbG8gV29ybGQpIFRqCkVUCmVuZHN0cmVhbQplbmRvYmoKeHJlZHwgHllLMha6Gh9DAwMCA2NTUzNSBmIAowMDAwMDAwMDA5IDAwMDAwIG4gCjAwMDAwMDAwNTggMDAwMDAgbiAKMAowMDAwMDAwMjQ1IDAwMDAwIG4gCnRyYWlsZXIKPDwKL1NpemUgNQovUm9vdCAxIDAgUgo+PgpzdGFydHhyZWYKMzM4CiUlRU9G",
  "downloadCount": 1
}

Authorizations

​
Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Body

application/json
​
method
string
required
​
documentId
string
required

Response

​
documentId
string
required
​
companyId
string
required
​
fileName
string
required
​
documentType
string
required
​
fileBase64
string
required
​
downloadCount
integer
required
​
employeeId
string | null
​
payPeriodId
string | null