G2P OpenID VCI: Rest API

Module name

g2p_openid_vci_rest_api

Module title

G2P OpenID VCI: Rest API

Technology base

Odoo

Functionality

This module exposes the following OpenID for VCI REST APIs.

The endpoints and their descriptions are given below.

EndpointDescription

/api/v1/vci/credential

The main credential request API.

  1. Gets the issuer based on scope, credential type, and supported format.

  2. Verifies and validates auth JWT based on issuer config.

  3. Retrieves registrant data based on issuer config and auth JWT sub.

  4. Issues the credential based on credential format.

/api/v1/vci/.well-known/openid-credential-issuer

Issuer metadata API.

  • collates the issuer_metadata of all issuers and return

/api/v1/vci/.well-known/openid-credential-issuer/{SafetyNetIssuer}

Specific Issuer metadata API.

  • Gets individual metadata of each issuer by suffixing the API with Issuer Name.

/api/v1/vci/.well-known/contexts.json

All the contexts from all the Issuers are collated and returned on this API. This path will be included in as context path within the VC.

Source code

https://github.com/openg2p/openg2p-vci

Last updated

Logo

Copyright © 2024 OpenG2P. This work is licensed under Creative Commons Attribution International LicenseCC-BY-4.0 unless otherwise noted.