The VCSL (Verifier Credential Status List) system addresses the need in the verifiable credentials domain for a mechanism to verify the validity or revocation status of credentials. Utilizing a bit array structure, where each bit signifies the status of a verifiable credential (0 for valid, 1 for revoked), the system employs persistence methods like IPFS, blockchain, and an SQL database. It enables issuers to create, manipulate, and query bit arrays, offering flexibility for direct issuer system queries or decentralized solutions through IPFS, providing a comprehensive approach to credential verification.
This is the main component, is the one that has all the endpoints for the issuer to admin the system, and for any issuer to query about some VCSL.
This is an API fot the IPFS component of the system. It controls the uploading and naming on IPNS.
This is the SQL solution for a database in the system
This Redis service is used for locks
- Path:
/health-check - HTTP Method:
GET - Summary: Health Check
- Request:
- No request parameters
- Path:
/bit-array - HTTP Method:
PUT - Summary: Create Bit Array
- Request:
- No request parameters
- Path:
/bit-array/{uuid} - HTTP Method:
GET - Summary: Get Compressed Bit Array
- Request:
- Path Parameters:
uuid(string, required)
- Path Parameters:
- Path:
/bit-array/{uuid}/free - HTTP Method:
GET - Summary: Get Free Bits
- Request:
- Path Parameters:
uuid(string, required)
- Path Parameters:
- Path:
/bit-array/{uuid}/index - HTTP Method:
PUT - Summary: Acquire Index
- Request:
- Path Parameters:
uuid(string, required)
- Path Parameters:
- Path:
/bit-array/{uuid}/{index} - HTTP Method:
POST - Summary: Flip Bit
- Request:
- Path Parameters:
uuid(string, required)index(integer, required)
- Path Parameters:
- Path:
/web3/issuer-url - HTTP Method:
GET - Summary: Get Issuer Url
- Request:
- No request parameters
- Path:
/web3/issuer-url - HTTP Method:
POST - Summary: Set Issuer Url
- Request:
- Request Body:
- Content Type:
application/json- Schema:
{ 'url': string }
- Content Type:
- Request Body:
- Path:
/web3/vcsl - HTTP Method:
POST - Summary: Add Vcsl
- Request:
- Request Body:
- Content Type:
application/json- Schema:
{ 'id': string, 'ipns': string }
- Content Type:
- Request Body:
- Path:
/web3/vcsl/{id} - HTTP Method:
GET - Summary: Get Vcsl
- Request:
- Path Parameters:
id(string, required) VCSL
- Path Parameters: