Getting Started

Prepare base URL

Your Issuer API environment is entirely managed by nChain's Product Suite Platform (PSP), so there is nothing to worry about setting up the technology stack. You will receive the Issuer API Base URL for your environment. The Issuer API uses a single base URL to standardize all endpoints.

To check if your Issuer API Base URL is valid, you can visit the Ping-Pong website at GET <BASE_URL>/ping

Authentication

TODO: ApiKey

Authorization: Bearer <ACCESS_TOKEN>

Authorization

The Issuer API uses role-based access control (RBAC) to manage permissions. Authorization is enforced using the cognito:groups claim in the JWT access token, which specifies the user’s assigned claims. These permissions determine what actions the user can perform within the API.

Supported Roles

• Issuer Admin - can view and issue verifiable credentials, can view the history of issued credentials, can revoke credentials & more

• Issuer Auditor - can view the history of issued credentials, can revoke credentials & more