Verifier applications
Create a verifier application
Create verifier application
Creates an mDocs online verifier application.
Analytic events
- CREDENTIAL_PRESENTATION_VERIFIER_APPLICATION_CREATE_START
- CREDENTIAL_PRESENTATION_VERIFIER_APPLICATION_CREATE_SUCCESS
- CREDENTIAL_PRESENTATION_VERIFIER_APPLICATION_CREATE_FAIL
/v2/presentations/applications
In: header
Verifier application payload
Configuration for an mDocs online verifier web application. Either OpenID4VP or Digital Credentials API configuration must be provided.
Configuration for an mDocs online verifier iOS application.
Defines the type of the verifier application.
"ios"
Bundle ID of the iOS app.
Indicates whether or not the verification result should be returned directly to the web application (true
) or only via a configured back-end (false
). Refer to the detailed workflow for more information.
true
Team ID of the iOS app.
Configuration for an mDocs online verifier Android application.
curl -X POST "https://example.vii.au01.mattr.global/v2/presentations/applications" \ -H "Content-Type: application/json" \ -d '{ "name": "Example Verifier Web Application", "type": "web", "domain": "example-verifier-web-application.com" }'
{
"id": "1ef1f867-20b4-48ea-aec1-bea7aff4964c",
"name": "Example Verifier Web Application",
"resultAvailableInFrontChannel": true,
"type": "web",
"domain": "example-verifier-web-application.com",
"additionalDomains": [
"example-verifier-web-application.com"
],
"openid4vpConfiguration": {
"supportedModes": "all",
"redirectUris": [
"https://example-verifier-web-application.com/presentation/callback"
],
"display": {
"logoImage": {
"url": "https://example-logo-image-url.com",
"altText": "Logo image"
},
"headerText": "Share your information.",
"bodyText": "Please scan the QR code to the right to provide information required for this interaction.",
"privacyPolicyUrl": "https://example-privacy-policy.com",
"primaryColorHex": "#FFFFFF"
}
},
"dcApiConfiguration": {
"supportedBrowserPlatforms": {
"desktop": true,
"mobile": true
}
}
}
{
"code": "string",
"message": "string",
"details": [
{
"value": "string",
"msg": "Invalid value",
"param": "id",
"location": "body"
}
]
}
Retrieve all verifier applications
Retrieve all verifier applications
Retrieves all configured mDocs online verifier applications.
Analytic events
- CREDENTIAL_PRESENTATION_VERIFIER_APPLICATION_RETRIEVE_LIST_START
- CREDENTIAL_PRESENTATION_VERIFIER_APPLICATION_RETRIEVE_LIST_SUCCESS
- CREDENTIAL_PRESENTATION_VERIFIER_APPLICATION_RETRIEVE_LIST_FAIL
/v2/presentations/applications
In: header
curl -X GET "https://example.vii.au01.mattr.global/v2/presentations/applications"
{
"nextCursor": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1hNjZmZmVhNS04NDhlLTQzOWQtODBhNC1kZGE1NWY1M2UzNmM",
"data": [
{
"id": "1ef1f867-20b4-48ea-aec1-bea7aff4964c",
"name": "Example Verifier Web Application",
"resultAvailableInFrontChannel": true,
"type": "web",
"domain": "example-verifier-web-application.com",
"additionalDomains": [
"example-verifier-web-application.com"
],
"openid4vpConfiguration": {
"supportedModes": "all",
"redirectUris": [
"https://example-verifier-web-application.com/presentation/callback"
],
"display": {
"logoImage": {
"url": "https://example-logo-image-url.com",
"altText": "Logo image"
},
"headerText": "Share your information.",
"bodyText": "Please scan the QR code to the right to provide information required for this interaction.",
"privacyPolicyUrl": "https://example-privacy-policy.com",
"primaryColorHex": "#FFFFFF"
}
},
"dcApiConfiguration": {
"supportedBrowserPlatforms": {
"desktop": true,
"mobile": true
}
}
}
]
}
Retrieve a verifier application
Retrieve a verifier application
Retrieves an existing mDocs online verifier application.
Analytic events
- CREDENTIAL_PRESENTATION_VERIFIER_APPLICATION_RETRIEVE_START
- CREDENTIAL_PRESENTATION_VERIFIER_APPLICATION_RETRIEVE_SUCCESS
- CREDENTIAL_PRESENTATION_VERIFIER_APPLICATION_RETRIEVE_FAIL
/v2/presentations/applications/{applicationId}
In: header
Path Parameters
Unique identifier for the verifier application.
uuid
curl -X GET "https://example.vii.au01.mattr.global/v2/presentations/applications/281d20b3-42a3-40dd-b29a-115ff32b02b7"
{
"id": "1ef1f867-20b4-48ea-aec1-bea7aff4964c",
"name": "Example Verifier Web Application",
"resultAvailableInFrontChannel": true,
"type": "web",
"domain": "example-verifier-web-application.com",
"additionalDomains": [
"example-verifier-web-application.com"
],
"openid4vpConfiguration": {
"supportedModes": "all",
"redirectUris": [
"https://example-verifier-web-application.com/presentation/callback"
],
"display": {
"logoImage": {
"url": "https://example-logo-image-url.com",
"altText": "Logo image"
},
"headerText": "Share your information.",
"bodyText": "Please scan the QR code to the right to provide information required for this interaction.",
"privacyPolicyUrl": "https://example-privacy-policy.com",
"primaryColorHex": "#FFFFFF"
}
},
"dcApiConfiguration": {
"supportedBrowserPlatforms": {
"desktop": true,
"mobile": true
}
}
}
{
"code": "string",
"message": "string",
"details": [
{
"value": "string",
"msg": "Invalid value",
"param": "id",
"location": "body"
}
]
}
Update a verifier application
Update verifier application
Updates an existing mDocs online verifier application.
Analytic events
- CREDENTIAL_PRESENTATION_VERIFIER_APPLICATION_UPDATE_START
- CREDENTIAL_PRESENTATION_VERIFIER_APPLICATION_UPDATE_SUCCESS
- CREDENTIAL_PRESENTATION_VERIFIER_APPLICATION_UPDATE_FAIL
/v2/presentations/applications/{applicationId}
In: header
Path Parameters
Unique identifier for the verifier application.
uuid
Verifier application payload
Configuration for an mDocs online verifier web application. Either OpenID4VP or Digital Credentials API configuration must be provided.
Configuration for an mDocs online verifier iOS application.
Defines the type of the verifier application.
"ios"
Bundle ID of the iOS app.
Indicates whether or not the verification result should be returned directly to the web application (true
) or only via a configured back-end (false
). Refer to the detailed workflow for more information.
true
Team ID of the iOS app.
Configuration for an mDocs online verifier Android application.
curl -X PUT "https://example.vii.au01.mattr.global/v2/presentations/applications/281d20b3-42a3-40dd-b29a-115ff32b02b7" \ -H "Content-Type: application/json" \ -d '{ "name": "Example Verifier Web Application", "type": "web", "domain": "example-verifier-web-application.com" }'
{
"id": "1ef1f867-20b4-48ea-aec1-bea7aff4964c",
"name": "Example Verifier Web Application",
"resultAvailableInFrontChannel": true,
"type": "web",
"domain": "example-verifier-web-application.com",
"additionalDomains": [
"example-verifier-web-application.com"
],
"openid4vpConfiguration": {
"supportedModes": "all",
"redirectUris": [
"https://example-verifier-web-application.com/presentation/callback"
],
"display": {
"logoImage": {
"url": "https://example-logo-image-url.com",
"altText": "Logo image"
},
"headerText": "Share your information.",
"bodyText": "Please scan the QR code to the right to provide information required for this interaction.",
"privacyPolicyUrl": "https://example-privacy-policy.com",
"primaryColorHex": "#FFFFFF"
}
},
"dcApiConfiguration": {
"supportedBrowserPlatforms": {
"desktop": true,
"mobile": true
}
}
}
{
"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"
}
]
}
Delete a verifier application
Delete a verifier application
Removes an existing mDocs online verifier application.
Analytic events
- PRESENTATION_VERIFIER_APPLICATION_DELETE_START
- PRESENTATION_VERIFIER_APPLICATION_DELETE_SUCCESS
- PRESENTATION_VERIFIER_APPLICATION_DELETE_FAIL
/v2/presentations/applications/{applicationId}
In: header
Path Parameters
Unique identifier for the verifier application.
uuid
curl -X DELETE "https://example.vii.au01.mattr.global/v2/presentations/applications/281d20b3-42a3-40dd-b29a-115ff32b02b7"
{
"code": "string",
"message": "string",
"details": [
{
"value": "string",
"msg": "Invalid value",
"param": "id",
"location": "body"
}
]
}
How would you rate this page?