> For the complete documentation index, see [llms.txt](https://docs.teranode.group/tng-identity-documentation/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.teranode.group/tng-identity-documentation/introduction/portal-api/overview.md). # 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 --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://docs.teranode.group/tng-identity-documentation/introduction/portal-api/overview.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.