light-mode-image
Learn
API Reference

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
POST/v2/presentations/applications

Authorization

AuthorizationBearer <token>

In: header

Request Body

Verifier application payload

Configuration for an mDocs online verifier web application. Either OpenID4VP or Digital Credentials API configuration must be provided.

typestring

Defines the type of the verifier application.

Value in"web"
domainstring

Fully qualified domain name of verifier application that can create an online presentation session. This ensures the verifier tenant only accepts requests from known and trusted applications. Note that localhost is not supported. Use local tunneling services for testing.

additionalDomains?array<string>

List of fully qualified domain names of additional verifier applications who can create an online presentation session.

Items1 <= items
openid4vpConfiguration?object

Configuration settings that enable verification using OpenID4VP.

At least one of openid4vpConfiguration or dcApiConfiguration must be provided.

dcApiConfiguration?object

Configuration settings that enable verification using the Digital Credentials API.

At least one of openid4vpConfiguration or dcApiConfiguration must be provided.

DC API support is currently offered as a tech preview. As such, functionality may be limited, may not work in all scenarios, and could change or break without prior notice.

resultAvailableInFrontChannel?boolean

Indicates whether or not the verification result should be returned directly to the verifier application (true) or only via a configured back-end (false). Refer to the detailed workflow for more information.

Defaulttrue

Configuration for an mDocs online verifier iOS application.

typestring

Defines the type of the verifier application.

Value in"ios"
bundleIdstring

Bundle ID of the iOS app.

openid4vpConfiguration?object
resultAvailableInFrontChannel?boolean

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.

Defaulttrue
teamIdteamId

Team ID of the iOS app.

Configuration for an mDocs online verifier Android application.

typestring

Defines the type of the verifier application.

Value in"android"
packageNamestring

Package name of the Android application that will interact with this verifier application.

packageSigningCertificateThumbprintsarray<string>
  • SHA-256 hex-encoded fingerprints of the signing key certificates that were used to sign the Android Package Kit (APK) or app bundle.
  • This ensures the verifier tenant only accepts requests from known and trusted applications.
  • Any verification requests will fail if the certificate thumbprint does not match. Refer to Android app signing for more information.
openid4vpConfiguration?object

Configuration settings that enable verification using OpenID4VP.

At least one of openid4vpConfiguration or dcApiConfiguration must be provided.

dcApiConfiguration?object

Configuration settings that enable verification using the Digital Credentials API.

At least one of openid4vpConfiguration or dcApiConfiguration must be provided.

DC API support is currently offered as a tech preview. As such, functionality may be limited, may not work in all scenarios, and could change or break without prior notice.

resultAvailableInFrontChannel?boolean

Indicates whether or not the verification result should be returned directly to the Android application (true) or only via a configured back-end (false). Refer to the detailed workflow for more information.

Defaulttrue
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
GET/v2/presentations/applications

Authorization

AuthorizationBearer <token>

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
GET/v2/presentations/applications/{applicationId}

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

applicationIdstring

Unique identifier for the verifier application.

Formatuuid
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
PUT/v2/presentations/applications/{applicationId}

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

applicationIdstring

Unique identifier for the verifier application.

Formatuuid

Request Body

Verifier application payload

Configuration for an mDocs online verifier web application. Either OpenID4VP or Digital Credentials API configuration must be provided.

typestring

Defines the type of the verifier application.

Value in"web"
domainstring

Fully qualified domain name of verifier application that can create an online presentation session. This ensures the verifier tenant only accepts requests from known and trusted applications. Note that localhost is not supported. Use local tunneling services for testing.

additionalDomains?array<string>

List of fully qualified domain names of additional verifier applications who can create an online presentation session.

Items1 <= items
openid4vpConfiguration?object

Configuration settings that enable verification using OpenID4VP.

At least one of openid4vpConfiguration or dcApiConfiguration must be provided.

dcApiConfiguration?object

Configuration settings that enable verification using the Digital Credentials API.

At least one of openid4vpConfiguration or dcApiConfiguration must be provided.

DC API support is currently offered as a tech preview. As such, functionality may be limited, may not work in all scenarios, and could change or break without prior notice.

resultAvailableInFrontChannel?boolean

Indicates whether or not the verification result should be returned directly to the verifier application (true) or only via a configured back-end (false). Refer to the detailed workflow for more information.

Defaulttrue

Configuration for an mDocs online verifier iOS application.

typestring

Defines the type of the verifier application.

Value in"ios"
bundleIdstring

Bundle ID of the iOS app.

openid4vpConfiguration?object
resultAvailableInFrontChannel?boolean

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.

Defaulttrue
teamIdteamId

Team ID of the iOS app.

Configuration for an mDocs online verifier Android application.

typestring

Defines the type of the verifier application.

Value in"android"
packageNamestring

Package name of the Android application that will interact with this verifier application.

packageSigningCertificateThumbprintsarray<string>
  • SHA-256 hex-encoded fingerprints of the signing key certificates that were used to sign the Android Package Kit (APK) or app bundle.
  • This ensures the verifier tenant only accepts requests from known and trusted applications.
  • Any verification requests will fail if the certificate thumbprint does not match. Refer to Android app signing for more information.
openid4vpConfiguration?object

Configuration settings that enable verification using OpenID4VP.

At least one of openid4vpConfiguration or dcApiConfiguration must be provided.

dcApiConfiguration?object

Configuration settings that enable verification using the Digital Credentials API.

At least one of openid4vpConfiguration or dcApiConfiguration must be provided.

DC API support is currently offered as a tech preview. As such, functionality may be limited, may not work in all scenarios, and could change or break without prior notice.

resultAvailableInFrontChannel?boolean

Indicates whether or not the verification result should be returned directly to the Android application (true) or only via a configured back-end (false). Refer to the detailed workflow for more information.

Defaulttrue
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
DELETE/v2/presentations/applications/{applicationId}

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

applicationIdstring

Unique identifier for the verifier application.

Formatuuid
curl -X DELETE "https://example.vii.au01.mattr.global/v2/presentations/applications/281d20b3-42a3-40dd-b29a-115ff32b02b7"
Empty
{
  "code": "string",
  "message": "string",
  "details": [
    {
      "value": "string",
      "msg": "Invalid value",
      "param": "id",
      "location": "body"
    }
  ]
}

How would you rate this page?

Callback

Previous Page

Trusted issuers

Next Page

On this page

Create a verifier applicationRetrieve all verifier applicationsRetrieve a verifier applicationUpdate a verifier applicationDelete a verifier application