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.

• starting_after string

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

• ending_before string

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

Responses

• 200 application/json

  Returns an array of entity objects. If no more entities are available, the resulting array will be empty.

  Hide response attributes Show response attributes object

  • address object
    Hide address attributes Show address attributes object

    • country string | null

      2-letter country code.

    • line1 string

      Address line 1 (Street address/PO Box).

    • line2 string | null

      Address line 2 (Apartment/Suite/Unit/Building).

    • locality string

      City/District/Suburb/Town/Village.

    • postalcode string

      ZIP or postal code.

    • region string

      2-letter state code.

  • coverage_limit object

    The contracting entity's minimum required coverage limits.

    Hide coverage_limit attributes Show coverage_limit attributes object

    • aggregate_limit integer Required

      The total amount the insurance company will pay for multiple claims over the course of one policy term.

      A positive integer representing the aggregate limit expressed in cents (e.g., 100000000 cents to represent $1,000,000). The minimum amount is 1000 cents US.

    • occurrence_limit integer Required

      The total amount the insurance company will pay per incident during the policy term.

      A positive integer representing the per occurrence limit expressed in cents (e.g., 100000000 cents to represent $1,000,000). The minimum amount is 1000 cents US.

  • created integer(int64)

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

  • id string

    Unique identifier for the object.

  • name string

    The contracting entity's legal name.

  • required_coverage array[string]

    An array of coverage types that can include one or more of the following insurance coverage values: general, professional and workers-comp.

    Values are general, professional, or workers-comp.