Zeal University

Contractor Dashboard

Suggest Edits

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.

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}}' \
  1. 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}}'
  1. 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}}'

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
}
'
  1. The contractor creates credentials that they can use to log into their contractor dashboard.

Contractor Onboarding Create Account

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

Updated about 1 month ago