Retrieve an entity

GET /api/v1/entities/{entity_id}

Retrieves the details of an existing entity. You need only supply the unique entity ID that was returned upon entity creation.

Path parameters

  • entity string Required

    The ID of the desired entity (e.g., en_Ah3tqYn).

Responses

  • 200 application/json

    Returns an entity object if a valid entity ID was provided. Returns an error otherwise.

    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.

      • ZIP or postal code.

      • region string

        2-letter state code.

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

GET /api/v1/entities/{entity_id}
curl \
 -X GET https://api.1099policy.com/api/v1/entities/{entity_id}
Response examples (200)
{
  "address": {
    "country": "null",
    "line1": "92 Geary St",
    "line2": "null",
    "locality": "San Francisco",
    "postalcode": 94114,
    "region": "CA"
  },
  "coverage_limit": {
    "aggregate_limit": 200000000,
    "occurrence_limit": 100000000
  },
  "created": 1646818364,
  "id": "en_Ah3tqYn",
  "name": "Apple, Inc",
  "required_coverage": [
    "general",
    "workers-comp"
  ]
}