Skip to main content
GET
List your organization's credential events

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

occurred_at: when the credential was issued or revoked; ties break on the credential's created_at, then its id, then the event (ISSUED before REVOKED ascending). Defaults to occurred_at desc. What a credential event list sorts by.

Available options:
occurred_at
sort_direction
enum<string> | null

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

Available options:
asc,
desc
level
enum<string>[] | null

Only credentials of these levels; repeat for more than one. Default all.

The credential layer a subject mint request selects (KYA).

Deliberately narrower than IssuedCredentialType: the individual and business mint routes issue only the two subject layers. Counterparty credentials have their own route and request shape, so a level of COUNTERPARTY must stay an edge-level payload refusal — this enum is what keeps issuance-record vocabulary growth from widening the mint requests.

Available options:
L2,
L3
state
enum<string> | null

Only events of credentials in this state now. A credential's effective state as an issuance-log reader sees it.

Derived, never stored: IssuedCredentialStatus deliberately keeps expiry out of the persisted status (verifiers check exp), but the console and API consumers filter the log by what a credential is right now — still presentable, aged out, or killed.

Available options:
ACTIVE,
EXPIRED,
REVOKED
individual_ref
string | null

Only credentials minted for this individual or by them for a business.

Required string length: 1 - 255
business_ref
string | null

Only credentials minted for this business.

Required string length: 1 - 255
search
string | null

Every word must match the person's or business's name as the credential minted it, the audience or the credential id; a individual_ref or business_ref your organization holds matches exactly.

Maximum string length: 255
event_type
enum<string>[] | null

Only these events; repeat for several.

What happened to a credential, as one row of its event stream.

Available options:
ISSUED,
REVOKED
start_date
string<date> | null

Filter records created on or after this date (format: YYYY-MM-DD).

end_date
string<date> | null

Filter records created on or before this date (format: YYYY-MM-DD).

tz
string
default:UTC

IANA timezone identifier used to interpret start_date and end_date (defaults to UTC).

Examples:

"UTC"

"America/Los_Angeles"

"Europe/London"

Response

Credential events in the requested order.

event_type
enum<string>
required

What happened to a credential, as one row of its event stream.

Available options:
ISSUED,
REVOKED
occurred_at
string<date-time>
required
credential_id
string
required

The credential's unique id: its token's jti.

environment
enum<string>
required

The environment the credential was minted in.

Available options:
sandbox,
production
level
enum<string>
required

The credential layer a subject mint request selects (KYA).

Deliberately narrower than IssuedCredentialType: the individual and business mint routes issue only the two subject layers. Counterparty credentials have their own route and request shape, so a level of COUNTERPARTY must stay an edge-level payload refusal — this enum is what keeps issuance-record vocabulary growth from widening the mint requests.

Available options:
L2,
L3
preset
enum<string> | null
required

The preset the mint named; null when it listed its own paths.

Available options:
consumer_ecommerce,
age_gated,
consumer_regulated,
b2b_ecommerce,
b2b_regulated
individual_display_name
string | null
required
individual_ref
string | null
required
business_ref
string | null
required
issued_to
string | null
required

The Issued to column: the person's name, or the business's when no person acts for it.

audience
string
required
state
enum<string>
required

The credential's state now, not at the event.

Available options:
ACTIVE,
EXPIRED,
REVOKED
actor
ActedBy (v1) · object | null
required

Who minted (issued) or revoked (revoked), as they were then.

revocation_reason
enum<string> | null
required

Why it was revoked; null on issued rows.

Available options:
agent_key_compromise,
identity_superseded,
identity_withdrawn,
operator_link_revoked,
fraud_suspected,
administrative_action
source_environment
enum<string> | null

On a test credential for a person or business verified in another environment, that environment; the credential itself is signed in environment. Null otherwise.

Available options:
sandbox,
production