Specifies paths and operations for managing Verifier root CA certificates for mDocs verification.
Create a verifier root CA certificate
Creates a verifier root CA certificate to be used as part of mDocs online verification workflows.
- A maximum of three Verifier root CA certificates can be created per tenant.
Analytic events
- CREDENTIAL_PRESENTATION_VERIFIER_CA_CERTIFICATE_CREATE_START
- CREDENTIAL_PRESENTATION_VERIFIER_CA_CERTIFICATE_CREATE_SUCCESS
- CREDENTIAL_PRESENTATION_VERIFIER_CA_CERTIFICATE_CREATE_FAIL
Request Body schema: application/jsonrequired
Verifier root CA certificate payload
Verifier root CA certificate created
Bad Request. The request was malformed or missing required parameters.
Maximum number of verifier root certificates reached. Please delete an existing certificate before creating a new one.
- Payload
- curl
- Node.js
- JavaScript
- Python
- C#
- Java
{- "commonName": "{tenantDomain} Verifier",
- "country": "string",
- "active": true
}
- 200
- 400
- 409
{- "id": "string",
- "certificatePem": "string",
- "certificateFingerprint": "string",
- "certificateData": {
- "commonName": "string",
- "country": "string",
- "notAfter": "string",
- "notBefore": "string"
}, - "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
Verifier root CA certificates retrieved
- curl
- Node.js
- JavaScript
- Python
- C#
- Java
- 200
{- "data": [
- {
- "id": "string",
- "certificatePem": "string",
- "certificateFingerprint": "string",
- "certificateData": {
- "commonName": "string",
- "country": "string",
- "notAfter": "string",
- "notBefore": "string"
}, - "active": true
}
], - "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
path Parameters
Request Body schema: application/jsonrequired
Verifier root CA certificate payload
Verifier root CA certificate 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
{- "active": true
}
- 200
- 400
- 404
{- "id": "string",
- "certificatePem": "string",
- "certificateFingerprint": "string",
- "certificateData": {
- "commonName": "string",
- "country": "string",
- "notAfter": "string",
- "notBefore": "string"
}, - "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
Verifier root CA certificate retrieved
Not Found. The specified resource was not found.
- curl
- Node.js
- JavaScript
- Python
- C#
- Java
- 200
- 404
{- "id": "string",
- "certificatePem": "string",
- "certificateFingerprint": "string",
- "certificateData": {
- "commonName": "string",
- "country": "string",
- "notAfter": "string",
- "notBefore": "string"
}, - "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
Verifier root CA certificate 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"
}
]
}