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

Authorizations

X-API-Key
string
header
required

Query Parameters

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

Every event matching the filters, as CSV.