# Registered identities API reference Source: https://docs.settlemint.com/docs/api-reference/compliance/registered-identities List the on-chain registered contract identities in your system's identity registry, with filtering, search, sorting, and claim counts, through the DALP Platform API. An auditor or compliance integration often needs one question answered: which contract identities are registered in this system's identity registry right now, and what is the state of their claims? The registered identities endpoint answers it. It lists every registered contract identity for the active system, with its entity type, registration status, country, and a breakdown of active, revoked, and untrusted claims. This is the same data that the Console identity registry view is built on. The endpoint is read-only. It reports identities that the registry already tracks. It does not register, update, or remove identities. For authentication and base URL setup, see [Getting started](/docs/api-reference/reference/getting-started). For the wider compliance API map, see [Compliance API route map](/docs/api-reference/compliance). ## Endpoint [#endpoint] | Endpoint | Use it for | | ----------------------------- | --------------------------------------------------------------------- | | `GET /api/v2/system/entities` | List registered contract identities for the active system's registry. | The endpoint uses the collection envelope: `data` holds the page of identities, `meta` carries the total count and facet breakdowns, and `links` carries pagination links. The active organization and system context bound every read, as described in [Organization and system scope](/docs/api-reference/reference/organization-system-scope). The list returns registered contract identities only. It does not list externally owned wallet accounts. Each row corresponds to a contract identity that the system's identity registry has registered. ```bash curl --globoff "https://your-platform.example.com/api/v2/system/entities?filter[status]=registered" \ -H "x-api-key: YOUR_API_KEY" ``` ```json { "data": [ { "id": "0x1111111111111111111111111111111111111111", "contractAddress": "0x2222222222222222222222222222222222222222", "contractName": "Series A Bond", "entityType": "bond", "isContract": true, "status": "registered", "country": "AE", "verificationBadges": [], "lastActivity": "0xabc123...", "activeClaimsCount": 3, "revokedClaimsCount": 0, "untrustedClaimsCount": 0, "deployedInTransaction": "0xabc123..." } ], "meta": { "total": 1, "facets": { "entityType": [{ "value": "bond", "count": 1 }], "status": [{ "value": "registered", "count": 1 }] } }, "links": { "self": "/v2/system/entities?sort=-lastActivity&page[offset]=0&page[limit]=50", "first": "/v2/system/entities?sort=-lastActivity&page[offset]=0&page[limit]=50", "prev": null, "next": null, "last": "/v2/system/entities?sort=-lastActivity&page[offset]=0&page[limit]=50" } } ``` ## Identity fields [#identity-fields] Each row describes one registered contract identity and its claim totals. | Field | Type | Description | | ----------------------- | ----------------- | ------------------------------------------------------------------------------------------------------------ | | `id` | string | The on-chain identity contract address. | | `contractAddress` | string or `null` | The account the identity belongs to. `null` when the account is not resolved. | | `contractName` | string or `null` | The human-readable name for the account, when one is recorded. | | `entityType` | string or `null` | The classification of the registered contract, such as `bond`, `equity`, `fund`, `deposit`, or `stablecoin`. | | `isContract` | boolean or `null` | Always `true` for entries in this list, which holds contract identities. | | `status` | string | The registration status: `registered` for an active registry entry, `pending` otherwise. | | `country` | string or `null` | The ISO 3166-1 alpha-2 country code recorded for the identity, or `null` when none is set. | | `verificationBadges` | string array | Verification badge labels for the identity. An empty array when no badge applies. | | `lastActivity` | string | A reference to the transaction that deployed the identity. Sortable; see [Query controls](#query-controls). | | `activeClaimsCount` | integer | The number of active claims attached to the identity. | | `revokedClaimsCount` | integer | The number of revoked claims attached to the identity. | | `untrustedClaimsCount` | integer | The number of claims issued by an issuer that the registry does not trust. | | `deployedInTransaction` | string | A reference to the transaction that deployed the identity. | The claim counts let an auditor see the trust posture of each identity at a glance. A non-zero `untrustedClaimsCount` flags claims whose issuer is not in the registry's trusted set, so a reviewer can investigate before relying on them. ## Query controls [#query-controls] | Parameter | Description | | ----------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | | `filter[entityType]` | Restrict the list to one entity type, such as `bond`, `equity`, or `fund`. | | `filter[status]` | Restrict the list to `registered` or `pending` identities. | | `filter[q]` | Global search across the identity address and the account name. | | `sort` | JSON:API sort. Sortable fields: `lastActivity`, `identityAddress`, `entityType`. Prefix with `-` for descending. Defaults to `lastActivity` (ascending). | | | Examples: `sort=lastActivity` (oldest first), `sort=-lastActivity` (newest first), `sort=entityType`. | | `page[offset]`, `page[limit]` | Page through the result. The default page is 50 rows, up to 200. | The `meta.facets` block reports counts for the `entityType` and `status` values across the current filtered set, so an interface can show option badges without a second call. The counts reflect the active filters. ## Who can read the registry [#who-can-read-the-registry] Reading the registered identities list requires one of the following roles for the active system: Identity manager, System manager, or Claim issuer. A caller without one of these roles receives a permission error, and the same role boundary applies in the Console identity registry view, so an operator can confirm access there before calling the endpoint from an integration. ## Related pages [#related-pages] * [Compliance API route map](/docs/api-reference/compliance) * [Identity recovery API](/docs/api-reference/compliance/identity-recovery) * [Identity and compliance](/docs/compliance-security/security/identity-compliance) * [Claims and identity](/docs/architecture/concepts/claims-and-identity)