Overview

Introduction

The Portal API is a REST API that allows clients to manage their Users and Organisation programmatically. It is designed for management of User profile settings, API Key management, Organisation profiles and much more. It is designed with flexibility and low-level access. Clients can use this API documentation to integrate their platform onto it and perform tasks through API interactions.

Key Features

• User Management - Manage users who can access the portal and with which roles

  • Add or remove users from accessing portals

• API Key Management - Manage API interactions via API Key

  • Assign an API key to users

  • Revoke API key from users

  • Regenerate API key from users

  • Delete API key from users

• API Usage:

  • Overview of the environment metrics

    • Issuance

    • Verification

  • View API Requests overview with detailed explanation

• Webhook Management - Receive real-time notifications for Issuer and Verifier events

  • Create and configure webhook endpoints

  • Subscribe to credential offer and verifiable presentation events

  • Manage webhook lifecycle (create, update, delete)

  • Verify webhook signatures for secure delivery

When to Use the Portal API

• Custom User Management Interaction: Manage users who can access the portal and with which roles

• Custom API Key Management: Manage API Key access for your users

• View the API Metrics Overview: Review how the service behaves and see who and what they are doing in more detail

• Webhook Integration: Receive real-time event notifications from Issuer and Verifier services to automate your workflows — such as tracking credential offer status changes or verifiable presentation updates