Skip to main content
Version: v0.10.0

VerifiableCredential

@contextstring[]required

Possible values: [https://www.w3.org/2018/credentials/v1, https://www.w3.org/ns/credentials/v2, https://w3id.org/security/suites/jws-2020/v1, https://w3id.org/security/data-integrity/v2, string]

Example: ["https://www.w3.org/2018/credentials/v1"]
typestring[]required
Example: ["VerifiableCredential","TestCredential"]
idstring
Example: http://example.edu/credentials/1872
credentialSubject objectrequired
idstringrequired
Example: did:example:subject-1
issuerstringrequired
Example: did:example:issuer
issuanceDatestring
Example: 2020-01-01T00:00:00Z
expirationDatestring
Example: 2030-01-01T00:00:00Z
validFromstring
Example: 2020-01-01T00:00:00Z
validUntilstring
Example: 2030-01-01T00:00:00Z
evidence object
property name*any
Example: {"type":"DocumentVerification","verifier":"did:example:verifier"}
credentialStatus object
oneOf
idstringrequired
Example: did:example:credential-status
typestringrequired

Possible values: [BitstringStatusListEntry]

Example: BitstringStatusListEntry
statusPurposestringrequired

Possible values: [refresh, revocation, suspension, message]

Example: suspension
statusListIndexstringrequired
Example: 0
statusListCredentialstringrequired
Example: did:example:status-credential
statusSizestring
Example: 10
statusMessage object[]
  • Array [
    • statusstringrequired
    Example: deadbeef
    messagestringrequired
    Example: Status message detail
  • ]
    • statusReferencestring
    Example: https://example.com/status
    proof object[]required
  • Array [
    • typestringrequired

    Possible values: [JsonWebSignature2020, DataIntegrityProof]

    Example: JsonWebSignature2020
    proofPurposestringrequired
    Example: assertionMethod
  • ]
    • VerifiableCredential
    {
      "@context": [
        "https://www.w3.org/2018/credentials/v1"
      ],
      "type": [
        "VerifiableCredential",
        "TestCredential"
      ],
      "id": "http://example.edu/credentials/1872",
      "credentialSubject": {
        "id": "did:example:subject-1",
        "customProp": "value"
      },
      "issuer": "did:example:issuer",
      "issuanceDate": "2020-01-01T00:00:00Z",
      "expirationDate": "2030-01-01T00:00:00Z",
      "validFrom": "2020-01-01T00:00:00Z",
      "validUntil": "2030-01-01T00:00:00Z",
      "evidence": {
        "type": "DocumentVerification",
        "verifier": "did:example:verifier"
      },
      "credentialStatus": {
        "id": "did:example:credential-status",
        "type": "BitstringStatusListEntry",
        "statusPurpose": "suspension",
        "statusListIndex": "0",
        "statusListCredential": "did:example:status-credential",
        "statusSize": "10",
        "statusMessage": [
          {
            "status": "deadbeef",
            "message": "Status message detail"
          }
        ],
        "statusReference": "https://example.com/status"
      },
      "proof": [
        {
          "type": "JsonWebSignature2020",
          "created": "2020-01-01T00:00:00Z",
          "proofPurpose": "assertionMethod",
          "jws": "eyJhbGciOiJFUzI1NiIsInR5cCI...",
          "verificationMethod": "did:example:123456#key-1"
        }
      ]
    }