Learn

mDocs

Specifies paths and operations for verifying mDocs credentials.

Create a trusted issuer

Add a new mDocs trusted issuer, to be used in online presentation workflows.

Analytic events

  • MOBILE_CREDENTIAL_TRUSTED_ISSUER_CREATE_START
  • MOBILE_CREDENTIAL_TRUSTED_ISSUER_CREATE_SUCCESS
  • MOBILE_CREDENTIAL_TRUSTED_ISSUER_CREATE_FAIL
Roles: ["admin","verifier"]
SecuritybearerAuth
Request
Request Body schema: application/json
required

The trusted issuer payload

certificatePem
required
string

Certificate PEM containing trusted issuer data. This PEM can represent a future-dated IACA to support seamless rotation.

Responses
201

Trusted issuer created

400

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

post/v2/credentials/mobile/trusted-issuers
Request samples
application/json
{
  • "certificatePem": "-----BEGIN CERTIFICATE-----\\r\\nMIICUDCCAfWgAwIBAgIKVVqBlVonWFs3lTAKBggqhkjOPQQDAjAkMQswCQYDVQQG\\r\\nEwJOWjEVMBMGA1UEAwwMRXhhbXBsZSBJQUNBMB4XDTI0MDExMTAzMjYwMFoXDTM0\\r\\nMDEwODAzMjYwMFowJDELMAkGA1UEBhMCTloxFTATBgNVBAMMDEV4YW1wbGUgSUFD\\r\\nQTBZMBMGByqGSM49AgEGCCqGSM49AwEHA0IABOHxm9MYkCvIvZc/MyoWGul8+tla\\r\\nFSSRVkDllFERbO/Tg7DOj4CJfYrhDJEuV04eRgcowBDhr9W/bvnTMZMa/RijggEN\\r\\nMIIBCTASBgNVHRMBAf8ECDAGAQH/AgEAMA4GA1UdDwEB/wQEAwIBBjAdBgNVHQ4E\\r\\nFgQUpS3hOCbmCUwu8n91X9CLS682cOkwOwYDVR0SBDQwMoYwaHR0cHM6Ly9odWRz\\r\\nb24tdGVuYW50LTAwMS52aWkuYXUzMDEubWF0dHJsYWJzLmlvMIGGBgNVHR8EfzB9\\r\\nMHugeaB3hnVodHRwczovL2h1ZHNvbi10ZW5hbnQtMDAxLnZpaS5hdTMwMS5tYXR0\\r\\ncmxhYnMuaW8vdjIvY3JlZGVudGlhbHMvbW9iaWxlL2lhY2FzL2VkNzQzMTllLTcy\\r\\nYTYtNDQwMS1iM2E1LTk0ZTk4MGZiZWJlYS9jcmwwCgYIKoZIzj0EAwIDSQAwRgIh\\r\\nAJxWGZvntq+hymL7zWwrlZo1Jz1+lWglu/MESdmUhTNFAiEAg+x5e3TzBxgHneIM\\r\\nVpTmZNOyZI3Hn17WRKkyKSg+5/8=\\r\\n-----END CERTIFICATE-----\\r\\n"
}
Response samples
application/json
{
  • "id": "ed74319e-72a6-4401-b3a5-94e980fbebea",
  • "certificatePem": "-----BEGIN CERTIFICATE-----\\r\\nMIICUDCCAfWgAwIBAgIKVVqBlVonWFs3lTAKBggqhkjOPQQDAjAkMQswCQYDVQQG\\r\\nEwJOWjEVMBMGA1UEAwwMRXhhbXBsZSBJQUNBMB4XDTI0MDExMTAzMjYwMFoXDTM0\\r\\nMDEwODAzMjYwMFowJDELMAkGA1UEBhMCTloxFTATBgNVBAMMDEV4YW1wbGUgSUFD\\r\\nQTBZMBMGByqGSM49AgEGCCqGSM49AwEHA0IABOHxm9MYkCvIvZc/MyoWGul8+tla\\r\\nFSSRVkDllFERbO/Tg7DOj4CJfYrhDJEuV04eRgcowBDhr9W/bvnTMZMa/RijggEN\\r\\nMIIBCTASBgNVHRMBAf8ECDAGAQH/AgEAMA4GA1UdDwEB/wQEAwIBBjAdBgNVHQ4E\\r\\nFgQUpS3hOCbmCUwu8n91X9CLS682cOkwOwYDVR0SBDQwMoYwaHR0cHM6Ly9odWRz\\r\\nb24tdGVuYW50LTAwMS52aWkuYXUzMDEubWF0dHJsYWJzLmlvMIGGBgNVHR8EfzB9\\r\\nMHugeaB3hnVodHRwczovL2h1ZHNvbi10ZW5hbnQtMDAxLnZpaS5hdTMwMS5tYXR0\\r\\ncmxhYnMuaW8vdjIvY3JlZGVudGlhbHMvbW9iaWxlL2lhY2FzL2VkNzQzMTllLTcy\\r\\nYTYtNDQwMS1iM2E1LTk0ZTk4MGZiZWJlYS9jcmwwCgYIKoZIzj0EAwIDSQAwRgIh\\r\\nAJxWGZvntq+hymL7zWwrlZo1Jz1+lWglu/MESdmUhTNFAiEAg+x5e3TzBxgHneIM\\r\\nVpTmZNOyZI3Hn17WRKkyKSg+5/8=\\r\\n-----END CERTIFICATE-----\\r\\n",
  • "certificateData": {
    }
}

