API Reference
Create an Authorization Code flow Credential Offer
Create an Authorization Code credential offer
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
/v1/openid/offers
In: header
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.
Specifies a list of additional request parameters that the wallet can include in the authentication request.
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%22request_parameters%22%3A%7B%22login_hint%22%3A%22user%40example.com%22%2C%22prompt%22%3A%22login%22%7D%7D"
}
Create a Pre-Authorized Code flow Credential Offer
Create a Pre-Authorized Code credential offer
Generate a new OpenID4VCI Pre-Authorized Code credential offer.
ℹ️ Note: The Pre-authorized Code flow is only supported for the mDocs credential format.
Analytic events
- OPENID_PRE_AUTHORIZED_OFFER_CREATE_START
- OPENID_PRE_AUTHORIZED_OFFER_CREATE_SUCCESS
- OPENID_PRE_AUTHORIZED_OFFER_CREATE_FAIL
/v1/openid/offers/pre-authorized
In: header
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.
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.
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.
Additional user claims that are available during credential issuance for this offer.
Empty Object
List of claims to persist from the provided claims
to MATTR VII. By default no claim values are persisted.
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.
curl -X POST "https://example.vii.au01.mattr.global/v1/openid/offers/pre-authorized" \ -H "Content-Type: application/json" \ -d '{ "credentials": [ "707e920a-f342-443b-ae24-6946b7b5033e" ] }'
{
"id": "string",
"userId": "string",
"uri": "openid-credential-offer://?credential_offer=%7B%22credential_issuer%22%3A%22https%3A%2F%2Fexample.com%22%2C%22credentials%22%3A%5B%222edaf985-fcc2-4448-9c8e-a04c6c7351c2%22%5D%2C%22grants%22%3A%7B%22urn%3Aietf%3Aparams%3Aoauth%3Agrant-type%3Apre-authorized_code%22%3A%7B%22pre-authorized_code%22%3A%22stukD6lg9c9tQ3jUCa32wVi1HI%2BQIVsFK%2FQPvC2CHRs%3D%22%2C%22tx_code%22%3A%7B%22length%22%3A6%2C%22input_mode%22%3A%22numeric%22%2C%22description%22%3A%22Please%20provide%20the%20one-time%20code%20that%20was%20sent%20via%20e-mail%22%7D%7D%7D%7D",
"expiresAt": "2025-05-01T00:01:00.000Z",
"transactionCode": 493536
}
Delete a Pre-Authorized Code flow Credential Offer
Delete a Pre-authorized Code credential offer
Delete an OpenID4VCI Pre-authorized Code credential offer.
Analytic events
- OPENID_PRE_AUTHORIZED_OFFER_DELETE_START
- OPENID_PRE_AUTHORIZED_OFFER_DELETE_SUCCESS
- OPENID_PRE_AUTHORIZED_OFFER_DELETE_FAIL
/v1/openid/offers/pre-authorized/{id}
In: header
Path Parameters
Pre-authorized credential offer ID
uuid
curl -X DELETE "https://example.vii.au01.mattr.global/v1/openid/offers/pre-authorized/8241400f-de3b-42c5-ad7c-8a380039e796"
{
"code": "string",
"message": "string",
"details": [
{
"value": "string",
"msg": "Invalid value",
"param": "id",
"location": "body"
}
]
}
{
"code": "string",
"message": "string",
"details": [
{
"value": "string",
"msg": "Invalid value",
"param": "id",
"location": "body"
}
]
}
How would you rate this page?