light-mode-image
Learn
Credential Reports

Credential reports

Learn how to generate credential reports to track issuance and status change operations across your tenant, broken down by day and credential type.

Credential reports provide a summary of credential lifecycle operations across your tenant. You can use them to track issuance volumes and status changes (such as revocations) for mDoc and CWT credentials, broken down by day and credential type.

This gives you visibility into how credentials are being managed over time, without needing to query individual events.

Use cases

Credential reports help you answer questions like:

  • How many credentials were issued this month? Track daily issuance volumes to understand adoption trends and usage patterns.
  • How many credentials have been revoked? Monitor status change operations to stay on top of credential lifecycle management.
  • What types of credentials are being issued? Break down issuance by credential type (e.g. org.iso.18013.5.1.mDL) to understand which credential profiles are most active.
  • Are issuance volumes consistent? Identify unexpected spikes or drops in activity that may indicate integration issues or changes in demand.

Report structure

Each report groups operations by several dimensions so you can analyze trends over time:

  • Operation: The type of credential lifecycle operation, such as issued or status_changed.
  • Credential profile: The credential profile, such as mdoc or cwt.
  • Credential type: The specific credential type associated with the operation, if applicable (e.g. org.iso.18013.5.1.mDL or VerifiedEmployee).
  • Date: The date the operations occurred.

Generate a credential report

Make the following API request to create a credential report for your tenant:

Request
POST /v1/events/credential-reports
Request body
{
  "timezoneOffset": "+02:00",
  "startDate": "2026-02-01",
  "endDate": "2026-02-28",
  "profiles": ["cwt", "mdoc"],
  "limit": 500,
  "cursor": "b2Zmc2V0PTM="
}
  • timezoneOffset: Timezone offset in ISO-8601 format (e.g. +02:00, -05:00). Determines how operation timestamps are grouped by date. For example, an operation at 2026-02-25T22:30:00Z would be counted towards 2026-02-26 when using +02:00, but towards 2026-02-25 when using -05:00.
  • startDate: Start date for the report (inclusive), interpreted in the specified timezone.
  • endDate: End date for the report (inclusive), interpreted in the specified timezone.
  • profiles: Credential profiles to include in the report. Accepted values: cwt, mdoc.
  • limit (optional): Maximum number of entries to return. Defaults to 1000 if omitted.
  • cursor (optional): Pagination cursor. If omitted, results start from the most recent entry.

Response

Response body
{
  "data": [
    {
      "date": "2026-02-25",
      "operation": "issued",
      "profile": "mdoc",
      "credentialType": "org.iso.18013.5.1.mDL",
      "count": 5
    },
    {
      "date": "2026-02-25",
      "operation": "status_changed",
      "profile": "cwt",
      "count": 2
    },
    {
      "date": "2026-02-26",
      "operation": "issued",
      "profile": "cwt",
      "credentialType": "VerifiedEmployee",
      "count": 12
    }
  ]
}
  • data: An array of report entries, each representing a count of operations matching the specified criteria on a given date. Each entry includes the following fields:
    • date: The date the operations occurred.
    • operation: The type of credential lifecycle operation: issued (a credential was issued) or status_changed (a credential's status was changed, e.g. revoked).
    • profile: The credential profile: mdoc or cwt.
    • credentialType: The credential type associated with the operation, if applicable.
    • count: The total number of operations matching these criteria on this date.

The data array may contain multiple entries for the same date when different operations, profiles, or credential types were involved. In the example above:

  • 5 mDoc mobile driving licences were issued on 25 February 2026.
  • 2 CWT credential status changes (e.g. revocations) occurred on the same date.
  • 12 CWT VerifiedEmployee credentials were issued on 26 February 2026.

How would you rate this page?

Last updated on

On this page