Skip to main content
Issuance

Read issuance history

GET/v4/config/ows/issuer/issuance-history/{credentialExchangeId}

Returns one issuance history: its status, offer, holder, the evidence of the wallet (wallet unit attestation, proof and key attestation, with their checks), the revocation, the re-issuances and the newest issued credential. Use it to follow an issuance after Issue credential, or to see why the issuer refused a wallet. Add include=claims to get the claims. The issued credentials are in List issued credentials.

Authorizations

  • Authorizationstringheaderrequired

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

    Scope:issuances:read

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.

Query parameters

  • includeenum<string>

    claims adds the claims of the issuance history to the answer, in the form of credentials[].claims of the issue call. Without it, the answer has no claims.

    Available options:claims

Response

application/json

The issuance history.

  • credentialExchangeIdstring

    The credential exchange id: the id of the issuance history.

    Example:"6b0f3d2a-2c1e-4f7a-9b3d-1e5c7a9d0f42"

  • credentialDefinitionobject

    The credential definition of the issuance history and the version of the definition that governs it.

  • credentialConfigurationIdstring | null

    The credentialConfigurationId of the credential configuration, as in the Credential Issuer Metadata.

    Example:"eu.europa.ec.eudi.pid.1"

  • formatstring | null

    Format of the credential: dc+sd-jwt, mso_mdoc or jwt_vc_json.

    Example:"dc+sd-jwt"

  • modeenum<string>

    When the wallet gets the credential. in_time: at once, from the Credential Endpoint; the issue call has the claims. deferred: when you give the claims. Until then the wallet gets a transaction_id and asks again at the Deferred Credential Endpoint; claims that you gave before its credential request give the credential at once.

    Available options:in_time,deferred

    Example:"in_time"

  • statusenum<string>

    The step that the issuance of the issuance history reached. Each status other than offer_sent has the name of the issuer event that sets it (ows.issuer.issuance_history.<status>). The event ows.issuer.issuance_history.created sets the status offer_sent. offer_sent: the issuer made the issuance history and its credential offer (also the start of a wallet-initiated issuance, where the issuer sent no offer, and of an offer reuse). offer_retrieved: the wallet fetched the credential offer. token_issued: the token endpoint gave the wallet an access token. credential_deferred: the wallet asked for the credential of a deferred issuance history before you gave the claims. claims_supplied: you gave the claims of a deferred issuance history. credential_issued: the issuer signed the credential and gave it to the wallet. credential_accepted: the wallet sent the notification credential_accepted. credential_deleted: the wallet sent the notification credential_deleted. denied: the issuer refused the issuance (deniedReason tells why). expired: the current grant ended before the issuance history gave a credential (the pre-authorised code or the issuer state before a token, the access token and the refresh token after a token). A revocation is not a status: see revokedAt.

    Available options:offer_sent,offer_retrieved,token_issued,credential_deferred,claims_supplied,credential_issued,credential_accepted,credential_deleted,denied,expired

    Example:"credential_accepted"

  • deniedReasonstring | null

    Why the issuer refused the issuance, when the status is denied. Else null.

  • offerobject

    The credential offer of the issuance history. The issuance histories of one issue call have the same offer.

  • individualIdstring | null

    The individualId of the issue call, or null.

  • dataAgreementIdstring | null

    The dataAgreementId of the issue call, or null.

  • presentationobject | null

    The presentation that the holder gave for a dynamic credential request, or null.

  • authorisationobject

    The evidence of the wallet and of its holder key: the wallet unit attestation, the proof of possession and the key attestation, each with its checks.

  • revocationobject

    The revocation settings of the credential configuration, and the revocation of the issuance history.

  • reissueobject

    The re-issuances of the credential.

  • latestCredentialobject | null

    The newest issued credential (its version), or null before the first credential.

  • createdAtstring<date-time>

    When the issuer made the issuance history (RFC 3339, UTC).

  • updatedAtstring<date-time>

    When the issuance history last changed (RFC 3339, UTC).

  • issuedAtstring<date-time> | null

    When the issuer signed the first credential (RFC 3339, UTC), or null.

  • claimsobject

    The claims of the issuance history, in the form of credentials[].claims of the issue call. Only with include=claims.