Skip to main content
Issuance

Revoke issuance history

POST/v4/config/ows/issuer/issuance-history/{credentialExchangeId}/revocation

Revokes every credential that the issuer gave for the issuance history: each version and each copy of a batch. Use it when the holder must no longer use the credential, for example when the facts in it are no longer true. A revocation is final: a revoked credential never becomes valid again. The answer and the issuance history show the revocation at once; the published status lists show it within 60 seconds, and the issuer sends the issuer event ows.issuer.issuance_history.revoked. A second call changes nothing and gives the same answer. The credential configuration must have revocation.enabled: true. The revocation is for this issuance history only, not for the other issuance histories of the same credential offer. An issuance history without an issued credential has nothing to revoke: delete it to stop its offer.

Authorizations

  • Authorizationstringheaderrequired

    Your API key with the prefix ApiKey: ApiKey <your-api-key>. Get an API key.

    Scope:issuances:revoke

Path parameters

  • credentialExchangeIdstringrequired

    The credential exchange id of the issuance history, from issuanceHistory[].credentialExchangeId of Issue credential, from List issuance history, or from an issuer event.

Body

application/json

Optional. No body is the same as {}.

  • reasonstring

    Why you revoke the credentials: 1 to 500 characters, without the spaces at the start and the end. The issuance history, the issuer event ows.issuer.issuance_history.revoked and the audit log keep it. A second call does not change it.

    1 to 500 characters.

    Example:"The employee left the organisation"

Response

application/json

The revocation, with the revoked credentials.

  • revokedAtstring<date-time>

    When the issuer revoked the credentials (RFC 3339, UTC). The published status lists show it within 60 seconds.

    Example:"2026-11-05T12:00:00Z"

  • reasonstring | null

    The reason of the request, or null. A second call keeps the reason of the first call.

    Example:"The employee left the organisation"

  • credentialsobject[]

    The 10 newest revoked credentials (highest version first). List issued credentials has all of them.

    At most 10 items.

  • credentialCountinteger

    How many credentials the revocation revoked (each version and each copy of a batch).

    Example:3