Learn

Verifier applications

Specifies paths and operations for managing Verifier applications for mDocs verification.

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
Roles: ["admin","verifier"]
SecuritybearerAuth
Request
Request Body schema: application/json
required

Verifier application payload

One of:

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

Any of:

Configuration for an mDocs online verifier web applications that only support OpenID4VP.

type
required
string

Defines the type of the verifier application.

Value: "web"
domain
required
string

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 of strings non-empty

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

required
object

Configuration settings that enable verification using OpenID4VP.

object

Configuration settings that enable verification using the Digital Credentials API.

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
Default: true

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.

name
required
string

Unique name to identify the verifier application.

Responses
201

Verifier application created

400

Bad Request. The request was malformed or missing required parameters.

post/v2/presentations/applications
Request samples
application/json
{
  • "type": "web",
  • "domain": "example-verifier-web-application.com",
  • "additionalDomains": [
    ],
  • "openid4vpConfiguration": {},
  • "dcApiConfiguration": {
    },
  • "resultAvailableInFrontChannel": true,
  • "name": "Example Verifier Web Application"
}
Response samples
application/json
{
  • "type": "web",
  • "domain": "example-verifier-web-application.com",
  • "additionalDomains": [
    ],
  • "openid4vpConfiguration": {},
  • "dcApiConfiguration": {
    },
  • "resultAvailableInFrontChannel": true,
  • "id": "1ef1f867-20b4-48ea-aec1-bea7aff4964c",
  • "name": "Example Verifier Web Application"
}

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
Roles: ["admin","verifier"]
SecuritybearerAuth
Responses
200

Verifier applications retrieved

get/v2/presentations/applications
Request samples 
Response samples 
application/json
{
  • "nextCursor": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1hNjZmZmVhNS04NDhlLTQzOWQtODBhNC1kZGE1NWY1M2UzNmM",
  • "data": [
    ]
}
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
    • 



Roles:  ["admin","verifier"]
SecuritybearerAuth 
Request 
path Parameters
applicationId
required
string <uuid> 
Unique identifier for the verifier application.


 
 Example:  281d20b3-42a3-40dd-b29a-115ff32b02b7
Request Body schema: application/json
required
Verifier application payload


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


Any of:
Configuration for an mDocs online verifier web applications that only support OpenID4VP.


type
required
string
Defines the type of the verifier application.


 Value: "web"  
domain
required
string
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 of strings  non-empty 
List of fully qualified domain names of additional verifier applications who can create an online presentation session.


 
required
object
Configuration settings that enable verification using OpenID4VP.


 
object
Configuration settings that enable verification using the Digital Credentials API.




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
 Default:  true
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.


 
name
required
string
Unique name to identify the verifier application.


 
Responses 
200
Verifier application updated


400
Bad Request. The request was malformed or missing required parameters.


404
Not Found. The specified resource was not found.


put/v2/presentations/applications/{applicationId}
Request samples 
application/json
{
  • "type": "web",
  • "domain": "example-verifier-web-application.com",
  • "additionalDomains": [
    ],
  • "openid4vpConfiguration": {},
  • "dcApiConfiguration": {
    },
  • "resultAvailableInFrontChannel": true,
  • "name": "Example Verifier Web Application"
}
Response samples 
application/json
{
  • "type": "web",
  • "domain": "example-verifier-web-application.com",
  • "additionalDomains": [
    ],
  • "openid4vpConfiguration": {},
  • "dcApiConfiguration": {
    },
  • "resultAvailableInFrontChannel": true,
  • "id": "1ef1f867-20b4-48ea-aec1-bea7aff4964c",
  • "name": "Example Verifier Web 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
    • 



Roles:  ["admin","verifier"]
SecuritybearerAuth 
Request 
path Parameters
applicationId
required
string <uuid> 
Unique identifier for the verifier application.


 
 Example:  281d20b3-42a3-40dd-b29a-115ff32b02b7
Responses 
200
Verifier application retrieved


404
Not Found. The specified resource was not found.


get/v2/presentations/applications/{applicationId}
Request samples 
Response samples 
application/json
{
  • "type": "web",
  • "domain": "example-verifier-web-application.com",
  • "additionalDomains": [
    ],
  • "openid4vpConfiguration": {},
  • "dcApiConfiguration": {
    },
  • "resultAvailableInFrontChannel": true,
  • "id": "1ef1f867-20b4-48ea-aec1-bea7aff4964c",
  • "name": "Example Verifier Web 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
    • 



Roles:  ["admin","verifier"]
SecuritybearerAuth 
Request 
path Parameters
applicationId
required
string <uuid> 
Unique identifier for the verifier application.


 
 Example:  281d20b3-42a3-40dd-b29a-115ff32b02b7
Responses 
204
Verifier application deleted


404
Not Found. The specified resource was not found.


delete/v2/presentations/applications/{applicationId}
Request samples 
Response samples 
application/json
{
  • "code": "string",
  • "message": "string",
  • "details": [
    ]
}
➔ Next to Wallet providers