v1

latestOpenAPI 3.0.0Apache-2.02026-07-17326898.9 KB
issuer

Initiate OIDC Credential Issuance

Used by the issuer to initiate OIDCI credential issuance interaction in VCS. The response contains initiate issuance URL which can be used to initiate the flow from issuer applications.

post/issuer/profiles/{profileID}/{profileVersion}/interactions/initiate-oidc

Request body

client_initiate_issuance_urlstring

URL of the issuance initiation endpoint of a Wallet. Takes precedence over client_wellknown request parameter. If both client_initiate_issuance_url and client_wellknown are not provided then response initiate issuance URL will contain custom initiate issuance URL in format openid-initiate-issuance://.

client_wellknownstring

String containing wallet/holder application OIDC client wellknown configuration URL.

op_statestring

String value created by the Credential Issuer and opaque to the Wallet that is used to bind the sub-sequent authentication request with the Credential Issuer to a context set up during previous steps. If the client receives a value for this parameter, it MUST include it in the subsequent Authentication Request to the Credential Issuer as the op_state parameter value. MUST NOT be used in Authorization Code flow when pre-authorized_code is present.

grant_type'authorization_code' | 'urn:ietf:params:oauth:grant-type:pre-authorized_code'

Issuer can provide custom grant types through this parameter. This grant type has to be used while exchanging an access token for authorization code in later steps.

scopestring[]

Contains scopes that issuer expects VCS to use while requesting authorization code for claim data. Defaults to openid.

response_typestring

Contains response type that issuer expects VCS to use while performing OIDC authorization request. Defaults to token.

authorization_detailsstring

Customizes what kind of access Issuer wants to give to VCS.

user_pin_requiredboolean

Required for Pre-Authorized Code Flow. Boolean value specifying whether the issuer expects presentation of a user PIN along with the Token Request in a pre-authorized code flow.

wallet_initiated_issuanceboolean

Boolean flags indicates whether given transaction is initiated by Wallet.

Response

OK

offer_credential_urlstring required

OIDC4CI initiate issuance URL to be used by the Issuer to pass relevant information to the Wallet to initiate issuance flow. Supports both HTTP GET and HTTP Redirect. Issuers may present QR code containing request data for users to scan from their mobile Wallet app.

tx_idstring required

To be used by Issuer applications for correlation if needed.

user_pinstring

Pre-authorized flow. Generated OTP pin for issuance.