Skip to main content
GET
cURL
Returns the license compliance status for a specific downstream entity association in your upstream entity’s network, filtered by state and product.

Resident states

Every entry in data.states carries isResidentState. The entity’s resident states are the states in which it holds a license with resident residency, active or inactive, and the response always includes them:
  • A requested state that is also a resident state is flagged in place and keeps its verdicts.
  • A resident state outside the evaluated set is appended after the requested states, sorted by state name. That covers a state the product is not configured for, and a configured state you did not request by stateCode. Each appended entry carries its own verdict, resolved as described below.
  • Every resident-state entry carries residentLicense: the license’s status (active or inactive), class, number, next renewal date when NIPR reports one, and whether the entity is appointed with the product’s carrier in that state.

How a resident state’s verdict is resolved

A product’s compliance configuration covers the states the product is sold in, and an entity’s resident state is often not one of them. A license fact on its own (“an active resident license exists”) is not a compliance verdict, so the requirement to evaluate each resident state against is found in two steps, and requirementSource on the entry tells you which step answered:
  • product: the product is configured for the state. Its own license and appointment requirements were evaluated, exactly as for a requested state. Every requested state the product is configured for carries this value.
  • state default: the product is not configured for the state. The verdicts were evaluated against the Turris default requirements for that state and the product’s line of business: the license default for licenseStatus, and the appointment default, against the product’s carrier, for appointmentStatus. A state with a license default but no appointment default gets appointmentStatus: null.
When neither step finds a requirement, because no default exists for that state and line of business or the product has no line of business, requirementSource, licenseStatus and appointmentStatus are all null. The residentLicense facts are still returned; the verdict is reported as unavailable rather than guessed from the license’s status. With stateCode given, the requested state is always states[0]. hasResidentLicense at the top of data is true when at least one entry is a resident state; it does not say whether every resident license is active. An inactive resident license puts every non-resident license that depends on it at risk, which is why these entries are returned whether or not you asked for the state. When rolling states up into one verdict, decide first whether a state default verdict belongs in your rollup, and skip the entries whose requirementSource is null.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

downstreamEntityAssociationId
string
required

Downstream entity association ID

Example:

"507f1f77bcf86cd799439011"

Query Parameters

stateCode
string
required

State code (two-letter abbreviation)

Example:

"CA"

productId
string
required

Product ID

Example:

"6098a7f8c9e77c001f3c5a1b"

Response

Downstream entity license compliance statuses

data
object
required
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"