OpenID Issuance and Verification Integration Guide
Last updated
Was this helpful?
Last updated
Was this helpful?
This guide provides detailed instructions for implementing OpenID for Verifiable Credential Issuance (OID4VCI) and OpenID for Verifiable Presentation (OID4VP) using a series of API endpoints. It outlines the steps required to set up an issuer, create credential offers, manage the issuance flow, create presentations and verify the issued credentials.
Before starting, ensure you have:
Issuer DID (did:dock:issuer
): The did for the credential issuer.
Verifier DID (did:dock:verifier
): The did for the credential verifier.
Holder DID (did:key:holder
): The DID for the credential holder (optional)
Download and use our to experiment with OpenID standards based credentials.
Create an OID4VCI issuer with the necessary configurations, including claim mappings, credential options, and authentication provider settings.
POST
/openid/issuers
This endpoint creates an OID4VCI issuer. "authProvider" and "claimMap" are supplied as part of the . It can be omitted for the .
Request/Response
GET
/openid/issuers/{issuerId}/.well-known/openid-configuration
This endpoint retrieves the OpenID configuration for the specified issuer.
Request/Response
Generate credential offers to initiate the issuance process. Credential offers can be shared with the holder to claim the credential.
POST
/openid/credential-offers
This endpoint creates a credential offer linked to the OpenID issuer.
Request/Response
This step involves creating a proof request that specifies the requirements for the verifiable presentation. The proof request defines what credentials and claims are expected from the holder.
POST
/proof-requests
This endpoint creates a new proof request that the verifier can use to request credentials from the holder.
Request/Response
This step generates a request URL that can be shared with the holder. The holder can use this URL to present the requested credentials through their wallet.
POST
/openid/vp/{proofRequestId}/request-url
This endpoint generates a request URL based on the proof request ID. The withRequestURI parameter determines whether the URL includes the request_uri.
Request/Response
This step involves checking the status of a specific proof request to see if it has been fulfilled, and to retrieve any relevant information associated with the request.
GET
/proof-requests/{proofRequestId}
This endpoint retrieves the status and details of the specified proof request, including whether the requested credentials have been presented and verified
Request/Response
Using the or any OID4VCI Wallet, scan the QR code received and follow the process to receive the credential.
Using the or any OID4VP Wallet, scan the QR code received and follow the process to verify the credential.