Entity Licensing Summary

Entity licensing summary

curl --request GET \
  --url https://public.api.live.turrisfi.com/v2/downstream/entity-license-summary

const options = {method: 'GET'};

fetch('https://public.api.live.turrisfi.com/v2/downstream/entity-license-summary', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "data": {
    "items": [
      {
        "holderType": "entity",
        "holderId": "6610b3d2c2e0a51b8c0d1f02",
        "holderName": "Philadelphia Branch",
        "downstreamEntityId": "6610b3d2c2e0a51b8c0d1f02",
        "domicileStates": [
          {
            "stateCode": "PA",
            "hasActiveLicense": true
          }
        ],
        "licensedStateCount": 12,
        "complianceDataSynchronizationStatus": "success"
      }
    ],
    "total": 137,
    "page": 1,
    "limit": 50,
    "totalPages": 3
  },
  "requestId": "dev-2c5e7cf2-9acf-4c8c-ab2f-b81f39d775a8",
  "timestamp": "2025-11-12T20:49:03.293Z"
}

{
  "statusCode": 123,
  "requestId": "<string>",
  "errorType": "validation_error",
  "errorMessage": [
    "<string>"
  ],
  "timestamp": "<string>",
  "details": {}
}

{
  "statusCode": 123,
  "requestId": "<string>",
  "errorType": "validation_error",
  "errorMessage": [
    "<string>"
  ],
  "timestamp": "<string>",
  "details": {}
}

{
  "statusCode": 123,
  "requestId": "<string>",
  "errorType": "validation_error",
  "errorMessage": [
    "<string>"
  ],
  "timestamp": "<string>",
  "details": {}
}

{
  "statusCode": 123,
  "requestId": "<string>",
  "errorType": "validation_error",
  "errorMessage": [
    "<string>"
  ],
  "timestamp": "<string>",
  "details": {}
}

GET

downstream

entity-license-summary

Entity licensing summary

curl --request GET \
  --url https://public.api.live.turrisfi.com/v2/downstream/entity-license-summary

const options = {method: 'GET'};

fetch('https://public.api.live.turrisfi.com/v2/downstream/entity-license-summary', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "data": {
    "items": [
      {
        "holderType": "entity",
        "holderId": "6610b3d2c2e0a51b8c0d1f02",
        "holderName": "Philadelphia Branch",
        "downstreamEntityId": "6610b3d2c2e0a51b8c0d1f02",
        "domicileStates": [
          {
            "stateCode": "PA",
            "hasActiveLicense": true
          }
        ],
        "licensedStateCount": 12,
        "complianceDataSynchronizationStatus": "success"
      }
    ],
    "total": 137,
    "page": 1,
    "limit": 50,
    "totalPages": 3
  },
  "requestId": "dev-2c5e7cf2-9acf-4c8c-ab2f-b81f39d775a8",
  "timestamp": "2025-11-12T20:49:03.293Z"
}

{
  "statusCode": 123,
  "requestId": "<string>",
  "errorType": "validation_error",
  "errorMessage": [
    "<string>"
  ],
  "timestamp": "<string>",
  "details": {}
}

{
  "statusCode": 123,
  "requestId": "<string>",
  "errorType": "validation_error",
  "errorMessage": [
    "<string>"
  ],
  "timestamp": "<string>",
  "details": {}
}

{
  "statusCode": 123,
  "requestId": "<string>",
  "errorType": "validation_error",
  "errorMessage": [
    "<string>"
  ],
  "timestamp": "<string>",
  "details": {}
}

{
  "statusCode": 123,
  "requestId": "<string>",
  "errorType": "validation_error",
  "errorMessage": [
    "<string>"
  ],
  "timestamp": "<string>",
  "details": {}
}

Returns one row per entity — active, expiring and expired licence counts, resident state, and when Turris last synced that entity with NIPR. Use this for a dashboard tile. Use Entity Licensing Position by State when you need the state-by-state breakdown behind the numbers.

Query Parameters

page

number

default:1

1-based page number

Required range: x >= 1

Example:

1

limit

number

default:50

Page size (max 100)

Required range: 1 <= x <= 100

Example:

50

downstreamEntityId

string

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.

Example:

"6610b3d2c2e0a51b8c0d1f02"

Response

A page of entity summaries

data

object

required

Show child attributes

requestId

string

required

Unique request identifier

Example:

"dev-2c5e7cf2-9acf-4c8c-ab2f-b81f39d775a8"

timestamp

string

required

Response timestamp

Example:

"2025-11-12T20:49:03.293Z"

Start Here

Shared Endpoints

Licensed Entities

Producers

Contacts

Licenses

Actions Required

Licensing Overview

Appointments

License Requests

Compliance Configurations

Markets

Corporate Registrations

Documents

Surplus Lines

Query Parameters

Response