Reference implementation for BloomIQ aggregator (model for credit reporting-like services on the Bloom Protocol). The purpose of the BloomIQ aggregator functionality is to allow an intermediate data aggregator to issue verifiable credentials as to the completeness of VCs issued for a particular subject within a particular span of time, optionally categorized with string-based tags.
All API endpoints are signature-based and designed to isolate the exact criteria of the request to prevent replay attacks.
Associations pertain to subject consent for the aggregator to store aggregation data on their behalf.
The subject declares their consent for the aggregator to store aggregation data, pertaining to specific criteria such as a range of dates and specific VC tags.
The subject requests a list of all associations registered to their DID.
The subject requests a specific association.
The subject revokes a specific association.
Reporters are permitted by a subject to report on them. The intention is to require the subject to consent to a reporter to issue VCs regarding them, generally as a precondition to entering into a relationship with them (outside of the scope of the aggregator). The final VC issued by a reporter should be an end-of-relationship consent, otherwise if the subject issues a revocation prematurely it may be a negative signal indicating they were trying to prevent negative data from being reported about them.
The subject permits a reporter to report data about them.
The subject requests a lists reporters permitted to report about them.
The subject queries to see if a specific reporter can report about them.
The subject revokes permission for a reporter to report about them.
The report API pertains to specific reports (VCs) filed about a given subject.
The reporter issues a report about a subject.
The reporter revokes a report about a subject.
The reporter requests reports provided by themself.
The reporter requests a specific report provided by themself.
The subject requests reports provided about themself.
The subject requests a specific report provided about themself.
The VC API is used by the subject to request VCs from aggregator regarding the completeness of a given query. This may be used to show the completeness of a set of VCs issued about the subject within a given time and/or pertaining to specific tags.
The subject requests a VC issued about them, with optional date constraints and tag queries. The VC may be used to demonstrate the completeness of VCs issued about the subject, with regard to specific sets of tags, within any open or closed interval of time.
The subject may list all VCs previously issued by the aggregator about them.
The subject may request a specific VC issued about them.
The subject may delete a specific VC issued about them.