General
Create a RICAL
Creates a Reader Identity Certificate Authority List (RICAL) based on the policy of the requested ecosystem.
A RICAL configuration is required in order for RICALs to be created.
Roles
Analytics Events
bearerAuthAuthorizationBearer <token>ecosystemId*stringThe UUID of the ecosystem
uuidRICAL created
application/json- response
ricalIssueID*integerUnique identifier of a specific RICAL version. This numeric value is continuously increased whenever a RICAL is created.
int32date*stringDate and time of RICAL issuance.
date-timecurl -X POST "https://example.com/v1/ecosystems/87880d7e-a4d0-462e-8383-3f1e5e16865d/ricals"{ "ricalIssueID": 1337, "date": "2024-07-28T23:01:13.000Z"}Retrieve all RICALs
Retrieves all RICALs available in the requested ecosystem.
The response is a JSON list of the published RICALs and their version identifiers. To download an actual RICAL file (a CBOR encoded file matching the RICAL format defined in ISO/IEC 18013-5), call the Retrieve specific RICAL or Retrieve latest RICAL endpoint.
This endpoint is intended for public consumption, and as such does not require authentication.
Analytics Events
ecosystemId*stringThe UUID of the ecosystem
uuidlimit?numberRange size of returned list.
1 <= value <= 1000100cursor?stringStarting point for the list of entries.
RICALs 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/ricals/public"{ "data": [ { "ricalIssueID": 1337, "date": "2024-07-28T23:01:13.000Z", "filename": "rical-2024-07-28-1722164473000.cbor", "isAutoPublished": false } ], "nextCursor": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1hNjZmZmVhNS04NDhlLTQzOWQtODBhNC1kZGE1NWY1M2UzNmM"}Retrieve a RICAL
Retrieves a specific RICAL from the requested ecosystem by providing the RICAL version identifier.
The response is a CBOR encoded file matching the RICAL format defined in ISO/IEC 18013-5.
This endpoint is intended for public consumption, and as such does not require authentication.
Analytics Events
ecosystemId*stringThe UUID of the ecosystem
uuidricalIssueId*integerUnique identifier of a specific RICAL version. This numeric value is continuously increased whenever a RICAL is created.
int32RICAL retrieved
response?fileapplication/cborbinarycurl -X GET "https://example.com/v1/ecosystems/87880d7e-a4d0-462e-8383-3f1e5e16865d/ricals/public/1337""string"Retrieve latest RICAL
Retrieves the latest RICAL from the requested ecosystem.
The response is a CBOR encoded file matching the RICAL format defined in ISO/IEC 18013-5.
This endpoint is intended for public consumption, and as such does not require authentication.
Analytics Events
ecosystemId*stringThe UUID of the ecosystem
uuidRICAL retrieved
response?fileapplication/cborbinarycurl -X GET "https://example.com/v1/ecosystems/87880d7e-a4d0-462e-8383-3f1e5e16865d/ricals/public/latest""string"Delete a RICAL
Deletes a specific RICAL from the requested ecosystem by providing the RICAL version identifier. Deleting a RICAL also deletes the verifier 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 ricalIssueId that does
not exist within an existing ecosystem still returns 204.
Roles
Analytics Events
bearerAuthAuthorizationBearer <token>ecosystemId*stringThe UUID of the ecosystem
uuidricalIssueId*integerUnique identifier of a specific RICAL version. This numeric value is continuously increased whenever a RICAL is created.
int32RICAL deleted
curl -X DELETE "https://example.com/v1/ecosystems/87880d7e-a4d0-462e-8383-3f1e5e16865d/ricals/1337"How would you rate this page?
Last updated on