Enabling status information

Local status providers

The IBM® Verify Identity Access Digital Credentials internally hosts two status registries for use in both DIDComm and OpenID4VC credential exchange protocols.

Table 1. Local Status Registries
Status Registry Id	Status List Standard Implemented	Supported Credential Formats	Supported Status Purposes
79d219ee-6da8-45b1-9920-01bb901486c8	W3C Bitstring Status List	JSON-LD	Revocation, suspension
86a7c919-bb0c-4e77-92b1-a3bd33a69131	OAuth Token Status List	SD-JWT	Revocation, suspension

To enable status information for credentials, add the credential_status_provider field to the request body when creating the credential definition. This field specifies the status registry that is used to manage the statuses of issued credentials and defines which status purposes to enable. For example usage, see the issuer initialization pages.

In addition, a prerequisite for using local status registries is that the local status registry ID must be included in the issuer profile’s enabled_local_status_registry_ids property. You can configure this property through the Agents API.

Note: Enabling the status information is not supported for Indy, Mdoc, and BBS+ formatted credentials.

Remote status providers

To use a remote status registry, the registry must implement the CSLM API Contract. In addition, you must create the remote status registry by using the /v1.0/diagency/trust/remote_providers/credstatus POST API request. For example:

curl --location "https://${service_url}/v1.0/diagency/trust/remote_providers/credstatus" \
  --header "Content-Type: application/json" \
  --header "Authorization: Bearer ${issuer1_verifiable_credentials_access_token}" \
  --data '{
    "name": "Remote Status Provider Name",
    "supported_status_purposes": ["revocation", "suspension"],
    "status_format": "W3CBitstringV1_0",
    "connection": {
      "base_url": "https://base/path/to/remote/registry",
      "auth": {
        "clientCreds": {
          "op_base_url": "https://path/to/op",
          "client_id": "clientId",
          "client_secret": "secret"
        }
      }
    }
  }'

To verify that the remote status registry is reachable, use the /v1.0/diagency/trust/remote_providers/credstatus/{id}/connectionTest endpoint. This endpoint invokes the remote registry’s connectionTest endpoint, which is required under the CSLM API Contract.

For more information on the remote status provider API, see API Specification.

To use the remote status registry in a credential definition, set the credential_status_provider field to the ID of the created remote status registry resource.