Getting Started

Prepare base URL

The Verifier API environment is fully managed by TNG's Product Suite Platform (PSP), eliminating the need for you to set up or maintain the underlying technology stack. You will be provided with the Verifier API Base URL specific to your environment. The API utilizes a single, standardized base URL for all endpoints, ensuring consistency and simplicity in integration.

$API_KEY=INSERT_YOUR_API_KEY_HERE # the API key assigned to you via Issuer portal
$IDENTITY_ENV_ID=426f1ce15bf3df70 # the unique idenitifer for your env
$VERIFIER_API_BASE_URL=https://identity.nchainplatform.com/products/web/$IDENTITY_ENV_ID/verifier/api

To check if your Verifier API Base URL is valid, you can visit the Ping-Pong website at GET $VERIFIER_API_BASE_URL/ping

Authentication

The API supports API Key authentication providing the following header

X-API-KEY: <API_KEY>

The API key grants you access to the API documented at API Documentation

If the API returns 403 means the API key privileges does not suffice to access the action you want to perform. Ask an Admin or Owner of the environment to review your access.

If the API returns 401 means the API key is not authorised or invalid. Ask an Admin or Owner to review access.

Authorization

Same as the whole Identity suite, the Verifier 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

• Verifier Admin - can verify verifiable credentials, can view all the verifiable credentials that have been verified based on the pre-defined list of schemas & more

• Verifier User - can verify verifiable credentials, can view its own verified credentials ,can view its own verifiable credentials that have been verified based on the pre-defined list of schemas & more

• Verifier Auditor - can view the history verified credentials & more