API Reference

Create an Authorization Code flow Credential Offer

POST/v1/openid/offers

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

This offer can be used more than once, and can be shared with multiple users. Each user will authenticate independently during the credential issuance workflow, allowing the same offer URI to issue credentials with different user-specific data to multiple holders.

Roles

adminissuermanaged-issuer

Analytics Events

OPENID_OFFER_CREATE_STARTOPENID_OFFER_CREATE_SUCCESSOPENID_OFFER_CREATE_FAIL

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

`application/json`

curl -X POST "https://example.com/v1/openid/offers" \  -H "Content-Type: application/json" \  -d '{    "credentials": [      "string"    ]  }'

{  "uri": "string"}

Create a Pre-Authorized Code flow Credential Offer

POST/v1/openid/offers/pre-authorized

Generate a new OID4VCI Pre-Authorized Code credential offer.

This offer can only be used once. Once the offer is successfully claimed and the credential is issued, the pre-authorized code is consumed and the offer becomes invalid. The offer cannot be claimed again, even if the same user attempts to claim it. This is a security measure to prevent unauthorized credential duplication. If you need to issue another credential to the same user, you must generate a new credential offer.

The total size of the request cannot exceed 500KB, including any claims. This is mostly relevant when including large claims such as images. When holders present credentials over Bluetooth Low Energy (BLE), keep payloads as small as practical, as large claims can degrade the transfer experience. Reserve larger payloads for remote presentation flows.

Roles

adminissuermanaged-issuer

Analytics Events

OPENID_PRE_AUTHORIZED_OFFER_CREATE_STARTOPENID_PRE_AUTHORIZED_OFFER_CREATE_SUCCESSOPENID_PRE_AUTHORIZED_OFFER_CREATE_FAIL

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

`application/json`

curl -X POST "https://example.com/v1/openid/offers/pre-authorized" \  -H "Content-Type: application/json" \  -d '{    "credentials": [      "string"    ]  }'

{  "id": "string",  "userId": "string",  "uri": "string",  "expiresAt": 0,  "transactionCode": "string"}

Delete a Pre-Authorized Code flow Credential Offer

DELETE/v1/openid/offers/pre-authorized/{id}

Delete an OID4VCI Pre-authorized Code credential offer.

Roles

adminissuermanaged-issuer

Analytics Events

OPENID_PRE_AUTHORIZED_OFFER_DELETE_STARTOPENID_PRE_AUTHORIZED_OFFER_DELETE_SUCCESSOPENID_PRE_AUTHORIZED_OFFER_DELETE_FAIL

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Pre-authorized credential offer ID

Formatuuid

Response Body

`application/json`

curl -X DELETE "https://example.com/v1/openid/offers/pre-authorized/497f6eca-6276-4993-bfeb-53cbbbba6f08"

Empty

API Reference

Create an Authorization Code flow Credential Offer

POST/v1/openid/offers

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

Roles

adminissuermanaged-issuer

Analytics Events

OPENID_OFFER_CREATE_STARTOPENID_OFFER_CREATE_SUCCESSOPENID_OFFER_CREATE_FAIL

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

credentials*array<string>

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.com/v1/openid/offers" \  -H "Content-Type: application/json" \  -d '{    "credentials": [      "string"    ]  }'

{  "uri": "string"}

Create a Pre-Authorized Code flow Credential Offer

POST/v1/openid/offers/pre-authorized

Generate a new OID4VCI Pre-Authorized Code credential offer.

Roles

adminissuermanaged-issuer

Analytics Events

OPENID_PRE_AUTHORIZED_OFFER_CREATE_STARTOPENID_PRE_AUTHORIZED_OFFER_CREATE_SUCCESSOPENID_PRE_AUTHORIZED_OFFER_CREATE_FAIL

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

credentials*array<string>

This array includes a list of identifiers for mDocs 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. Providing the identifier of a non-mDocs credential configuration will result in an error.

userId?string

Unique system generated identifier to reference the user for this offer. This can be obtained by searching for a user. If not provided, a new user entity will be created.

transactionCodeConfiguration?

Configure whether a second-factor transaction code is required for this offer. If a configuration is provided, a code will be generated for the offer, and the end user must submit it during credential retrieval. If an incorrect transaction code is entered three times by the holder, the credential offer is permanently invalidated and the wallet can no longer claim the credential.

claims?

Additional user claims that are available during credential issuance for this offer.

claimsToPersist?array<string>

This array includes a list of claims that will be persisted against the user object in the MATTR VII database. These claims are then available for any future credential offers or issuance operations for this user. By default no claims are persisted, and it is recommended to consider carefully which claims to persist, if any, as this has implications for data privacy and security.

expiresIn?

Specifies when the offer will expire. Once the offer expires, the user can no longer use it to claim a credential, and a new offer must be generated. The expiration period can include any combination of minutes and seconds. By default, the offer expires in 5 minutes, and the maximum allowed duration is 10 minutes.

Response Body

`application/json`

curl -X POST "https://example.com/v1/openid/offers/pre-authorized" \  -H "Content-Type: application/json" \  -d '{    "credentials": [      "string"    ]  }'

{  "id": "string",  "userId": "string",  "uri": "string",  "expiresAt": 0,  "transactionCode": "string"}

Delete a Pre-Authorized Code flow Credential Offer

DELETE/v1/openid/offers/pre-authorized/{id}

Delete an OID4VCI Pre-authorized Code credential offer.

Roles

adminissuermanaged-issuer

Analytics Events

OPENID_PRE_AUTHORIZED_OFFER_DELETE_STARTOPENID_PRE_AUTHORIZED_OFFER_DELETE_SUCCESSOPENID_PRE_AUTHORIZED_OFFER_DELETE_FAIL

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Pre-authorized credential offer ID

Formatuuid

Response Body

`application/json`

curl -X DELETE "https://example.com/v1/openid/offers/pre-authorized/497f6eca-6276-4993-bfeb-53cbbbba6f08"

Empty

How would you rate this page?

Last updated on

Roles

Analytics Events

200application/json

Roles

Analytics Events

200application/json

Roles

Analytics Events

204

400application/json

404application/json

On this page

API Reference

Roles

Analytics Events

200application/json

Roles

Analytics Events

200application/json

Roles

Analytics Events

204

400application/json

404application/json

On this page

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`