Check revocation

Checks whether a held credential has been suspended or revoked.

This is only applicable to credentials with an associated revocation mechanism.

This endpoint only works for credentials for which the role is HOLDER. Issuers and verifiers cannot check the status of credentials with this endpoint.

For list-based revocation methods, the signed lists and DID documents containing the public keys used to verify the lists are cached. Use the forceRefresh parameter to force the system to retrieve these entities from the external resource.

For mdocs and credentials issued with LVVC revocation, use the forceRefresh parameter to force the system to request a new MSO (for mdocs) or a new LVVC with the latest status.

Related guide: Caching

Function

React Native

checkRevocation(
    credentialIds: Array<CredentialListItem["id"]>,
    forceRefresh: boolean
  ): Promise<CredentialRevocationCheckResponse[]>;

iOS

func checkRevocation(credentialIds: [String], forceRefresh: Bool?) async throws  -> [CredentialRevocationCheckResponseBindingDto]

Android

fun `checkRevocation`(`credentialIds`: List<kotlin.String>, `forceRefresh`: kotlin.Boolean?): List<CredentialRevocationCheckResponseBindingDto>

Parameters

• credentialIds - Array of credential IDs for revocation check.
• forceRefresh - (Boolean) If true, forces the system to attempt to fetch status information from external resources.

Return value

React Native

export interface CredentialRevocationCheckResponse {
  credentialId: string;
  status: CredentialStateEnum;
  success: boolean;
  reason?: string;
}

iOS

public struct CredentialRevocationCheckResponseBindingDto {
    public var credentialId: String
    public var status: CredentialStateBindingEnum
    public var success: Bool
    public var reason: String?
}

Android

data class CredentialRevocationCheckResponseBindingDto (
    var `credentialId`: kotlin.String,
    var `status`: CredentialStateBindingEnum,
    var `success`: kotlin.Boolean,
    var `reason`: kotlin.String?
)

Fields

• status - See the credential states guide.

  • [CREATED, PENDING, OFFERED, ACCEPTED, SUSPENDED, REJECTED, REVOKED, ERROR]

• success - Indicates whether the system performed the check as planned. When using forceRefresh, indicates whether the external resource was reached and gave a response. For mdocs this value will only be true if a new MSO was issued.

• reason - Explanation of why the revocation check failed. Only present when success: false.