sideos API Documentation
  • Welcome!
  • Quick Start
  • Sign up & get started
    • Creating a Credential Type
    • Add an Admin
  • Issue a Verifiable Credential
  • How to delete your Data
  • Reference
    • API Reference
      • Offer Credentials
      • Request Credentials
      • Templates
      • Wallets
Powered by GitBook
On this page
  • Offer Credentials
  • Request Credentials
  • Templates
  1. Reference

API Reference

The sideos API reference

PreviousHow to delete your DataNextOffer Credentials

Last updated 1 year ago

Dive into the specifics of each API endpoint by checking out our complete documentation.

Offer Credentials

If an organisation wants to provide credentials to users, e.g. as a login credential, the organisation can use the sideos API to create Verifiable Credentials and offer these Verifiable Credentials to their users to be stored in their SSI Wallet.

Request Credentials

If an organisation wants to get verifiable data from a user, e.g. to authenticate a web user, the organisation can use the sideos API to create a request for Verifiable Credentials from an SSI wallet. If the SSI wallet has the requested credential types available, it will respond with the verifiable credentials if authorised by the user.

Templates

In the calls to create Credential Request or Credential Offer is a reference to the respective credential type by its ID. You can call the API to get the type definition of a certain template.

Offer Credentials
Request Credentials
Templates