Verify credentials
Just like it says on the tin, verifiable credentials are verifiable by design. They contain all the proof needed to enable the owner to answer verification requests directly, without third parties.
Once issued the holder of a credential can accept incoming proof requests to present information to a verifying party. In the same way that you would show a loyalty card to prove you are part of a loyalty program in the physical world, verifiable credentials can be used to prove information in a digital interaction.
This guide contains everything you need to know about verifying credentials with Paradym. It will show you how to to:
- Set up a trusted entity.
- Create a presentation template
- Use a presentation template to verify a credential
- View your ongoing verifications and their status
Let’s get started! 🚀
Set up a trusted entity
Create a trusted entity following the trusted entities docs.
Create a presentation template
Create a presentation template following the presentation template docs.
Use a presentation template to verify a credential
The Paradym API currently supports issuing SD-JWT credentials and verifying SD-JWT and mDOC credentials over OpenID4VC, as well as issuance and verification of Anoncreds credentials over DIDComm. Read more about the different standards and protocols.
Based on the credential format you selected in the presentation template, you should either request a presentation over DIDComm or OpenID4VC:
- SD-JWT VC (
sd-jwt-vc) and mDOC (mdoc) with OpenID4VC Verification . - Anoncreds (
anoncreds) with DIDComm Verification .
OpenID4VC API
To verify an sd-jwt-vc and/or mDOC credential using OpenID4VCI based on the created template, we will make a POST request to https://api.paradym.id/v1/projects/{projectId}/openid4vc/verification/request. For detailed information on the endpoint, refer to create OpenID4VC verification request in the API reference.
In the payload below we create a verification request, based on the presentation template we created earlier. Make sure to update the presentationTemplateId to the ID of the presentation template.
You can optionally provide the requireResponseEncryption parameter to ensure the response from the wallet to Paradym will be encrypted (more details in the API reference). We recommend enabling response encryption.
{
"presentationTemplateId": "clu129ps200043eghxvhz22m1",
"requireResponseEncryption": true
}The payload that is returned will look as follows:
{
"id": "clu6p64z80001c7xudvp2uvts",
"authorizationRequestUri": "https://paradym.id/invitation?request_uri=https%3A%2F%2Fparadym.id%2Foid4vp%2Fa744eefb-f7e6-444d-8a38-24c0136e893e%2Fauthorization-requests%2F215d6f1a-14fd-47bc-86c8-2b707124718d",
"status": "requested",
"presentationTemplateId": "clu129ps200043eghxvhz22m1",
"credentials": [],
"createdAt": "2023-01-03T00:00:00.000Z",
"updatedAt": "2023-01-03T00:00:00.000Z",
"error": null
}View your verification requests
OpenID4VC API
You can retrieve your created OpenID4VC verification request by making a GET request to https://api.paradym.id/v1/projects/{projectId}/openid4vc/verification/{openId4VcVerificationId} using the id value from the result to the create verification request endpoint. For detailed information on the endpoint, refer to retrieve OpenID4VC verification session in the API reference.
That’s it! 🚀
That concludes this guide. You now know how to:
- Create a presentation template
- Use a presentation template to verify a credential
- View your ongoing verifications and their status
If you have any suggestions, remarks or questions, join the Paradym Community and let us know. Happy building!