Verifier applications

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Request Body

application/json

Verifier application payload

TypeScript Definitions

Use the request body type in TypeScript.

Configuration for an mDocs online verifier application.

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

name?string

Unique name to identify the verifier application.

type*"web"

Defines the type of the verifier application.

Value in

"web"

domain*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<string>

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

Items1 <= items

openid4vpConfiguration?

Configuration settings that enable verification using OID4VP.

At least one of openid4vpConfiguration or dcApiConfiguration must be provided.

dcApiConfiguration?

Configuration settings that enable verification using the Digital Credentials API.

At least one of openid4vpConfiguration or dcApiConfiguration must be provided.

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

Response Body

`application/json`

curl -X POST "https://example.com/v2/presentations/applications" \  -H "Content-Type: application/json" \  -d '{    "name": "string",    "type": "web",    "domain": "string"  }'

{  "id": "string",  "name": "string",  "type": "web",  "domain": "string",  "additionalDomains": [    "string"  ],  "openid4vpConfiguration": {    "supportedModes": "all",    "redirectUris": [      "string"    ],    "display": {      "logoImage": {        "url": "string",        "altText": "string"      },      "headerText": "string",      "bodyText": "string",      "privacyPolicyUrl": "string",      "primaryColorHex": "string"    }  },  "dcApiConfiguration": {    "supportedBrowserPlatforms": {      "desktop": true,      "mobile": true    }  },  "resultAvailableInFrontChannel": true}

Retrieve all verifier applications

GET/v2/presentations/applications

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Query Parameters

limit?number

Range size of returned list.

Range1 <= value <= 1000

Default100

cursor?string

Starting point for the list of entries.

Response Body

`application/json`

curl -X GET "https://example.com/v2/presentations/applications"

{  "nextCursor": "string",  "data": [    {      "id": "string",      "name": "string",      "type": "web",      "domain": "string",      "additionalDomains": [        "string"      ],      "openid4vpConfiguration": {        "supportedModes": "all",        "redirectUris": [          "string"        ],        "display": {          "logoImage": {            "url": "string",            "altText": "string"          },          "headerText": "string",          "bodyText": "string",          "privacyPolicyUrl": "string",          "primaryColorHex": "string"        }      },      "dcApiConfiguration": {        "supportedBrowserPlatforms": {          "desktop": true,          "mobile": true        }      },      "resultAvailableInFrontChannel": true    }  ]}

Retrieve a verifier application

GET/v2/presentations/applications/{verifierApplicationId}

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

verifierApplicationId*string

Unique identifier for the verifier application.

Formatuuid

Response Body

`application/json`

curl -X GET "https://example.com/v2/presentations/applications/497f6eca-6276-4993-bfeb-53cbbbba6f08"

{  "id": "string",  "name": "string",  "type": "web",  "domain": "string",  "additionalDomains": [    "string"  ],  "openid4vpConfiguration": {    "supportedModes": "all",    "redirectUris": [      "string"    ],    "display": {      "logoImage": {        "url": "string",        "altText": "string"      },      "headerText": "string",      "bodyText": "string",      "privacyPolicyUrl": "string",      "primaryColorHex": "string"    }  },  "dcApiConfiguration": {    "supportedBrowserPlatforms": {      "desktop": true,      "mobile": true    }  },  "resultAvailableInFrontChannel": true}

Update a verifier application

PUT/v2/presentations/applications/{verifierApplicationId}

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

verifierApplicationId*string

Unique identifier for the verifier application.

Formatuuid

Request Body

application/json

Verifier application payload

TypeScript Definitions

Use the request body type in TypeScript.

Configuration for an mDocs online verifier application.

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

name?string

Unique name to identify the verifier application.

type*"web"

Defines the type of the verifier application.

Value in

"web"

domain*string

additionalDomains?array<string>

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

Items1 <= items

openid4vpConfiguration?

Configuration settings that enable verification using OID4VP.

At least one of openid4vpConfiguration or dcApiConfiguration must be provided.

dcApiConfiguration?

Configuration settings that enable verification using the Digital Credentials API.

At least one of openid4vpConfiguration or dcApiConfiguration must be provided.

resultAvailableInFrontChannel?boolean

Defaulttrue

Response Body

`application/json`

curl -X PUT "https://example.com/v2/presentations/applications/497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "Content-Type: application/json" \  -d '{    "name": "string",    "type": "web",    "domain": "string"  }'

{  "id": "string",  "name": "string",  "type": "web",  "domain": "string",  "additionalDomains": [    "string"  ],  "openid4vpConfiguration": {    "supportedModes": "all",    "redirectUris": [      "string"    ],    "display": {      "logoImage": {        "url": "string",        "altText": "string"      },      "headerText": "string",      "bodyText": "string",      "privacyPolicyUrl": "string",      "primaryColorHex": "string"    }  },  "dcApiConfiguration": {    "supportedBrowserPlatforms": {      "desktop": true,      "mobile": true    }  },  "resultAvailableInFrontChannel": true}

Delete a verifier application

DELETE/v2/presentations/applications/{verifierApplicationId}

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

verifierApplicationId*string

Unique identifier for the verifier application.

Formatuuid

Response Body

`application/json`

curl -X DELETE "https://example.com/v2/presentations/applications/497f6eca-6276-4993-bfeb-53cbbbba6f08"

Empty

Verifier applications

Create a verifier application

Authorization

Request Body

Response Body

`application/json`

`application/json`

Retrieve all verifier applications

Authorization

Query Parameters

Response Body

`application/json`

Retrieve a verifier application

Authorization

Path Parameters

Response Body

`application/json`

`application/json`

Update a verifier application

Authorization

Path Parameters

Request Body

Response Body

`application/json`

`application/json`

`application/json`

Delete a verifier application

Authorization

Path Parameters

Response Body

`application/json`

On this page

Verifier applications

201application/json

400application/json

200application/json

200application/json

404application/json

200application/json

400application/json

404application/json

204

404application/json

On this page

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`