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
Request Body schema: application/jsonrequired
Verifier application payload
Configuration for an mDocs online verifier web application. Either OpenID4VP or Digital Credentials API configuration must be provided.
type required | string Defines the type of the verifier application. |
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 |
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. |
resultAvailableInFrontChannel | boolean Default: true Indicates whether or not the verification result should be returned directly to the verifier application ( |
name required | string Unique name to identify the verifier application. |
Verifier application created
Bad Request. The request was malformed or missing required parameters.
- Payload
- curl
- Node.js
- JavaScript
- Python
- C#
- Java
{- "type": "web",
- "domain": "example-verifier-web-application.com",
- "additionalDomains": [
- "example-verifier-web-application.com"
], - "openid4vpConfiguration": {
- "supportedModes": "all",
- "display": {
- "headerText": "Share your information.",
- "bodyText": "Please scan the QR code to the right to provide information required for this interaction.",
- "primaryColorHex": "#FFFFFF"
}
}, - "resultAvailableInFrontChannel": true,
- "name": "Example Verifier Web Application"
}
- 201
- 400
{- "type": "web",
- "domain": "example-verifier-web-application.com",
- "additionalDomains": [
- "example-verifier-web-application.com"
], - "openid4vpConfiguration": {
- "supportedModes": "all",
- "display": {
- "headerText": "Share your information.",
- "bodyText": "Please scan the QR code to the right to provide information required for this interaction.",
- "primaryColorHex": "#FFFFFF"
}
}, - "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
Verifier applications retrieved
- curl
- Node.js
- JavaScript
- Python
- C#
- Java
- 200
{- "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",
- "display": {
- "headerText": "Share your information.",
- "bodyText": "Please scan the QR code to the right to provide information required for this interaction.",
- "primaryColorHex": "#FFFFFF"
}
}
}
]
}
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
path Parameters
Request Body schema: application/jsonrequired
Verifier application payload
Configuration for an mDocs online verifier web application. Either OpenID4VP or Digital Credentials API configuration must be provided.
type required | string Defines the type of the verifier application. |
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 |
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. |
resultAvailableInFrontChannel | boolean Default: true Indicates whether or not the verification result should be returned directly to the verifier application ( |
name required | string Unique name to identify the verifier application. |
Verifier application updated
Bad Request. The request was malformed or missing required parameters.
Not Found. The specified resource was not found.
- Payload
- curl
- Node.js
- JavaScript
- Python
- C#
- Java
{- "type": "web",
- "domain": "example-verifier-web-application.com",
- "additionalDomains": [
- "example-verifier-web-application.com"
], - "openid4vpConfiguration": {
- "supportedModes": "all",
- "display": {
- "headerText": "Share your information.",
- "bodyText": "Please scan the QR code to the right to provide information required for this interaction.",
- "primaryColorHex": "#FFFFFF"
}
}, - "resultAvailableInFrontChannel": true,
- "name": "Example Verifier Web Application"
}
- 200
- 400
- 404
{- "type": "web",
- "domain": "example-verifier-web-application.com",
- "additionalDomains": [
- "example-verifier-web-application.com"
], - "openid4vpConfiguration": {
- "supportedModes": "all",
- "display": {
- "headerText": "Share your information.",
- "bodyText": "Please scan the QR code to the right to provide information required for this interaction.",
- "primaryColorHex": "#FFFFFF"
}
}, - "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
Verifier application retrieved
Not Found. The specified resource was not found.
- curl
- Node.js
- JavaScript
- Python
- C#
- Java
- 200
- 404
{- "type": "web",
- "domain": "example-verifier-web-application.com",
- "additionalDomains": [
- "example-verifier-web-application.com"
], - "openid4vpConfiguration": {
- "supportedModes": "all",
- "display": {
- "headerText": "Share your information.",
- "bodyText": "Please scan the QR code to the right to provide information required for this interaction.",
- "primaryColorHex": "#FFFFFF"
}
}, - "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
Verifier application deleted
Not Found. The specified resource was not found.
- curl
- Node.js
- JavaScript
- Python
- C#
- Java
- 404
{- "code": "string",
- "message": "string",
- "details": [
- {
- "value": "string",
- "msg": "Invalid value",
- "param": "id",
- "location": "body"
}
]
}