Skip to main content
GET
List the individuals your organization has verified

Authorizations

X-API-Key
string
header
required

Query Parameters

limit
integer
default:10

Maximum number of records to return in a single page. Must be between 1 and 1000.

Required range: 1 <= x <= 1000
offset
integer | null

Number of records to skip from the beginning. Use 0 for the first page. Cannot be used with cursor.

Required range: x >= 0
cursor
string | null

Opaque pagination cursor token that identifies the position in the result set. Use the cursor from the previous response to get the next page. Cannot be used with offset.

sort
enum<string> | null

last_activity, name (given then family name, ignoring case) or verified_at; ties break on when the snapshot was recorded, then its id. Defaults to last_activity desc. What the people list sorts by.

Available options:
last_activity,
name,
verified_at
sort_direction
enum<string> | null

asc or desc, for every key of the sort. Defaults to the field's own: last_activity desc, name asc, verified_at desc.

Available options:
asc,
desc
verification_state
enum<string> | null

Only identities in this derived state: CURRENT or EXPIRED. SUPERSEDED never matches: the list carries one row per person — their current verification — and superseded snapshots are lineage, not population. Verification state of an identity, as seen by the referencing organization.

CURRENT: an unexpired verification exists and credentials can be minted. EXPIRED: the verification's validity window has lapsed — re-verify before minting. SUPERSEDED: no active verification record remains; a new submission is required.

Available options:
CURRENT,
EXPIRED,
SUPERSEDED
link
enum<string> | null

linked (a verified link to a business), link_request (a link awaiting your review) or none (no business, or only rejected links). Your organization's own links only. The people list's business segments, read off the organization's own operator links.

Available options:
linked,
link_request,
none
verified_after
string<date-time> | null

Only people whose current verification was recorded at or after this instant. Must carry a UTC offset.

verified_before
string<date-time> | null

Only people whose current verification was recorded before this instant (exclusive). Must carry a UTC offset.

search
string | null

A prn_ reference, or free text matched against name, email and phone. Every whitespace-separated term must match.

Maximum string length: 200

Response

Paginated identities in the requested order, scoped to the calling organization.

individual_ref
string
required

This organization's pairwise reference to the individual.

display_name
string
required

The verified name, as the latest snapshot recorded it. Mask it in shared surfaces; the API returns what the organization itself submitted.

verification_state
enum<string>
required

CURRENT, or EXPIRED (re-verify before minting). Derived from the snapshot's validity window, never stored.

Available options:
CURRENT,
EXPIRED,
SUPERSEDED
linked_business_count
integer
required

Businesses this organization covers a live operator link to for the individual; rejected links are not counted.

last_activity_at
string<date-time>
required

The latest of: verified or re-verified, a link confirmed or decided, an agent credential issued or revoked. Your organization's own activity only.

credentials_minted_30d
integer
required

Credentials this organization minted for the individual in the last 30 days, counting business credentials it acted for.

verified_at
string<date-time>
required

When the latest verification was recorded.

expires_at
string<date-time>
required

When the latest verification expires.

verification_level
integer | null

Verification level derived from active_keys; null when the attested attributes are insufficient for any defined level.

active_keys
string[]

Names of the individual verification checks the identity currently holds (e.g. phone_possession, ssn_identity_match), from the token-exchange profile's key vocabulary; verification_level is derived from them. A re-verification keeps an earlier phone_possession it cannot re-run.

businesses
IdentityListBusinessResponse (v1) · object[]

Up to three of the businesses counted by linked_business_count: verified links first, then link requests, each oldest first.