Skip to main content
Version: v0.13.0

ComplianceRequest

vcIdstringrequired

Unique identifier for the VC

Example: vc-456
clearingHousestringrequired

Clearing house identifier

Example: clearing-house-02
credentials object[]required

An array of verifiable credentials

  • Array [
    • @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
    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
  • ]
  • ]
    • notestring

    Additional optional note

    Example: Optional compliance note
    ComplianceRequest
    {
      "vcId": "vc-456",
      "clearingHouse": "clearing-house-02",
      "credentials": [
        {
          "credential": "example-credential-1",
          "issuer": "issuer-1"
        },
        {
          "credential": "example-credential-2",
          "issuer": "issuer-2"
        }
      ],
      "note": "Optional compliance note"
    }