Skip to Content
GuidesRetrieve a policy

How to retrieve policies

Relying parties can retrieve Ecosystem policies to check whether:

  • An issuer is allowed to issue a certain credential type in the ecosystem.
  • A verifier is allowed to verify a certain credential type in the ecosystem.

Once the policy is retrieved, relying parties can apply their own business logic based when applying the policy rules and permissions.

Retrieve a policy

Request

Make a request of the following structure to retrieve the latest Ecosystem’s Policy:

HTTP
GET /v1/ecosystems/{ecosystemId}/policies/public/latest
  • ecosystemId : Unique identifier for the ecosystem you want to retrieve the policy from. Use the ecosystem unique id obtained when you created the ecosystem.

Response

JSON
{ "policyModifiedAt": "2023-10-17T00:00:00Z", "policyPublishedAt": "2024-10-22T00:00:00Z", "credentials": { "599bf148-d711-405a-a20b-9c8a87ac8850": { "id": "599bf148-d711-405a-a20b-9c8a87ac8850", "ecosystemId": "87880d7e-a4d0-462e-8383-3f1e5e16865d", "profile": "compact", "type": "DriverLicense", "name": "Driver's License" } }, "participants": { "a24e391a-c27f-4b6e-9805-1ee7e03f3c58": { "id": "a24e391a-c27f-4b6e-9805-1ee7e03f3c58", "ecosystemId": "87880d7e-a4d0-462e-8383-3f1e5e16865d", "name": "My Participant", "identifiers": { "web-semantic": "did:web:example.com", "compact-semantic": "did:web:example.com", "compact": "did:web:example.com", "mobile": [ "-----BEGIN CERTIFICATE-----\r\nMIIBwzCCAWigAwIBAgIKRGC+CqoTGJKkkTAKBggqhkjOPQQDAjAgMR4wCQYDVQQG\r\nEwJOWjARBgNVBAMTCk1BVFRSIElBQ0EwHhcNMjMwODA4MDAwOTIxWhcNMzMwODA1\r\nMDAwOTIxWjAgMR4wCQYDVQQGEwJOWjARBgNVBAMTCk1BVFRSIElBQ0EwWTATBgcq\r\nhkjOPQIBBggqhkjOPQMBBwNCAASRu69fzdgM4odkyPtRcZd3eGWCw4BB7StZNGRm\r\nuIlrraUyv9SWPHgUYjYmRB1g7ERzj/pOSAspk71Y+QA+j9nPo4GJMIGGMBIGA1Ud\r\nEwEB/wQIMAYBAf8CAQMwDgYDVR0PAQH/BAQDAgAGMB0GA1UdDgQWBBSONcHGh4If\r\nO1dYorRpsuFrs+f8SDAcBgNVHRIEFTATgRFpbmZvQG1hdHRyLmdsb2JhbDAjBgNV\r\nHR8EHDAaMBiiFoYUaHR0cHM6Ly9tYXR0ci5nbG9iYWwwCgYIKoZIzj0EAwIDSQAw\r\nRgIhAPKJIGDSvp7VxRBLCWWeghqi8UUeO+dZsC49TUZcDMNxAiEAoh+7dT+l+GzX\r\nk0J2SoGmPiagrbAuIYyTHwzZZuYr1W4=\r\n-----END CERTIFICATE-----\r\n" ] }, "isIssuer": true, "isVerifier": true, "isIssuerConstrained": true, "isVerifierConstrained": true, "status": "Active", "country": "US", "stateOrProvince": "US-AL", "contacts": [ { "phoneNumber": "012-3456789", "address": "Participant address" } ], "issuerAllowedCredentials": [ "e0a07846-44e1-41a4-b704-1ccf6eb1a5af", "25fa6ffc-bf6e-417c-865c-96fcf1d7d1a3" ], "verifierAllowedCredentials": [ "4e25a240-76bb-4e9f-9f93-b93be287922b", "daca4a43-3ff9-4ecb-93fe-d9104e36bf74" ] } } }
  • policyModifiedAt : Indicates when the policy was last modified.
  • policyPublishedAt : Indicates when the policy was published.
  • credentials : This array includes all the credential types that are valid in this ecosystem.
  • participants : This array includes all the participants that exist in this ecosystem. Refer to the create a participant guide for a complete description of the different fields in this object.
    • issuerAllowedCredentials : This array includes the identifiers of all the credential types that were assigned to this participant as an issuer.
    • verifierAllowedCredentials : This array includes the identifiers of all the credential types that were assigned to this participant as a verifier.
Last updated on