Skip to main content
Version: v0.14.1

CredentialsDto

idstringrequired

Unique identifier of the credential record

Example: b86483f3-3792-4a54-b11e-f1c6face9935
targetDidstringrequired

Target decentralized identifier

Example: did:example:456
credential object

The verifiable credential object

@contextstring[]required

Possible values: [https://www.w3.org/ns/credentials/v2, string]

Example: ["https://www.w3.org/ns/credentials/v2"]
typestring[]required
Example: ["VerifiableCredential","TestCredential"]
idstring
Example: http://example.edu/credentials/1872
credentialSubject objectrequired
idstringrequired
Example: did:example:subject-1
property name*any
Example: {"id":"did:example:subject-1","customProp":"value"}
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 [
    • idstring
    Example: did:example:xyz#proof-1
    typestringrequired

    Possible values: [DataIntegrityProof]

    Example: DataIntegrityProof
    proofPurposestringrequired
    Example: assertionMethod
    verificationMethodstring
    Example: did:example:author#verificationKey
    cryptosuitestringrequired
    Example: ecdsa-2019
    createdstring
    Example: 2021-01-01T00:00:00Z
    expiresstring
    Example: 2022-01-01T00:00:00Z
    domainstring[]
    Example: ["example.com"]
    challengestring
    Example: 1234567890
    proofValuestringrequired
    Example: ProofValueString
    previousProofstring[]
    Example: ["PreviousProof1","PreviousProof2"]
    noncestring
    Example: nonce-string
  • ]
    • jwtstring

    JWT representation of the credential

    Example: jwt-token-123
    selfIssuedbooleanrequired

    If the credential is self issued

    Example: true
    revokedbooleanrequired

    Indicates if the credential has been revoked

    Example: false
    statusListIndexnumber

    Optional status list index

    Example: 0
    createdDatestring<date-time>required

    Creation timestamp

    Example: 2023-10-01T00:00:00Z
    modifiedDatestring<date-time>required

    Modification timestamp

    Example: 2023-10-02T00:00:00Z
    deletedDatestring<date-time>

    Optional deletion timestamp

    Example: 2023-10-03T00:00:00Z
    CredentialsDto
    {
      "id": "b86483f3-3792-4a54-b11e-f1c6face9935",
      "targetDid": "did:example:456",
      "credential": {
        "@context": [
          "https://www.w3.org/ns/credentials/v2"
        ],
        "type": [
          "VerifiableCredential",
          "DataSpaceCredential"
        ],
        "issuer": "did:example:issuer",
        "validFrom": "2023-10-01T00:00:00Z",
        "credentialSubject": {
          "id": "did:example:subject"
        }
      },
      "proof": [
        {
          "type": "DataIntegrityProof",
          "created": "2020-01-01T00:00:00Z",
          "proofPurpose": "assertionMethod",
          "cryptosuite": "eddsa-rdfc-2022",
          "proofValue": "...",
          "verificationMethod": "did:example:123456#key-1"
        }
      ],
      "jwt": "jwt-token-123",
      "selfIssued": true,
      "revoked": false,
      "statusListIndex": 0,
      "createdDate": "2023-10-01T00:00:00Z",
      "modifiedDate": "2023-10-02T00:00:00Z",
      "deletedDate": "2023-10-03T00:00:00Z"
    }