Contractor Dashboard

Contractors need a space to view their profile information and payment history as well as access their 1099 form and other tax information. You can provide this out-of-the-box with the white-label component or build a custom dashboard using our API.

In this guide

• The endpoints needed to recreate the Contractor Dashboard.
• How to embed the white-label Contractor Dashboard in your application.

API

We’ll use Zeal’s white-label Contractor Dashboard as a reference for our custom dashboard.

Home Page

1. Call Get Contractor Payments by Contractor.

🔔

Note

Remember to replace the placeholders such as {{testApiKey}} in the code samples below.

curl --request GET \
     --url 'https://api.zeal.com/contractorPayments?companyID={{companyID}}&contractorID={{contractorID}}' \
     --header 'Accept: application/json' \
     --header 'Authorization: Bearer {{testApiKey}}' \

2. Call Get Contractor Payment by ID to show details of a particular payment.

curl --request GET \
     --url 'https://api.zeal.com/contractorPayment?companyID={{companyID}}&contractorPaymentID={{contractorPaymentID}}' \
     --header 'Accept: application/json' \
     --header 'Authorization: Bearer {{testApiKey}}' \

Profile Page

1. Use Get/Update Contractor Information to allow the contractor to view/edit their profile information.

curl --request GET \
     --url 'https://api.zeal.com/contractors?companyID={{companyID}}&contractorID={{contractorID}}' \
     --header 'Accept: application/json' \
     --header 'Authorization: Bearer {{testApiKey}}'

2. Call Get Bank Account by Employee/Contractor ID to get information about a contractor's bank account. Use Update Bank Account to allow the contractor to correct their bank information.

curl --request GET \
     --url 'https://api.joinpuzzl.com/bankaccount?companyID={{companyID}}&id={{contractorID}}' \
     --header 'Accept: application/json' \
     --header 'Authorization: Bearer {{testApiKey}}'

Contractor Documents

Call Get Documents to retrieve a list of employee documents such as 1099s or 1099 Cs.

curl --request GET \
     --url 'https://api.zeal.com/documents?companyID={{companyID}}&id={{contractorID}}' \
     --header 'Accept: application/json' \
     --header 'Authorization: Bearer {{testApiKey}}'

White-Label

1. During the contractor onboarding flow, include the account creation step by setting "contractor_acct": true

curl --request POST \
     --url https://api.zeal.com/contractors/onboard \
     --header 'Accept: application/json' \
     --header 'Authorization: Bearer {{testApiKey}}' \
     --header 'Content-Type: application/json' \
     --data '
{
     "profile": true,
     "contractor_acct": true
}
'

2. The contractor creates credentials that they can use to log into their contractor dashboard.

3. The contractor navigates to your domain (e.g. payroll.[your-domain].com) and inputs their credentials to log in.

Recap

• The Contractor Dashboard provides core functionality to your payroll products such as allowing users to access paystubs and personal information.
• All the data and processes needed to build your customer contractor dashboard are exposed through Zeal's API endpoints.
• You may embed the white-label Contractor Dashboard directly in your application.