curl --request GET \
--url https://sandbox.rollfi.xyz/adminPortal/downloadDocument \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"method": "downloadDocument",
"companyId": "82CCB239-764C-49BA-A3A8-00B9C37A59D4",
"documentType": "8655Form"
}
'{
"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
}{
"error": {
"code": 400,
"message": "documentId is required"
}
}Admin Portal
downloadDocument
The downloadDocument API is used to download a Base64 encoded PDF document
When to use:
- When retrieving a pre filled W4 or 8655 to be signed and uploaded
- When retrieving a document that was already uploaded to Rollfi
Required fields:
| Document Description | Required Fields |
|---|---|
| Document uploaded to Rollfi using the uploadDocument API | documentId |
| Pre filled 8655 without signature | companyId, documentType |
| Pre filled W4 without signature | companyId, employeeId, documentType |
| Pre filled State W4 without signature | documentId |
State W4 retrieval
- State W4s are generated for each employee during onboarding after
initateUserKyc - documentIds can be retrieved for state W4 forms using getUploadedDocuments
- complete State W4 forms can be uploaded using the uploadDocument API
- current state support: NJ, OH, NC, KY, KS
GET
/
adminPortal
/
downloadDocument
curl --request GET \
--url https://sandbox.rollfi.xyz/adminPortal/downloadDocument \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"method": "downloadDocument",
"companyId": "82CCB239-764C-49BA-A3A8-00B9C37A59D4",
"documentType": "8655Form"
}
'{
"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
}{
"error": {
"code": 400,
"message": "documentId is required"
}
}Authorizations
Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.
Body
application/json