light-mode-image
Learn
API ReferenceVerifier Policy

Retrieve verifier policy preview

Roles

admindts-provider

Analytics Events

ECOSYSTEM_VERIFIER_POLICY_PREVIEW_RETRIEVE_STARTECOSYSTEM_VERIFIER_POLICY_PREVIEW_RETRIEVE_SUCCESSECOSYSTEM_VERIFIER_POLICY_PREVIEW_RETRIEVE_FAIL
GET/v1/ecosystems/{ecosystemId}/verifier-policies/preview

Retrieves an ecosystem verifier policy preview by providing the ecosystem's ID. A policy preview includes all the participants and their verifier certificates created in the ecosystem, including those that fail validation and would be excluded from a published policy. The validation result is provided for each certificate.

Analytic events

  • ECOSYSTEM_VERIFIER_POLICY_PREVIEW_RETRIEVE_START
  • ECOSYSTEM_VERIFIER_POLICY_PREVIEW_RETRIEVE_SUCCESS
  • ECOSYSTEM_VERIFIER_POLICY_PREVIEW_RETRIEVE_FAIL

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

ecosystemId*string

The UUID of the ecosystem

Formatuuid

Response Body

application/json

application/json

application/json

curl -X GET "https://example.vii.au01.mattr.global/v1/ecosystems/87880d7e-a4d0-462e-8383-3f1e5e16865d/verifier-policies/preview"
{
  "publishedAt": "2024-10-22T00:00:00Z",
  "participants": [
    {
      "id": "a24e391a-c27f-4b6e-9805-1ee7e03f3c58",
      "name": "My Participant",
      "status": "Active",
      "verifierCertificates": [
        {
          "id": "599bf148-d711-405a-a20b-9c8a87ac8850",
          "certificatePem": "-----BEGIN CERTIFICATE-----\r\nMIIBwzCCAWigAwIBAgIKRGC+CqoTGJKkkTAKBggqhkjOPQQDAjAgMR4wCQYDVQQG\r\n-----END CERTIFICATE-----\r\n",
          "certificateFingerprint": "a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6e7f8a9b0c1d2e3f4a5b6c7d8e9f0a1b2",
          "status": "Active",
          "validationResult": {
            "validated": true
          }
        }
      ],
      "country": "NZ",
      "stateOrProvince": "Wellington"
    }
  ]
}
{
  "code": "string",
  "message": "string",
  "details": [
    {
      "value": "string",
      "msg": "Invalid value",
      "param": "id",
      "location": "body"
    }
  ]
}
{
  "code": "string",
  "message": "string",
  "details": [
    {
      "value": "string",
      "msg": "Invalid value",
      "param": "id",
      "location": "body"
    }
  ]
}

How would you rate this page?

Publish verifier policy POST

Publish a new version of the ecosystem verifier policy. A participant is included only if it is active and has at least one verifier certificate that passes validation. Only the certificates that pass validation are included. ### **Analytic events** * ECOSYSTEM_VERIFIER_POLICY_CREATE_START * ECOSYSTEM_VERIFIER_POLICY_CREATE_SUCCESS * ECOSYSTEM_VERIFIER_POLICY_CREATE_FAIL

Retrieve latest verifier policy GET

Retrieves the latest published ecosystem verifier policy by providing the ecosystem ID. This endpoint is intended for public consumption, and as such does not require authentication. ### **Analytic events** * ECOSYSTEM_VERIFIER_POLICY_RETRIEVE_LATEST_START * ECOSYSTEM_VERIFIER_POLICY_RETRIEVE_LATEST_SUCCESS * ECOSYSTEM_VERIFIER_POLICY_RETRIEVE_LATEST_FAIL