General
Create a VICAL
Creates a Verified Issuer Certificate Authority List (VICAL) based on the policy of the requested ecosystem. Refer to VICAL to learn more about the VICAL purpose and data structure.
Roles
bearerAuthAuthorizationBearer <token>ecosystemId*stringThe UUID of the ecosystem
uuidVICAL created
application/json- response
vicalIssueID*integerUnique identifier of a specific VICAL version. This numeric value is continuously increased whenever a VICAL is created.
int32date*stringDate and time of VICAL issuance.
date-timecurl -X POST "https://example.com/v1/ecosystems/87880d7e-a4d0-462e-8383-3f1e5e16865d/vicals"{ "vicalIssueID": 1337, "date": "2024-07-28T23:01:13.000Z"}Retrieve all VICALs
Retrieves all VICALs available in the requested ecosystem.
This endpoint is intended for public consumption, and as such does not require authentication.
ecosystemId*stringThe UUID of the ecosystem
uuidlimit?numberRange size of returned list.
1 <= value <= 1000100cursor?stringStarting point for the list of entries.
VICALs retrieved
application/json- response
data?array<>nextCursor?nextCursorStarting point for next cursor to use in a paginated list.
curl -X GET "https://example.com/v1/ecosystems/87880d7e-a4d0-462e-8383-3f1e5e16865d/vicals/public"{ "data": [ { "vicalIssueID": 1337, "date": "2024-07-28T23:01:13.000Z", "filename": "vical-2024-07-28-1722164473000.cbor", "isAutoPublished": false } ], "nextCursor": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1hNjZmZmVhNS04NDhlLTQzOWQtODBhNC1kZGE1NWY1M2UzNmM"}Retrieve a VICAL
Retrieves a specific VICAL from the requested ecosystem by providing the VICAL version identifier.
This endpoint is intended for public consumption, and as such does not require authentication.
ecosystemId*stringThe UUID of the ecosystem
uuidvicalIssueId*integerUnique identifier of a specific VICAL version. This numeric value is continuously increased whenever a VICAL is created.
int32VICAL retrieved
response?fileapplication/cborbinarycurl -X GET "https://example.com/v1/ecosystems/87880d7e-a4d0-462e-8383-3f1e5e16865d/vicals/public/1337""string"Retrieve latest VICAL
Retrieves the latest VICAL from the requested ecosystem.
This endpoint is intended for public consumption, and as such does not require authentication.
ecosystemId*stringThe UUID of the ecosystem
uuidVICAL retrieved
response?fileapplication/cborbinarycurl -X GET "https://example.com/v1/ecosystems/87880d7e-a4d0-462e-8383-3f1e5e16865d/vicals/public/latest""string"Delete a VICAL
Deletes a specific VICAL from the requested ecosystem by providing the VICAL version identifier. Deleting a VICAL also deletes the issuer policy published from it, if one exists. This action cannot be undone.
A 404 is only returned when the ecosystem does not exist. Deleting a vicalIssueId that does
not exist within an existing ecosystem still returns 204.
Roles
Analytics Events
bearerAuthAuthorizationBearer <token>ecosystemId*stringThe UUID of the ecosystem
uuidvicalIssueId*integerUnique identifier of a specific VICAL version. This numeric value is continuously increased whenever a VICAL is created.
int32VICAL deleted
curl -X DELETE "https://example.com/v1/ecosystems/87880d7e-a4d0-462e-8383-3f1e5e16865d/vicals/1337"How would you rate this page?
Last updated on