API documentation

Complete API reference for VerifyWise. Explore endpoints for authentication, projects, compliance frameworks, AI governance, and more.

Base URLhttps://your-domain.com/api

Authentication

Most endpoints require JWT authentication. Include the token in your headers:

Authorization: Bearer <token>

Response format

All responses follow a consistent JSON structure:

{ "message": "ok", "data": {...} }

Version

Current API version with full compatibility:

v1.7.0

Core resources

Users

Create, update, and delete user accounts. Retrieve user profiles, manage team memberships, and configure notification preferences.

Organizations

Manage organizations with multi-tenancy support. Create workspaces, configure org-level settings, and handle member invitations.

Projects

Create and manage compliance projects. Assign team members, track progress, set deadlines, and organize work across frameworks.

Roles

Define and assign user roles with granular permissions. Control access to resources, features, and actions across your organization.

Vendors

Register and manage third-party vendors and suppliers. Track vendor compliance status, review contracts, and assess vendor risk.

Policies

Define and manage organizational policies. Version policy documents, track approval workflows, and link policies to compliance controls.

Tasks

Create and manage tasks linked to compliance work. Assign owners, set due dates, track completion, and link to entities.

Training

Manage training records including courses, attendance, completion status, and certification tracking for compliance awareness.

Evidence hub

Store and manage compliance evidence in a centralized repository. Link documents to controls, track review status, and maintain audit trails.

Files

Upload, download, and manage files attached to compliance records. Supports evidence documents, policy files, and report attachments.

Notes

Create and manage notes attached to any entity. Add context, commentary, and discussion threads to projects, risks, and controls.

Share links

Create and manage shareable links to compliance resources. Set expiration dates, access permissions, and track link usage.

Datasets

Register and manage datasets used in AI model training and evaluation. Track lineage, quality metrics, and compliance attributes.

Utilities

Automation

Create automation rules and manage compliance workflows. Define triggers, conditions, and actions to streamline processes.

Notifications

Manage real-time notifications via SSE streaming. List, read, and delete notifications with filtering and pagination.

Reporting

Generate compliance reports and analytics. Export data in multiple formats and build custom report templates.

Dashboard

Retrieve dashboard metrics, compliance statistics, and summary data across projects, risks, models, and tasks.

Search

Search across projects, controls, risks, vendors, and other resources with full-text matching, filters, and pagination.

Post-market monitoring

Configure and run post-market monitoring cycles. Manage questions, collect responses, and generate monitoring reports.

Settings

Manage feature settings and platform configuration. Toggle features, update preferences, and customize platform behavior.

User preferences

Read and update user preferences such as date format, notification settings, and display options.

Subscriptions

Manage subscription plans and billing details. View current plan status and update payment methods.

Tiers

Retrieve subscription tiers and feature availability. Compare capabilities and usage limits across plans.

Email services

Send transactional emails for invitations, password resets, and compliance workflow notifications.

Invitations

Send and manage user invitations to join organizations. Track invitation status and resend pending invites.

Intake forms

Create and manage public intake forms for collecting compliance information from external stakeholders.

Need help with the API?

Check out our user guide for step-by-step tutorials and examples.

View user guide
API documentation - VerifyWise