Skip to main content
GET
Get Contractor Custom Paperwork
Returns the custom paperwork forms this contractor must complete, and whether each one is complete. These are the same custom forms the contractor is shown during onboarding. A form is included only when it is live, its effective date has passed, it is not archived, and it matches the contractor’s worker type, jurisdiction, and attribute rules. Jurisdictions are the US, the contractor’s residence state, and their working state. all_required_complete is true when every returned form is complete, including when paperwork is empty. Archived forms are not listed, even if the contractor signed them. Pass companyID and contractorID as query parameters. The API key must be allowed to access that company. Custom paperwork must be enabled for the company. If it is not, the request returns Your company does not have access to interact with this route. (code 126, status 403).

Authorizations

Authorization
string
header
required

Query Parameters

companyID
string
required

Company ID of the employer

contractorID
string
required

Contractor ID

Response

200

success
boolean
testMode
boolean
data
object