Using the /issue-credential-2.0
API endpoints, it is possible to issue Verifiable Credentials, signed by a cheqd DID, in a few clicks or lines of code. By following the following steps, you can effectively issue verifiable credentials using ACA-Py integrated with the cheqd ecosystem.
Use any supported method to create a connection with the Holder of the credential. Automated out-of-band protocol is recommended.
The Issuer agent will create a new connection invite for the Holder. This is needed to securely communicate between the Issuer and the Holder agents.
For automated acceptance, pass the following parameters:
A simple request body is below:
The above request will have an invitation
in the response. Holder will have to copy that inivitation and pass in the body of the following API call.
The request body should be the invitation
value from the /create-invitation
call by the Issuer.
Generate a credential offer using the /issue-credential-2.0/send-offer
API. This offer is sent to the holder, informing them about the available credential and its attributes.
The Holder has to retrieve the credential exchange id, and call this API to accept the offer.
Once the credential request is received and validated, issue the credential using the /issue-credential-2.0/records/<exchange-id>/issue
API endpoint.
The Holder has to store the issued credential into their wallet using the following API.
Learn about Verifiable Credentials and Presentations
If you want to learn more about what Verifiable Credentials and Presentations are, please go over to our learning site here.
Below are a list of alternatives for using Credentials with cheqd support. Each offers a different set of protocols and underlying technical capabilities.
Revoking credentials is crucial for maintaining control over issued credentials and preventing misuse in the cheqd ecosystem. To revoke credentials within the ACA-Py framework, follow these steps:
The Issuer must determine the credential that needs to be revoked by getting the list of issued credentials and the connection id.
Initiate the credential revocation process by supplying the necessary credential identifiers like the connection id and the credential exchange id.
Follow the steps to Present a Verifiable Credential to verify that the credential has been successfully revoked. The response should have verified: false
.
Setup ACA-Py Agent
Before you get started, you need to setup your ACA-Py Agent.
Issue Credentials
Issue Verifiable Credentials signed by cheqd DIDs using ACA-Py .
Present Credentials
Present Verifiable Credentials using ACA-Py.
cheqd Studio
Our API product enables users to use cheqd's functionality with minimal complexity and easily integrate APIs into existing apps.
Credo
Credo is an SDK which supports the European Architecture and Reference Framework (ARF) standards as well as AnonCreds with full cheqd support for DIDs.
Veramo
The Veramo SDK plugin supports JSON, JSON-LD credentials as well as cheqd Credential Payments in an SDK.
Walt.id SSI Kit
Walt.id SSI Kit is an SDK that supports the European Architecture and Reference Framework (ARF) standards for identity, with full cheqd support.
Using the /present-proof-2.0
API endpoints, it is possible to present Verifiable Credentials, signed by a cheqd DID, in a few clicks or lines of code. This process enables secure and trustworthy sharing of verifiable credentials within the ACA-Py framework and cheqd ecosystem.
Use any supported method to create a connection with the Holder. Automated out-of-band protocol is recommended. You can follow the same steps as described in Issue a Verifiable Credential.
After connection is established, the Verifier can send a proof request to the Holder.
The request body will depend on the credential, but here is a sample.
Holder can get the stored credentials from own wallet and format a proof to send to the Verifier.
Verifier receives the presentation via the connection, and can use the following API to verify. The response must have verified: true
.