Sign in
Credentials

Creates a new status list

Creates a new status list credential that can be used to track the status of verifiable credentials. The status list is returned as a verifiable credential that can be publicly accessible for verification purposes.

post/status-lists

Request body

statusPurposestring required

The purpose of the status list (e.g., "revocation", "suspension"). This determines what type of status information the list will track.

idstring uri

Optional identifier for the status list. If not provided, the service will generate one.

optionsobject

Optional parameters for creating the status list, such as size or other configuration options specific to the status list mechanism being used.

Example request

{
  "statusPurpose": "revocation",
  "id": "https://issuer.example.com/credentials/status/lists/abc123"
}

Response

Status list successfully created

verifiableCredentialVerifiableCredential — unresolved $ref
idstring uri

The identifier of the created status list credential, which can be used to retrieve it via the GET endpoint.

Example response

{
  "id": "https://issuer.example.com/credentials/status/lists/abc123",
  "verifiableCredential": {
    "@context": [
      "https://www.w3.org/ns/credentials/v2"
    ],
    "id": "https://issuer.example.com/credentials/status/lists/abc123",
    "type": [
      "VerifiableCredential",
      "BitstringStatusListCredential"
    ],
    "issuer": "did:example:issuer",
    "validFrom": "2024-01-01T00:00:00Z",
    "credentialSubject": {
      "id": "https://issuer.example.com/credentials/status/lists/abc123#list",
      "type": "BitstringStatusList",
      "statusPurpose": "revocation",
      "encodedList": "H4sIAAAAAAAAA-3BMQEAAADCoPVPbQwfoAAAAACAP2A1AQAAZQAAAIA..."
    },
    "proof": {
      "type": "DataIntegrityProof",
      "cryptosuite": "eddsa-rdfc-2022",
      "verificationMethod": "did:example:issuer#key-1",
      "created": "2024-01-01T00:00:00Z",
      "proofPurpose": "assertionMethod",
      "proofValue": "z..."
    }
  }
}

Changes

Changed in 1 of the 67 revisions of this API.1