Issuer - OpenAPI

This is the W3C VC compatible OpenAPI, describing the endpoints to issue Verifiable Credentials. The W3C API endpoints in VDX, allow you to create an implementation compatible with the W3C VC API specification, meaning there is no vendor lock-in. VDX also has VDX specific APIs to issue and verify credentials, which are more powerful. They are however not VC API compatible.

Some examples supported by VDX, but not by the W3C VC API are:

• Using templates to issue credentials
• Binding templates to users and groups, allowing departments to issue different credentials
• Using events/callbacks when issuing

Please note that if you are reading this line, it means the final documentation is not ready yet. Release of the full documentation is scheduled for the end of Q3 of 2023.

OpenAPI spec

• credentialsIssue
  • postIssues a credential and returns it in the response body.
  • getGets a credential or verifiable credential by ID
• credentialsStatus
  • postUpdates the status of an issued credential

Documentation Powered by Redocly

VC Issuer HTTP API (0.0.3-unstable)

Download OpenAPI specification:Download

URL: https://github.com/w3c-ccg/vc-api License: W3C Software and Document License

This is an Experimental Open API Specification for the VC Data Model.

credentialsIssue

Issues a credential and returns it in the response body.

Issues a credential and returns it in the response body.

Request Body schema: application/json

Parameters for issuing the credential.

	object (Credential) A JSON-LD Verifiable Credential without a proof.
	object (IssueCredentialOptions) Options for specifying how the LinkedDataProof is created.

Responses

https://docs.vdx.sphereon.com/credentials/issue

Request samples

• Payload

Content type

application/json

{

• "credential": {

  • "@context": [

    • "https://www.w3.org/2018/credentials/v1",
    • "https://www.w3.org/2018/credentials/examples/v1"

    ],
  • "id": "http://example.gov/credentials/3732",
  • "type": [

    • "VerifiableCredential",
    • "UniversityDegreeCredential"

    ],
  • "issuer": "did:example:123",
  • "issuanceDate": "2020-03-16T22:37:26.544Z",
  • "credentialSubject": {

    • "id": "did:example:123",
    • "degree": {

      • "type": "BachelorDegree",
      • "name": "Bachelor of Science and Arts"

      }

    }

  },
• "options": {

  • "created": "2020-04-02T18:48:36Z",
  • "credentialStatus": {

    • "type": "RevocationList2020Status"

    }

  }

}

Response samples

• 201

Content type

application/json

{

• "@context": [

  • "https://www.w3.org/2018/credentials/v1",
  • "https://www.w3.org/2018/credentials/examples/v1"

  ],
• "id": "http://example.gov/credentials/3732",
• "type": [

  • "VerifiableCredential",
  • "UniversityDegreeCredential"

  ],
• "issuer": "did:example:123",
• "issuanceDate": "2020-03-16T22:37:26.544Z",
• "credentialSubject": {

  • "id": "did:example:123",
  • "degree": {

    • "type": "BachelorDegree",
    • "name": "Bachelor of Science and Arts"

    }

  },
• "proof": {

  • "type": "Ed25519Signature2018",
  • "created": "2020-04-02T18:28:08Z",
  • "verificationMethod": "did:example:123#z6MksHh7qHWvybLg5QTPPdG2DgEjjduBDArV9EF9mRiRzMBN",
  • "proofPurpose": "assertionMethod",
  • "jws": "eyJhbGciOiJFZERTQSIsImI2NCI6ZmFsc2UsImNyaXQiOlsiYjY0Il19..YtqjEYnFENT7fNW-COD0HAACxeuQxPKAmp4nIl8jYAu__6IH2FpSxv81w-l5PvE1og50tS9tH8WyXMlXyo45CA"

  }

}

Gets a credential or verifiable credential by ID

path Parameters

required

string or string or string or string Example: f37e5114-8b4a-11ec-b32e-fbd62b9502c1,z4Z1T4HdLdfXCFAhdhzdCqm,u7m8_ybOArX-EWeADqWCsIw,507f191e810c19729de860ea,4e59775105ee7a42696a6420e39eb3cf2512a04abf88e16696451cab59e25cdc1b0f0aa512f55dc009d38951b9c49e673e3f9f7669821f77733599b7fd72b15f

Responses

https://docs.vdx.sphereon.com/credentials/{id}

Response samples

• 200

Content type

application/json

{

• "@context": [

  • "https://www.w3.org/2018/credentials/v1",
  • "https://www.w3.org/2018/credentials/examples/v1"

  ],
• "id": "http://example.gov/credentials/3732",
• "type": [

  • "VerifiableCredential",
  • "UniversityDegreeCredential"

  ],
• "issuer": "did:example:123",
• "issuanceDate": "2020-03-16T22:37:26.544Z",
• "credentialSubject": {

  • "id": "did:example:123",
  • "degree": {

    • "type": "BachelorDegree",
    • "name": "Bachelor of Science and Arts"

    }

  },
• "proof": {

  • "type": "Ed25519Signature2018",
  • "created": "2020-04-02T18:28:08Z",
  • "verificationMethod": "did:example:123#z6MksHh7qHWvybLg5QTPPdG2DgEjjduBDArV9EF9mRiRzMBN",
  • "proofPurpose": "assertionMethod",
  • "jws": "eyJhbGciOiJFZERTQSIsImI2NCI6ZmFsc2UsImNyaXQiOlsiYjY0Il19..YtqjEYnFENT7fNW-COD0HAACxeuQxPKAmp4nIl8jYAu__6IH2FpSxv81w-l5PvE1og50tS9tH8WyXMlXyo45CA"

  }

}

credentialsStatus

Updates the status of an issued credential

Updates the status of an issued credential.

Request Body schema: application/json

Parameters for updating the status of the issued credential.

credentialId	string
	Array of objects

Responses

https://docs.vdx.sphereon.com/credentials/status

Request samples

• Payload

Content type

application/json

{

• "credentialId": "urn:uuid:45a44711-e457-4fa8-9b89-69fe0287c86a",
• "credentialStatus": [

  • {

    • "type": "RevocationList2020Status",
    • "status": "0"

    }

  ]

}