Retrieve all trusted issuers

Retrieves all mDocs trusted issuers from your tenant.

Analytic events

  • MOBILE_CREDENTIAL_TRUSTED_ISSUER_RETRIEVE_LIST_START
  • MOBILE_CREDENTIAL_TRUSTED_ISSUER_RETRIEVE_LIST_SUCCESS
  • MOBILE_CREDENTIAL_TRUSTED_ISSUER_RETRIEVE_LIST_FAIL
Roles: ["admin","verifier"]
SecuritybearerAuth
Request
query Parameters
limit
number [ 1 .. 1000 ]
Default: 100

Range size of returned list.

Example: limit=2
cursor
string

Starting point for the list of entries.

Example: cursor=Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h
Responses
200

Trusted issuers retrieved

400

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

get/v2/credentials/mobile/trusted-issuers
Request samples 
Response samples 
application/json
{
  • "code": "string",
  • "type": "string",
  • "message": "string",
  • "details": [
    ]
}
Retrieve a trusted issuer
Retrieves an existing trusted issuer from your tenant by providing its ID.


Analytic events


    

  • MOBILE_CREDENTIAL_TRUSTED_ISSUER_RETRIEVE_START
    • 

  • MOBILE_CREDENTIAL_TRUSTED_ISSUER_RETRIEVE_SUCCESS
    • 

  • MOBILE_CREDENTIAL_TRUSTED_ISSUER_RETRIEVE_FAIL
    • 



Roles:  ["admin","verifier"]
SecuritybearerAuth 
Request 
path Parameters
id
required
string <uuid> 
Trusted issuer ID


 
 Example:  3948c40e-6e19-4ffc-933c-91f643f24264
Responses 
200
Trusted issuer retrieved


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


404
Not Found. The specified resource was not found.


get/v2/credentials/mobile/trusted-issuers/{id}
Request samples 
Response samples 
application/json
{
  • "id": "ed74319e-72a6-4401-b3a5-94e980fbebea",
  • "certificatePem": "-----BEGIN CERTIFICATE-----\\r\\nMIICUDCCAfWgAwIBAgIKVVqBlVonWFs3lTAKBggqhkjOPQQDAjAkMQswCQYDVQQG\\r\\nEwJOWjEVMBMGA1UEAwwMRXhhbXBsZSBJQUNBMB4XDTI0MDExMTAzMjYwMFoXDTM0\\r\\nMDEwODAzMjYwMFowJDELMAkGA1UEBhMCTloxFTATBgNVBAMMDEV4YW1wbGUgSUFD\\r\\nQTBZMBMGByqGSM49AgEGCCqGSM49AwEHA0IABOHxm9MYkCvIvZc/MyoWGul8+tla\\r\\nFSSRVkDllFERbO/Tg7DOj4CJfYrhDJEuV04eRgcowBDhr9W/bvnTMZMa/RijggEN\\r\\nMIIBCTASBgNVHRMBAf8ECDAGAQH/AgEAMA4GA1UdDwEB/wQEAwIBBjAdBgNVHQ4E\\r\\nFgQUpS3hOCbmCUwu8n91X9CLS682cOkwOwYDVR0SBDQwMoYwaHR0cHM6Ly9odWRz\\r\\nb24tdGVuYW50LTAwMS52aWkuYXUzMDEubWF0dHJsYWJzLmlvMIGGBgNVHR8EfzB9\\r\\nMHugeaB3hnVodHRwczovL2h1ZHNvbi10ZW5hbnQtMDAxLnZpaS5hdTMwMS5tYXR0\\r\\ncmxhYnMuaW8vdjIvY3JlZGVudGlhbHMvbW9iaWxlL2lhY2FzL2VkNzQzMTllLTcy\\r\\nYTYtNDQwMS1iM2E1LTk0ZTk4MGZiZWJlYS9jcmwwCgYIKoZIzj0EAwIDSQAwRgIh\\r\\nAJxWGZvntq+hymL7zWwrlZo1Jz1+lWglu/MESdmUhTNFAiEAg+x5e3TzBxgHneIM\\r\\nVpTmZNOyZI3Hn17WRKkyKSg+5/8=\\r\\n-----END CERTIFICATE-----\\r\\n",
  • "certificateData": {
    }
}
Delete a trusted issuer
Deletes an existing trusted issuer by providing its ID.


