uploadDocument

curl --request POST \
  --url 'https://sandbox.rollfi.xyz/adminPortal#uploadDocument' \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "method": "uploadDocument",
  "companyId": "6FFBAEFF-020F-4F63-A140-0348BD0F0FCB",
  "employeeId": "161978BD-C696-495A-87DC-226B9D0D5A3B",
  "payPeriodId": "D9108BF3-5FFB-433D-89E2-7A4C79972153",
  "fileName": "sample-document.pdf",
  "documentType": "PayStub",
  "fileBase64": "JVBERi0xLjQKJeLjz9MKMSAwIG9iago8PAovVHlwZSAvQ2F0YWxvZwovUGFnZXMgMiAwIFIKPj4KZW5kb2JqCjIgMCBvYmoKPDwKL1R5cGUgL1BhZ2VzCi9LaWRzIFszIDAgUl0KL0NvdW50IDEKPD4KZW5kb2JqCjMgMCBvYmoKPDwKL1R5cGUgL1BhZ2UKL1BhcmVudCAyIDAgUgovTWVkaWFCb3ggWzAgMCA2MTIgNzkyXQovUmVzb3VyY2VzIDw8Ci9Qcm9jU2V0IFsvUERGIC9UZXh0IC9JbWFnZUIgL0ltYWdlQyAvSW1hZ2VJXQo+PgovQ29udGVudHMgNCAwIFIKPj4KZW5kb2JqCjQgMCBvYmoKPDwKL0xlbmd0aCA0NAo+PgpzdHJlYW0KQlQKL0YxIDEyIFRmCjcyIDcyMCBUZAooSGVsbG8gV29ybGQpIFRqCkVUCmVuZHN0cmVhbQplbmRvYmoKeHJlZgowIDUKMDAwMDAwMDAwMCA2NTUzNSBmIAowMDAwMDAwMDA5IDAwMDAwIG4gCjAwMDAwMDAwNTggMDAwMDAgbiAKMDAwMDAwMDExNSAwMDAwMCBuIAowMDAwMDAwMjQ1IDAwMDAwIG4gCnRyYWlsZXIKPDwKL1NpemUgNQovUm9vdCAxIDAgUgo+PgpzdGFydHhyZWYKMzM4CiUlRU9G"
}
'

{
  "documentId": "181D4FCA-CBDB-49F6-93BE-95B78AD3045E",
  "fileName": "sample-document.pdf",
  "success": true,
  "message": "Document uploaded successfully"
}

Admin Portal

uploadDocument

This API is used to upload compliance and miscellaneous documents to a company for retriveal using the downloadDocument API

When to use:

When adding documents at a company level
When adding employee or pay period specific documents

Only IDs that pertain to the specific documentType are required to ensure they are routed correctly.

Example Document	Requried IDs
Paystubs	companyId, employeeId, payPeriodId
Payroll journals	companyId, payPeriodId
Company handbook	companyId

8655 and W4 forms:

Rollfi supports uploading employee W4s and 8655 forms through the API. These are specified using the documentType

Document	documentType	Required IDs
Employee W4	W4Form	companyId, employeeId
Company 8655	8655Form	companyId

Note:

Documents should be uploaded in base64 encoding for safe storage and retrieval
Uploaded documents can be viewed using getUploadedDocuments and retrieved from storage using downloadDocument

POST

adminPortal#uploadDocument

uploadDocument

curl --request POST \
  --url 'https://sandbox.rollfi.xyz/adminPortal#uploadDocument' \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "method": "uploadDocument",
  "companyId": "6FFBAEFF-020F-4F63-A140-0348BD0F0FCB",
  "employeeId": "161978BD-C696-495A-87DC-226B9D0D5A3B",
  "payPeriodId": "D9108BF3-5FFB-433D-89E2-7A4C79972153",
  "fileName": "sample-document.pdf",
  "documentType": "PayStub",
  "fileBase64": "JVBERi0xLjQKJeLjz9MKMSAwIG9iago8PAovVHlwZSAvQ2F0YWxvZwovUGFnZXMgMiAwIFIKPj4KZW5kb2JqCjIgMCBvYmoKPDwKL1R5cGUgL1BhZ2VzCi9LaWRzIFszIDAgUl0KL0NvdW50IDEKPD4KZW5kb2JqCjMgMCBvYmoKPDwKL1R5cGUgL1BhZ2UKL1BhcmVudCAyIDAgUgovTWVkaWFCb3ggWzAgMCA2MTIgNzkyXQovUmVzb3VyY2VzIDw8Ci9Qcm9jU2V0IFsvUERGIC9UZXh0IC9JbWFnZUIgL0ltYWdlQyAvSW1hZ2VJXQo+PgovQ29udGVudHMgNCAwIFIKPj4KZW5kb2JqCjQgMCBvYmoKPDwKL0xlbmd0aCA0NAo+PgpzdHJlYW0KQlQKL0YxIDEyIFRmCjcyIDcyMCBUZAooSGVsbG8gV29ybGQpIFRqCkVUCmVuZHN0cmVhbQplbmRvYmoKeHJlZgowIDUKMDAwMDAwMDAwMCA2NTUzNSBmIAowMDAwMDAwMDA5IDAwMDAwIG4gCjAwMDAwMDAwNTggMDAwMDAgbiAKMDAwMDAwMDExNSAwMDAwMCBuIAowMDAwMDAwMjQ1IDAwMDAwIG4gCnRyYWlsZXIKPDwKL1NpemUgNQovUm9vdCAxIDAgUgo+PgpzdGFydHhyZWYKMzM4CiUlRU9G"
}
'

{
  "documentId": "181D4FCA-CBDB-49F6-93BE-95B78AD3045E",
  "fileName": "sample-document.pdf",
  "success": true,
  "message": "Document uploaded successfully"
}

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

companyId

string

required

fileName

string

required

fileBase64

string

required

employeeId

string

payPeriodId

string

documentType

string

Response

documentId

string

required

fileName

string

required

success

boolean

required

message

string

required

terminateUser downloadDocument

Documentation Index

Authorizations

Body

Response