How to retrieve a VICAL

When an Ecosystem operator creates a VICAL from the ecosystem issuer’s policy, relying parties can retrieve it via unauthenticated endpoints.

Retrieve the latest VICAL

Make a request of the following structure to retrieve the latest version of the VICAL:

Request

GET /v1/ecosystems/{ecosystemId}/vicals/public/latest

• ecosystemId : Policies are created within a specific ecosystem. Use the ecosystem unique id obtained when you created the ecosystem.

Response

The response includes the VICAL as a cbor file. Refer to the VICAL section of the Docs for more information regarding the VICAL data structure.

Retrieve a specific VICAL

Ecosystem operators can have different versions of the VICAL available on their MATTR VII tenant, and these versions are available for relying parties to retrieve.

Make a request of the following structure to retrieve a specific VICAL version:

Request

GET /v1/ecosystems/{ecosystemId}/vicals/public/{vicalIssueId}

• ecosystemId : Policies are created within a specific ecosystem. Use the ecosystem unique id obtained when you created the ecosystem.
• vicalIssueID : Unique identifier of this created VICAL. This can be retrieved from the response when creating a VICAL and made available to relying parties out-of-band.

Response

The response includes the VICAL as a cbor file. Refer to the VICAL section of the Docs for more information regarding the VICAL data structure.