List all policies

GET /api/v1/policies

Returns a list of policies you’ve previously created. The policies are returned in sorted order, with the most recent policies appearing first.

Query parameters

  • limit integer

    A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

    Minimum value is 1, maximum value is 100. Default value is 10.

  • A cursor for use in pagination. starting_after is an policy ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with pl_fOo123, your subsequent call can include starting_after=pl_fOo123 in order to fetch the next page of the list.

  • A cursor for use in pagination. ending_before is an policy ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with pl_bAr123, your subsequent call can include ending_before=pl_bAr123 in order to fetch the previous page of the list.

Responses

  • 200 application/json

    An array of policies, up to limit. Each entry in the array is a separate policy object. If no more charges are available, the resulting array will be empty.

    Hide response attributes Show response attributes 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
      • The general liability certificate of insurance PDF URL.

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

    • One of active, cancelled, or expired.

      Values are active, cancelled, or expired.

GET /api/v1/policies
curl \
 -X GET https://api.1099policy.com/api/v1/policies
Response examples (200)
[
  {
    "certificates": {
      "gl_coi_pdf_url": "/bound-policies/prod/gl_coi_pl_wv23Q3lMc1_1691450123.pdf",
      "wc_coi_pdf_url": "/bound-policies/prod/wc_coi_pl_wv23Q3lMc1_1691420903.pdf"
    },
    "created": 1646818364,
    "effective_date": 1646818364,
    "expiration_date": 1678334737,
    "id": "pl_WzFRszJhoY",
    "pdf_url": "http://ten99policy.s3.amazonaws.com/1099policy-coi-sample.pdf",
    "quote": "qt_5DciVga8Kt",
    "status": "active"
  }
]