Home for all content related to the SSI Service.
Service documentation is focused on explaining the "whys" and "hows" of the SSI Service. It is intended to be a resource for developers and users of the SSI Service.
| Resource | Description |
|---|---|
| Vision | Describes the vision for the service |
| Versioning | Describes versioning practices for the service |
| Webhooks | Describes how to use webhooks in the service |
| Features | Features currently supported by the service |
All feature proposal documents for the SSI Service follow a common format and are known as SSI Improvement Proposals or SIPs. SIPs have their own documentation which can be found here
There are a few ways to configure the service. There are a few choices you can make, including which database to use, which DID methods to enable, and which port to listen on. Read the docs below for more details!
| Resource | Description |
|---|---|
| TOML Config Files | Describes how to use TOML config files |
| Using a Cloud Key Management Service | Describes how to configure a KMS |
| Storage | Describes alternatives for storage by the service |
| Authorization | How to setup token authentication and extend for authorization |
API documentation is generated using Swagger. The most recent API docs file can be found here, which can be pasted into the Swagger Editor for interaction.
When running the service you can find API documentation at: http://localhost:8080/swagger/index.html
Note: Your port may differ; swagger docs are hosted on the same endpoint as the ssi service itself.
How to documentation is focused on explaining usage of the SSI Service. It is intended to be a resource for users of the service to get up to speed with its functionality.
| Resource | Description |
|---|---|
| Creating a DID | Get started with DID functionality |
| Creating a Schema | Get started with schema functionality |
| Issuing a Credential | Get started with credential issuance functionality |
| Verify a Credential | Get started with credential verification functionality |
| Revoke/Suspend a Credential | Get started with credential status functionality |
| [TODO] Requesting and Verifying Credentials with Presentation Exchange | Get started with Presentation Exchange functionality |
| [TODO] Accepting Applications for and Issuing Credentials using Credential Manifest | Get started with Credential Manifest functionality |
| Link your DID with a Website | Get started with DID Well Known functionality |
| Creating a DID Web Identifier | Get started with did:web |