Analytic events


    

  • MOBILE_CREDENTIAL_TRUSTED_ISSUER_DELETE_START
    • 

  • MOBILE_CREDENTIAL_TRUSTED_ISSUER_DELETE_SUCCESS
    • 

  • MOBILE_CREDENTIAL_TRUSTED_ISSUER_DELETE_FAIL
    • 



Roles:  ["admin","verifier"]
SecuritybearerAuth 
Request 
path Parameters
id
required
string <uuid> 
Trusted issuer ID


 
 Example:  3948c40e-6e19-4ffc-933c-91f643f24264
Responses 
204
Trusted issuer deleted


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


404
Not Found. The specified resource was not found.


delete/v2/credentials/mobile/trusted-issuers/{id}
Request samples 
Response samples 
application/json
{
  • "code": "string",
  • "type": "string",
  • "message": "string",
  • "details": [
    ]
}
Create a verifier root CA certificate
Creates a verifier root CA certificate to be used as part of mDocs online verification workflows.


Analytic events


    

  • CREDENTIAL_PRESENTATION_VERIFIER_CA_CERTIFICATE_CREATE_START
    • 

  • CREDENTIAL_PRESENTATION_VERIFIER_CA_CERTIFICATE_CREATE_SUCCESS
    • 

  • CREDENTIAL_PRESENTATION_VERIFIER_CA_CERTIFICATE_CREATE_FAIL
    • 



Roles:  ["admin","verifier"]
SecuritybearerAuth 
Request 
Request Body schema: application/json
required
Verifier root CA certificate payload


commonName
string
 Default:  "{tenantDomain} Verifier"
Used to define the common name of the created verifier root CA certificate. Wallets that are implementing certificate-based trust should be paying extra attention to this value as it would be used by the user to establish trust with the verifier.


 
country
string
Used to define the ISO 31661 alpha-2 country code of the created verifier root CA certificate.


 
active
boolean
 Default:  true
Boolean determining whether or not the verifier root CA certificate is active and should be used during online verification flows. This can be used to support certificate rotation. As best practice it is not recommended to have multiple active verifier root CA certificates at the same time. If multiple active certificates do exist, the oldest one is used by default.


 
Responses 
200
Verifier root CA certificate created


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


post/v2/presentations/certificates/ca
Request samples 
application/json
{
  • "commonName": "{tenantDomain} Verifier",
  • "country": "string",
  • "active": true
}
Response samples 
application/json
{
  • "id": "string",
  • "certificatePem": "string",
  • "certificateFingerprint": "string",
  • "certificateData": {
    },
  • "active": true
}
Retrieve all verifier root CA certificates
Retrieves all existing verifier root CA certificates.


Analytic events


    

  • CREDENTIAL_PRESENTATION_VERIFIER_CA_CERTIFICATE_RETRIEVE_LIST_START
    • 

  • CREDENTIAL_PRESENTATION_VERIFIER_CA_CERTIFICATE_RETRIEVE_LIST_SUCCESS
    • 

  • CREDENTIAL_PRESENTATION_VERIFIER_CA_CERTIFICATE_RETRIEVE_LIST_FAIL
    • 



Roles:  ["admin","verifier"]
SecuritybearerAuth 
Responses 
200
Verifier root CA certificates retrieved


get/v2/presentations/certificates/ca
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "nextCursor": "string"
}
Update a verifier root CA certificate
Updates an existing verifier root CA certificate.


Analytic events


    

  • CREDENTIAL_PRESENTATION_VERIFIER_CA_CERTIFICATE_UPDATE_START
    • 

  • CREDENTIAL_PRESENTATION_VERIFIER_CA_CERTIFICATE_UPDATE_SUCCESS
    • 

  • CREDENTIAL_PRESENTATION_VERIFIER_CA_CERTIFICATE_UPDATE_FAIL
    • 



