Skip to main content
European CommissionEBSI European Blockchain
Get Help
Select the Environment you want to work withEnvironment:

Credential Offer by reference

Last updated on 
GET 
/conformance/v3/issuer-mock/offers/:credentialOfferId

Issuer Mock endpoint that returns a Credential Offer. credential_offer_uri SHOULD be used whenever the credential_offer object is large.

Request​

Path Parameters
    credentialOfferId stringrequired

    Unique Credential Offer ID

    Examples:

    Credential Offer ID

    Example: 2160d1e4-2243-48cc-ae90-169e3d206502

Responses​

OK

Schema
    credential_issuer URIrequired

    The URL of the Credential Issuer, the Wallet is requested to obtain one or more Credentials from.

    credentials arrayrequired

    A JSON array, where every entry is a JSON object or a JSON string. If the entry is an object, the object contains the data related to a certain credential type the Wallet MAY request. Each object MUST contain a 

    format
    Claim determining the format of the credential to be requested and further parameters characterising the type of the credential to be requested. If the entry is a string, the string value MUST be one of the id values in one of the objects in the credentials_supported Credential Issuer metadata parameter. When processing, the Wallet MUST resolve this string value to the respective object.

    grants object

    A JSON object indicating to the Wallet the Grant Types the Credential Issuer's AS is prepared to process for this credential offer. Every grant is represented by a key and an object. The key value is the Grant Type identifier, the object MAY contain parameters either determining the way the Wallet MUST use the particular grant and/or parameters the Wallet MUST send with the respective request(s). If grants is not present or empty, the Wallet MUST determine the Grant Types the Credential Issuer's AS supports using the respective metadata. When multiple grants are present, it's at the Wallet's discretion which one to use.

    authorization_code object

    Grant Type authorization_code

    issuer_state string

    String value created by the Credential Issuer and opaque to the Wallet that is used to bind the subsequent Authorization Request with the Credential Issuer to a context set up during previous steps. If the Wallet decides to use the Authorisation Code Flow and received a value for this parameter, it MUST include it in the subsequent Authorization Request to the Credential Issuer as the 

    issuer_state
    parameter value.

    urn:ietf:params:oauth:grant-type:pre-authorized_code object

    Grant Type urn:ietf:params:oauth:grant-type:pre-authorized_code

    pre-authorized_code stringrequired

    The code representing the Credential Issuer's authorization for the Wallet to obtain Credentials of a certain type. This code MUST be short lived and single-use. If the Wallet decides to use the Pre-Authorized Code Flow, this parameter value MUST be include in the subsequent Token Request with the Pre-Authorized Code Flow.

    user_pin_required boolean

    Boolean value specifying whether the Credential Issuer expects presentation of a user PIN along with the Token Request in a Pre-Authorized Code Flow. Default is false. This PIN is intended to bind the Pre-Authorized Code to a certain transaction in order to prevent replay of this code by an attacker that, for example, scanned the QR code while standing behind the legit user. It is RECOMMENDED to send a PIN via a separate channel. If the Wallet decides to use the Pre-Authorized Code Flow, a PIN value MUST be sent in the 

    user_pin
    parameter with the respective Token Request.

Loading...