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

Utilities

Files

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

Email services

Send transactional emails, manage notification templates, and configure email delivery settings for your compliance workflows.

Dashboard

Retrieve dashboard metrics, compliance statistics, and summary data. Build custom views with aggregated project and risk information.

Search

Search across projects, controls, risks, vendors, and other resources. Filter results by type, status, and date with full-text matching.

Logger

Access audit logs and activity history. Query log entries by user, resource, action type, and date range for compliance reporting.

Tasks

Create and manage tasks and to-do items linked to compliance work. Assign owners, set due dates, and track task completion across projects.

Tokens

Generate, rotate, and revoke API tokens for programmatic access. Configure token scopes, expiration policies, and usage limits.

User preferences

Read and update user preferences such as notification settings, display options, default views, and language configuration.

Share links

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

Reporting

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

Slack webhooks

Configure Slack webhook integrations to receive real-time compliance notifications. Map event types to channels and manage alert rules.

Subscriptions

Manage subscription plans and billing details. View current plan status, update payment methods, and retrieve invoicing history.

Tiers

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

Need help with the API?

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

View user guide
API documentation - VerifyWise