Look up a verified identity by pairwise reference

Returns the verification state, verified-attribute keys, verification level, and covered business links for a principal_ref issued to your organization. References issued to other organizations and unknown references are indistinguishable 404s.

get/identities/{principal_ref}

Path parameters

principal_refstring required

Response

principal_refstring required

The queried pairwise principal reference.

verification_state'CURRENT' | 'EXPIRED' | 'SUPERSEDED' required

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.

verified_atstring date-time nullable

When the latest verification was recorded.

expires_atstring date-time nullable

When the latest verification expires.

active_keysstring[]

Dotted keys of the identity attributes the latest verification can attest to (e.g. user.email.hash) — the same vocabulary credential disclosure paths use.

verification_levelinteger nullable

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

Changes

No recorded changes to this endpoint across all 1 revision of this API.