Roles:  ["admin","verifier"]
SecuritybearerAuth 
Request 
path Parameters
certificateId
required
string <uuid> 
Unique identifier for the verifier root CA certificate.


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


active
boolean
 Default:  true
Boolean determining whether or not the verifier root CA certificate is active and should be used during online verification flows. This can be used to support certificate rotation. As best practice it is not recommended to have multiple active verifier root CA certificates at the same time. If multiple active certificates do exist, the oldest one is used by default.


 
Responses 
200
Verifier root CA certificate updated


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


404
Not Found. The specified resource was not found.


put/v2/presentations/certificates/ca/{certificateId}
Request samples 
application/json
{
  • "active": true
}
Response samples 
application/json
{
  • "id": "string",
  • "certificatePem": "string",
  • "certificateFingerprint": "string",
  • "certificateData": {
    },
  • "active": true
}
Retrieve a verifier root CA certificate
Retrieves an existing verifier root CA certificate.


Analytic events


    

  • CREDENTIAL_PRESENTATION_VERIFIER_CA_CERTIFICATE_RETRIEVE_START
    • 

  • CREDENTIAL_PRESENTATION_VERIFIER_CA_CERTIFICATE_RETRIEVE_SUCCESS
    • 

  • CREDENTIAL_PRESENTATION_VERIFIER_CA_CERTIFICATE_RETRIEVE_FAIL
    • 



Roles:  ["admin","verifier"]
SecuritybearerAuth 
Request 
path Parameters
certificateId
required
string <uuid> 
Unique identifier for the verifier root CA certificate.


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


404
Not Found. The specified resource was not found.


get/v2/presentations/certificates/ca/{certificateId}
Request samples 
Response samples 
application/json
{
  • "id": "string",
  • "certificatePem": "string",
  • "certificateFingerprint": "string",
  • "certificateData": {
    },
  • "active": true
}
Delete a verifier root CA certificate
Deletes an existing verifier root CA certificate.


Analytic events


    

  • PRESENTATION_VERIFIER_CA_CERTIFICATE_DELETE_START
    • 

  • PRESENTATION_VERIFIER_CA_CERTIFICATE_DELETE_SUCCESS
    • 

  • PRESENTATION_VERIFIER_CA_CERTIFICATE_DELETE_FAIL
    • 



Roles:  ["admin","verifier"]
SecuritybearerAuth 
Request 
path Parameters
certificateId
required
string <uuid> 
Unique identifier for the verifier root CA certificate.


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


404
Not Found. The specified resource was not found.


delete/v2/presentations/certificates/ca/{certificateId}
Request samples 
Response samples 
application/json
{
  • "code": "string",
  • "type": "string",
  • "message": "string"
}
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.


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.


 
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": {},
  • "resultAvailableInFrontChannel": true,
  • "name": "Example Verifier Web Application"
}
Response samples 
application/json
{
  • "type": "web",
  • "domain": "example-verifier-web-application.com",
  • "additionalDomains": [
    ],
  • "openid4vpConfiguration": {},
  • "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.


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.


 
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": {},
  • "resultAvailableInFrontChannel": true,
  • "name": "Example Verifier Web Application"
}
Response samples 
application/json
{
  • "type": "web",
  • "domain": "example-verifier-web-application.com",
  • "additionalDomains": [
    ],
  • "openid4vpConfiguration": {},
  • "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": {},
  • "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",
  • "type": "string",
  • "message": "string"
}
Create wallet provider
Creates a wallet provider that can present mDocs for online verification.


Analytic events


    

  • CREDENTIAL_PRESENTATION_WALLET_PROVIDER_CREATE_START
    • 

  • CREDENTIAL_PRESENTATION_WALLET_PROVIDER_CREATE_SUCCESS
    • 

  • CREDENTIAL_PRESENTATION_WALLET_PROVIDER_CREATE_FAIL
    • 



Roles:  ["admin","verifier"]
SecuritybearerAuth 
Request 
Request Body schema: application/json
required
Wallet provider payload


name
required
string
Unique identifier for the wallet. This field is compared against the wallet identifier defined in the request by the Verifier Web SDK. Value must be unique amongst configured wallet providers on your tenant.


 
required
object
 
Responses 
200
Wallet provider created


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


post/v2/presentations/wallet-providers
Request samples 
application/json
{
  • "name": "Example wallet provider",
  • "openid4vpConfiguration": {
    }
}
Response samples 
application/json
{
  • "id": "e63a2e46-5afa-48f9-bcc2-2114cf5f331b",
  • "name": "Example wallet provider",
  • "openid4vpConfiguration": {
    }
}
Retrieve all wallet providers
Retrieves all existing wallet providers that can present mDocs for online verification.


