Path parameters

• contractor string Required

  The ID of the desired contractor (e.g., cn_Ehb3bYa).

Query parameters

• quote string

  A filter to return policies by a specific quote ID.

Responses

• 200 application/json

  Returns a list of the contractors policies. The policies are returned sorted by creation date, with the most recent policy appearing first.

  Hide response attributes Show response attributes object

  • certificates object

    URLs to the certificates of insurance for each of the types of coverage issued to the contractor for the specific job assignment.

    Hide certificates attributes Show certificates attributes object

    • gl_coi_pdf_url string

      The general liability certificate of insurance PDF URL.

    • wc_coi_pdf_url string

      The workers compensation certificate of insurance PDF URL.

  • created integer(int64)

    Time at which the object was created. Measured in seconds since the Unix epoch.

  • effective_date integer(int64)

    A timestamp used to determine the insurance policy start date. Measured in seconds since the Unix epoch. The default effective_date is the next day.

  • expiration_date integer(int64)

    A timestemp used to determine the insurance policy end date. Measured in seconds since the Unix epoch. The default expiration_date is 30 days after the effective_date.

  • id string
  • pdf_url string

    A URL for the hosted insurnace policy PDF, which contractors can view.

  • quote string

    The ID of the quote used to create the policy.

  • status

    One of active, cancelled, or expired.

    Values are active, cancelled, or expired.