Learn

Verifier root CA certificates

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

Verifier root CA certificate payload

One of:

Request payload for managed verifier root CA certificate

commonName
string
Default: "{tenantDomain} Verifier"

Used to define the common name of the created verifier root CA certificate. Used to establish trust with the verifier by wallets that implement certificate-based trust.

  • When provided, the value must be a valid PrintableString and cannot be an empty string.
  • If not provided and a custom domain is configured and verified, the custom domain is used followed by the word IACA.
  • If no custom domain is configured, the tenant subdomain is used instead.
country
string

Indicates the verifier's country. If not provided, a country is selected based on the region of the tenant subdomain cloud host. When specified, the value must be a valid Alpha 2 country code as per ISO 3166-1.

notBefore
string <date-time>

Used to set the date and time when the Verifier root CA certificate becomes valid and can be used to sign other intermediate certificates.

  • Must not be in the past.
  • Must be before notAfter.
notAfter
string <date-time>

Used to set the date and time when the Verifier root CA certificate expires.

  • If not provided, calculated as notBefore + 20 years.
  • If not provided and notBefore is not provided, calculated as time of creation + 20 years.
  • Maximum value is 20 years from creation.
  • Must be after notBefore, if provided.
Responses
200

Verifier root CA certificate created

400

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

409

Maximum number of verifier root certificates reached. Please delete an existing certificate before creating a new one.

post/v2/presentations/certificates/ca
Request samples
application/json
{
  • "commonName": "{tenantDomain} Verifier",
  • "country": "string",
  • "notBefore": "2019-08-24T14:15:22Z",
  • "notAfter": "2019-08-24T14:15:22Z"
}
Response samples
application/json
{
  • "id": "string",
  • "certificatePem": "-----BEGIN CERTIFICATE-----\nMIIDXTCCAkWgAwIBAgIJAL5...\n-----END CERTIFICATE-----",
  • "certificateFingerprint": "a3b2c1d4e5f60718293a4b5c6d7e8f90123456789abcdef0123456789abcdef0",
  • "certificateData": {
    },
  • "active": true,
  • "isManaged": 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
required
boolean
 Default:  true
Indicates if the Verifier root CA certificate is active. Only active certificates can be used to sign other intermediate certificates.


 
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": "-----BEGIN CERTIFICATE-----\nMIIDXTCCAkWgAwIBAgIJAL5...\n-----END CERTIFICATE-----",
  • "certificateFingerprint": "a3b2c1d4e5f60718293a4b5c6d7e8f90123456789abcdef0123456789abcdef0",
  • "certificateData": {
    },
  • "active": true,
  • "isManaged": 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": "-----BEGIN CERTIFICATE-----\nMIIDXTCCAkWgAwIBAgIJAL5...\n-----END CERTIFICATE-----",
  • "certificateFingerprint": "a3b2c1d4e5f60718293a4b5c6d7e8f90123456789abcdef0123456789abcdef0",
  • "certificateData": {
    },
  • "active": true,
  • "isManaged": 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",
  • "message": "string",
  • "details": [
    ]
}
➔ Next to Verification request signers