light-mode-image
Learn
API ReferenceCredential offers

Create an Authorization Code credential offer

Roles

adminissuermanaged-issuer

Analytics Events

OPENID_OFFER_CREATE_STARTOPENID_OFFER_CREATE_SUCCESSOPENID_OFFER_CREATE_FAIL
POST/v1/openid/offers

Returns an OpenID4VCI credential offer URI. See https://openid.net/specs/openid-4-verifiable-credential-issuance-1_0.html#section-10.1

Analytic events

  • OPENID_OFFER_CREATE_START
  • OPENID_OFFER_CREATE_SUCCESS
  • OPENID_OFFER_CREATE_FAIL

Authorization

bearerAuthOpenIdCredentials
AuthorizationBearer <token>

In: header

Request Body

application/json

credentials*array<>

This array includes a list of identifiers for credential configurations that will be included in the credential offer. These identifiers are the id elements returned in the response when you create a credential configuration. To issue multiple credential formats of the same credential in a single flow, include all the required credential configuration id elements in the request payload.

request_parameters?

Specifies a list of additional request parameters that the wallet can include in the authentication request.

Response Body

application/json

curl -X POST "https://example.vii.au01.mattr.global/v1/openid/offers" \  -H "Content-Type: application/json" \  -d '{    "credentials": [      "707e920a-f342-443b-ae24-6946b7b5033e"    ]  }'
{
  "uri": "openid-credential-offer://?credential_offer=%7B%22credential_issuer%22%3A%22https%3A%2F%2Fmyissuer.example.com%22%2C%22credentials%22%3A%5B%22707e920a-f342-443b-ae24-6946b7b5033e%22%5D%2C%22credential_configuration_ids%22%3A%5B%22707e920a-f342-443b-ae24-6946b7b5033e%22%5D%2C%22request_parameters%22%3A%7B%22login_hint%22%3A%22user%40example.com%22%2C%22prompt%22%3A%22login%22%7D%7D"
}

How would you rate this page?

Delete an mDocs configuration DELETE

Deletes an existing mDocs configuration by providing its ID. ### **Analytic events** * MOBILE_CREDENTIAL_CONFIGURATION_DELETE_START * MOBILE_CREDENTIAL_CONFIGURATION_DELETE_SUCCESS * MOBILE_CREDENTIAL_CONFIGURATION_DELETE_FAIL

Create a Pre-Authorized Code credential offer POST

Generate a new [OpenID4VCI Pre-Authorized Code](https://openid.net/specs/openid-4-verifiable-credential-issuance-1_0.html#section-4.1) credential offer. <Callout> The Pre-authorized Code flow is only supported for the mDocs credential format. </Callout> ### **Analytic events** * OPENID_PRE_AUTHORIZED_OFFER_CREATE_START * OPENID_PRE_AUTHORIZED_OFFER_CREATE_SUCCESS * OPENID_PRE_AUTHORIZED_OFFER_CREATE_FAIL