Skip to main content
GET
List licensed entities
Returns the legal entities your credential can see: your own organization plus every branch beneath it. This is the endpoint to call first β€” most other endpoints take a downstreamEntityId that comes from here.
Scope is your subtree, not your whole group. A credential minted at the top company sees the top company and all its branches. A credential minted at a branch sees that branch and nothing above or beside it. See Downstream Getting Started for why.

Narrowing

Pass downstreamEntityId to return a single entity. An id outside your subtree returns 404, the same response as an id that does not exist β€” we do not confirm that another agency’s entity exists.

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 licensed entities

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"