> ## Documentation Index
> Fetch the complete documentation index at: https://docs.zeal.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Contractor Custom Paperwork

> Returns the custom paperwork required for a contractor and whether each form is complete.

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).


## OpenAPI

````yaml openapi/zeal-api.json get /contractors/getCustomPaperwork
openapi: 3.1.0
info:
  title: zeal-api
  version: '1.0'
servers:
  - url: https://api.zeal.com
security:
  - sec0: []
paths:
  /contractors/getCustomPaperwork:
    get:
      summary: Get Contractor Custom Paperwork
      description: >-
        Returns the custom paperwork required for a contractor and whether each
        form is complete.
      operationId: get-contractor-custom-paperwork
      parameters:
        - name: companyID
          in: query
          description: Company ID of the employer
          required: true
          schema:
            type: string
        - name: contractorID
          in: query
          description: Contractor ID
          required: true
          schema:
            type: string
      responses:
        '200':
          description: '200'
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  testMode:
                    type: boolean
                  data:
                    type: object
                    properties:
                      contractorID:
                        type: string
                      all_required_complete:
                        type: boolean
                        description: >-
                          True when every required custom paperwork form is
                          complete, including when paperwork is empty.
                      paperwork:
                        type: array
                        items:
                          type: object
                          properties:
                            templateID:
                              type: string
                            form_name:
                              type: string
                            status:
                              type: string
                              enum:
                                - complete
                                - incomplete
              examples:
                Result:
                  value:
                    success: true
                    testMode: true
                    data:
                      contractorID: 603d0f8f1c4b2a4e28c8f0b5
                      all_required_complete: false
                      paperwork:
                        - templateID: d290f1ee-6c54-4b01-90e6-d701748f0851
                          form_name: Contractor acknowledgement
                          status: incomplete
        '400':
          description: '400'
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: false
                  testMode:
                    type: boolean
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                        code:
                          type: integer
                        status:
                          type: integer
              examples:
                Result:
                  value:
                    success: false
                    testMode: true
                    errors:
                      - message: Contractor with this contractorID does not exist
                        code: 73
                        status: 400
        '403':
          description: '403'
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: false
                  testMode:
                    type: boolean
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                        code:
                          type: integer
                        status:
                          type: integer
              examples:
                Custom paperwork disabled:
                  value:
                    success: false
                    testMode: true
                    errors:
                      - message: >-
                          Your company does not have access to interact with
                          this route.
                        code: 126
                        status: 403
      deprecated: false
components:
  securitySchemes:
    sec0:
      type: apiKey
      in: header
      name: Authorization
      x-bearer-format: bearer

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.