Analytic events


    

  • CREDENTIAL_PRESENTATION_WALLET_PROVIDER_RETRIEVE_LIST_START
    • 

  • CREDENTIAL_PRESENTATION_WALLET_PROVIDER_RETRIEVE_LIST_SUCCESS
    • 

  • CREDENTIAL_PRESENTATION_WALLET_PROVIDER_RETRIEVE_LIST_FAIL
    • 



Roles:  ["admin","verifier"]
SecuritybearerAuth 
Responses 
200
Wallet providers retrieved


get/v2/presentations/wallet-providers
Request samples 
Response samples 
application/json
[
  • {
    }
]
Update a wallet provider
Updates an existing wallet provider that can present mDocs for online verification.


Analytic events


    

  • CREDENTIAL_PRESENTATION_WALLET_PROVIDER_UPDATE_START
    • 

  • CREDENTIAL_PRESENTATION_WALLET_PROVIDER_UPDATE_SUCCESS
    • 

  • CREDENTIAL_PRESENTATION_WALLET_PROVIDER_UPDATE_FAIL
    • 



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


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


name
required
string
Unique identifier for the wallet. This field is compared against the wallet identifier defined in the request by the Verifier Web SDK. Value must be unique amongst configured wallet providers on your tenant.


 
required
object
 
Responses 
200
Wallet provider updated


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


404
Not Found. The specified resource was not found.


put/v2/presentations/wallet-providers/{walletProviderId}
Request samples 
application/json
{
  • "name": "Example wallet provider",
  • "openid4vpConfiguration": {
    }
}
Response samples 
application/json
{
  • "id": "e63a2e46-5afa-48f9-bcc2-2114cf5f331b",
  • "name": "Example wallet provider",
  • "openid4vpConfiguration": {
    }
}
Retrieve a wallet provider
Retrieves an existing wallet provider that can present mDocs for online verification.


Analytic events


    

  • CREDENTIAL_PRESENTATION_WALLET_PROVIDER_RETRIEVE_START
    • 

  • CREDENTIAL_PRESENTATION_WALLET_PROVIDER_RETRIEVE_SUCCESS
    • 

  • CREDENTIAL_PRESENTATION_WALLET_PROVIDER_RETRIEVE_FAIL
    • 



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


 
 Example:  281d20b3-42a3-40dd-b29a-115ff32b02b7
Responses 
200
Wallet provider retrieved


404
Not Found. The specified resource was not found.


get/v2/presentations/wallet-providers/{walletProviderId}
Request samples 
Response samples 
application/json
{
  • "id": "e63a2e46-5afa-48f9-bcc2-2114cf5f331b",
  • "name": "Example wallet provider",
  • "openid4vpConfiguration": {
    }
}
Delete a wallet provider
Deletes an existing wallet provider that can present mDocs for online verification.


Analytic events


    

  • PRESENTATION_WALLET_PROVIDER_DELETE_START
    • 

  • PRESENTATION_WALLET_PROVIDER_DELETE_SUCCESS
    • 

  • PRESENTATION_WALLET_PROVIDER_DELETE_FAIL
    • 



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


 
 Example:  281d20b3-42a3-40dd-b29a-115ff32b02b7
Responses 
204
Wallet provider deleted


404
Not Found. The specified resource was not found.


delete/v2/presentations/wallet-providers/{walletProviderId}
Request samples 
Response samples 
application/json
{
  • "code": "string",
  • "type": "string",
  • "message": "string"
}
Retrieve presentation session result
Retrieves the result of an online presentation session by providing the session's ID.


Analytic events


    

  • CREDENTIAL_PRESENTATION_SESSION_RESULT_RETRIEVE_START
    • 

  • CREDENTIAL_PRESENTATION_SESSION_RESULT_RETRIEVE_SUCCESS
    • 

  • CREDENTIAL_PRESENTATION_SESSION_RESULT_RETRIEVE_FAIL
    • 



SecuritybearerAuth 
Request 
path Parameters
sessionId
required
string <uuid> 
Session ID


 
Responses 
200
Session result retrieved


404
Not Found. The specified resource was not found.


get/v2/presentations/sessions/{sessionId}/result
Request samples 
Response samples 
application/json
{
  • "sessionId": "string",
  • "challenge": "string",
  • "credentialQuery": [
    ],
  • "error": {
    }
}
➔ Next to CWT credentials PDF templates