> ## Documentation Index > Fetch the complete documentation index at: https://docs.turrisfi.com/llms.txt > Use this file to discover all available pages before exploring further. # Entity Licensing Position by State > One row per entity and state, with the licences behind it Returns your entities' licensing position broken down by state: one row per entity and state, with the licence classes held there and their standing. This is a **computed rollup**, the same computation the Turris agency application runs. It is shared code, so this endpoint and the application cannot disagree. If you would rather compute your own view, [List Entity Licenses](/api-reference/v2/downstream/licenses/entity-licenses) returns the raw rows. ## OpenAPI ````yaml openapi/v2.json GET /v2/downstream/entity-license-overview openapi: 3.0.0 info: title: Turris Public API description: API for managing insurance compliance data version: 2.0.0 contact: {} servers: - url: https://public.api.live.turrisfi.com description: Production - url: https://public.api.sandbox.turrisfi.com description: Sandbox security: [] tags: [] paths: /v2/downstream/entity-license-overview: get: tags: - downstream/license-overview summary: Entity licensing position by state description: >- Returns one row per entity and state: how many licenses are held there, how many are active, whether the entity is resident, the lines of authority, and an expiration status derived from the soonest-expiring active license. Narrow with downstreamEntityId. For the licenses behind a row, call List Entity Licenses with the same stateCode. operationId: LicenseOverviewController_getEntityStateOverview_v2 parameters: - name: page required: false in: query description: 1-based page number schema: minimum: 1 default: 1 example: 1 type: number - name: limit required: false in: query description: Page size (max 100) schema: minimum: 1 maximum: 100 default: 50 example: 50 type: number - name: downstreamEntityId required: false in: query description: >- Narrow the results to a single entity in your organization. Defaults to your whole subtree (your entity plus every branch beneath it). Returns 404 if the id is not in your subtree. schema: example: 6610b3d2c2e0a51b8c0d1f02 type: string responses: '200': description: A page of per-state positions content: application/json: schema: type: object properties: data: type: object properties: items: type: array items: $ref: '#/components/schemas/DownstreamStateOverviewResponse' total: type: integer description: Total rows matching the query across all pages example: 137 page: type: integer description: 1-based page number example: 1 limit: type: integer description: Page size example: 50 totalPages: type: integer description: Number of pages, or 0 when there are no rows example: 3 required: - items - total - page - limit - totalPages requestId: type: string description: Unique request identifier example: dev-2c5e7cf2-9acf-4c8c-ab2f-b81f39d775a8 timestamp: type: string description: Response timestamp example: '2025-11-12T20:49:03.293Z' required: - data - requestId - timestamp '400': description: Invalid query parameters content: application/json: schema: $ref: '#/components/schemas/ErrorResponseDto' '401': description: Invalid or missing auth token content: application/json: schema: $ref: '#/components/schemas/ErrorResponseDto' '403': description: Your organization is not entitled to the public API content: application/json: schema: $ref: '#/components/schemas/ErrorResponseDto' '404': description: downstreamEntityId is not in your organization content: application/json: schema: $ref: '#/components/schemas/ErrorResponseDto' components: schemas: DownstreamStateOverviewResponse: type: object properties: holderType: type: string description: Whether an agency entity or a producer holds this position enum: - entity - producer example: entity holderId: type: string description: The entity or producer this rollup is for example: 6610b3d2c2e0a51b8c0d1f02 holderName: type: string description: Name of the holder example: Philadelphia Branch downstreamEntityId: type: string description: The agency this holder sits under example: 6610b3d2c2e0a51b8c0d1f02 stateCode: type: string description: State or territory enum: - AL - AK - AZ - AR - CA - CO - CT - DE - FL - GA - HI - ID - IL - IN - IA - KS - KY - LA - ME - MD - MA - MI - MN - MS - MO - MT - NE - NV - NH - NJ - NM - NY - NC - ND - OH - OK - OR - PA - RI - SC - SD - TN - TX - UT - VT - VA - WA - WV - WI - WY - GU - PR - VI - DC example: PA licenseCount: type: number description: Licenses held in this state, in any status example: 3 activeLicenseCount: type: number description: How many of those are active example: 2 isResident: type: boolean description: Whether the holder is resident in this state example: true expirationStatus: type: string description: >- Derived from the soonest-expiring ACTIVE license, on a flat 60-day window. A computed value, not a stored one: retuning the window changes it for unchanged data. enum: - not expired - expiring - expired example: not expired nextRenewalDate: type: string description: ISO 8601 soonest renewal date among active licenses in this state example: '2027-04-01T00:00:00.000Z' lineOfAuthorityCodes: description: Distinct line-of-authority codes held across this state example: - '16' - '20' type: array items: type: array required: - holderType - holderId - holderName - downstreamEntityId - stateCode - licenseCount - activeLicenseCount - isResident - expirationStatus - lineOfAuthorityCodes ErrorResponseDto: type: object properties: statusCode: type: number description: HTTP status code requestId: type: string description: Unique request identifier for debugging errorType: type: string description: >- Machine-readable error classification. Branch on this rather than on `errorMessage`, which is prose and may change. Authentication failures returned by our identity provider are forwarded verbatim, so a 401 can carry a code outside this list; treat an unrecognised value as a generic failure of its HTTP status. enum: - conflict - contact_not_authorized - document_exceeds_page_limit - downstream_entity_member_exists - duplicate_external_id_error - duplicate_member_email - duplicate_producer_code_error - forbidden - gateway_timeout - inactive_email - internal_server_error - invalid_email - invalid_email_for_invites - invalid_organization_category - invalid_organization_slug - invalid_phone_number - invalid_token - invite_limit_reached - jwt_invalid - m2m_client_not_found - not_found - organization_already_exists - organization_slug_already_used - payment_required - producer_agreement_required - product_feature_subscription_required - service_unavailable - session_authorization_error - some_custom_error_string - throttled - too_many_requests - unauthorized - unauthorized_client - unexpected_400_stytch_error - unexpected_403_stytch_error - unexpected_404_stytch_error - unexpected_error - unexpected_stytch_error - unprocessable_entity - validation_error example: validation_error errorMessage: description: Array of error messages type: array items: type: string timestamp: type: string description: ISO timestamp when the error occurred details: type: object description: Additional error context required: - statusCode - requestId - errorType - errorMessage - timestamp ```` ## Related topics - [Entity Licensing Summary](/api-reference/v2/downstream/license-overview/entity-license-summary.md) - [Producer Licensing Position by State](/api-reference/v2/downstream/license-overview/producer-license-overview.md) - [Producer Licensing Summary](/api-reference/v2/downstream/license-overview/producer-license-summary.md)