Base URL:https://app.docbrilliant.com|Format: JSON|382 endpoints

Authentication

Public — No authentication required
User Auth — JWT session cookie required
Admin — Admin role required
Service KeyX-Service-API-Key header
Cron SecretAuthorization: Bearer token

Authentication

11 endpoints

Endpoints for user authentication, session management, and token exchange. DocBrilliant uses Azure AD (Microsoft SSO) with JWT session cookies.

Get current session

User Auth

Exchange SSO token for session

Public

Exchange authorization code for tokens

Public

Complete login redirect

Public

Initiate tenant-scoped login

Public

Tenant login callback

Public

Create session from MSAL token

Public

Get app-only access token

User Auth

Refresh session token

User Auth

Logout and clear session

User Auth

Get current user roles

User Auth

Documents

47 endpoints

Core document management endpoints for creating, reading, updating, and deleting policy documents. Supports versioning, locking, AI generation, workflow integration, and SharePoint storage.

List documents

User Auth

Create a document

User Auth

Get document by ID

User Auth

Update a document

User Auth

Soft-delete a document

User Auth

Advanced document search

User Auth

Get document statistics

User Auth

Get expiring documents

User Auth

Get document names lookup

User Auth

Bulk create documents

User Auth

Bulk update documents

User Auth

Bulk delete documents

User Auth

Sync documents with SharePoint

Admin

Compare document versions

User Auth

Create document from template

User Auth

Create document with file upload

User Auth

Generate AI description and tags

User Auth

Bulk generate AI metadata

User Auth

Generate AI document content

User Auth

Clone a document

User Auth

Publish a document

User Auth

Mark document as final

User Auth

Lock a document

User Auth

Unlock a document

User Auth

Get document lock status

User Auth

Check edit permission

User Auth

Get document permissions

User Auth

Get document file content

User Auth

List document revisions

User Auth

Create a new revision

User Auth

Get document signatures

User Auth

Submit document for approval

User Auth

Start document workflow

User Auth

Get active document workflow

User Auth

Get matching workflow template

User Auth

Get submission packages

User Auth

Validate document for submission

User Auth

AI document review

User Auth

Get document checklist

User Auth

Create document checklist

User Auth

Update document checklist

User Auth

Get checklist item

User Auth

Update checklist item

User Auth

List checklist stakeholders

User Auth

Add checklist stakeholder

User Auth

Update checklist stakeholder

User Auth

Remove checklist stakeholder

User Auth

Workflows

14 endpoints

Manage multi-step approval workflows for documents. Supports sequential and parallel steps, role-based assignment, delegation, and template-driven configuration.

List workflows

User Auth

Create a workflow

User Auth

Get workflow by ID

User Auth

Update a workflow

User Auth

Cancel a workflow

User Auth

Get workflow step

User Auth

Act on a workflow step

User Auth

Get active workflows for user

User Auth

List workflow templates

User Auth

Create a workflow template

Admin

Get workflow template

User Auth

Update a workflow template

Admin

Delete a workflow template

Admin

Clone a workflow template

Admin

Workflow Statuses

7 endpoints

Manage the document status definitions used throughout the workflow lifecycle. Statuses are database-driven and configurable per tenant.

List workflow statuses

User Auth

Create a workflow status

Admin

Get workflow status

User Auth

Update a workflow status

Admin

Delete a workflow status

Admin

Get status dependencies

Admin

Reorder workflow statuses

Admin

Approvals

3 endpoints

Endpoints for querying pending approvals and generating approval summaries. Used by the Approvals page to show documents awaiting the current user's action.

Get pending approvals

User Auth

Track approval status

User Auth

Generate AI approval summary

User Auth

E-Signatures

8 endpoints

Electronic signature management with DocuSign integration. Supports drawn, uploaded, and typed signatures as well as DocuSign envelope-based signing flows.

Get e-signature configuration status

User Auth

Test DocuSign connection

Admin

List signing envelopes

User Auth

Create a signing envelope

User Auth

Get envelope details

User Auth

Void an envelope

User Auth

Get signing URL

User Auth

Complete approval with signature

User Auth

Categories

10 endpoints

Manage document categories (domains) such as IT, HR, HSE, Finance. Categories are used to organize documents and scope workflow templates.

List categories

User Auth

Create a category

Admin

Get category by ID

User Auth

Update a category

Admin

Delete a category

Admin

Get category dependencies

Admin

Reassign category documents

Admin

Reorder categories

Admin

Seed default categories

Admin

Sync categories with SharePoint

Admin

Classifications

10 endpoints

Manage document classification levels (e.g., Public, Internal, Confidential, Strictly Confidential). Classifications control access and handling requirements.

List classifications

User Auth

Create a classification

Admin

Get classification by ID

User Auth

Update a classification

Admin

Delete a classification

Admin

Get classification dependencies

Admin

Reassign classification documents

Admin

Reorder classifications

Admin

Seed default classifications

Admin

Sync classifications with SharePoint

Admin

Document Types

10 endpoints

Manage document type definitions (e.g., Policy, Procedure, Standard, Guideline, Manual). Types affect document numbering and workflow template matching.

List document types

User Auth

Create a document type

Admin

Get document type by ID

User Auth

Update a document type

Admin

Delete a document type

Admin

Get document type dependencies

Admin

Reassign document type documents

Admin

Reorder document types

Admin

Seed default document types

Admin

Sync document types with SharePoint

Admin

Document Statuses

10 endpoints

Manage document status definitions. Statuses track a document's lifecycle from DRAFT through workflow stages to PUBLISHED. Configurable per tenant with initial/final flags.

List document statuses

User Auth

Create a document status

Admin

Get document status by ID

User Auth

Update a document status

Admin

Delete a document status

Admin

Get document status dependencies

Admin

Reassign document status

Admin

Reorder document statuses

Admin

Seed default document statuses

Admin

Sync document statuses with SharePoint

Admin

Companies

19 endpoints

Manage company (entity) records within a tenant. Companies are organizational units that own documents and have associated SharePoint document libraries and logo assets.

List companies

User Auth

Create a company

Admin

Get company by ID

User Auth

Update a company

Admin

Delete a company

Admin

Get company dependencies

Admin

Reassign company documents

Admin

Get default workflow template

User Auth

Set default workflow template

Admin

List SharePoint document sets

User Auth

Create SharePoint document set

Admin

Delete SharePoint document set

Admin

Get SharePoint library

User Auth

Create SharePoint library

Admin

Delete SharePoint library config

Admin

Get company logo

User Auth

Upload company logo

Admin

Delete company logo

Admin

Check library readiness

Admin

Tenant Management

21 endpoints

Endpoints for tenant provisioning, configuration, usage tracking, billing management, and multi-tenant operations. Tenants are the top-level isolation unit in DocBrilliant.

Provision a new tenant

Service Key

Check subdomain availability

Public

Check email availability

Public

Check domain availability

Public

Get tenant settings

User Auth

Update tenant settings

Admin

Get trial status

User Auth

Get tenant usage

User Auth

Get billing information

Admin

List pending invitations

Admin

Send user invitation

Admin

Revoke an invitation

Admin

Get custom domain

Admin

Add custom domain

Admin

Remove custom domain

Admin

Verify custom domain DNS

Admin

Auto-create SharePoint site

Admin

Download all documents

User Auth

Export tenant data

Admin

Get tenant alerts

User Auth

Dismiss an alert

User Auth

Users

9 endpoints

Manage user profiles, preferences, roles, and signatures. User accounts are created automatically via SSO and scoped to a tenant.

Get user photo

User Auth

Get user preferences

User Auth

Update user preferences

User Auth

Get user roles

User Auth

Assign role to user

Admin

Remove role from user

Admin

Get user signature

User Auth

Save user signature

User Auth

Delete user signature

User Auth

Audit Logs

9 endpoints

Comprehensive audit trail system with 7-year retention. Tracks all user actions, document changes, workflow events, and system operations. Supports filtering, export, and compliance reporting.

List audit logs

User Auth

Get audit log entry

User Auth

Delete audit log entry

Admin

Get recent audit logs

User Auth

Get audit log summary

User Auth

Get document audit trail

User Auth

Get user audit trail

User Auth

Export audit logs

Admin

Bulk delete audit logs

Admin

Reports

12 endpoints

Reporting and analytics endpoints for document publishing metrics, compliance tracking, and performance dashboards. Supports filtering by company, department, and date range.

My published documents

User Auth

Company published documents

User Auth

Department published documents

User Auth

Near-expiry documents

User Auth

Export report data

User Auth

Get company filter options

User Auth

Get department filter options

User Auth

Get domain filter options

User Auth

Publishing performance metrics

User Auth

Average publishing time

User Auth

Document view analytics

User Auth

Admin activity log

Admin

Acknowledgements

11 endpoints

Employee acknowledgement and training campaigns. Allows administrators to create campaigns that require users to read and acknowledge specific documents, optionally with quizzes.

List acknowledgements

User Auth

Record an acknowledgement

User Auth

Get acknowledgement details

User Auth

Update an acknowledgement

User Auth

Delete an acknowledgement

Admin

List acknowledgement campaigns

Admin

Create an acknowledgement campaign

Admin

Get campaign details

Admin

Update a campaign

Admin

Delete a campaign

Admin

Launch a campaign

Admin

Admin Settings

99 endpoints

Platform administration endpoints for system settings, user management, group management, column configuration, permissions, deleted item recovery, and SharePoint management. Requires admin role.

Get all admin settings

Admin

Update admin settings

Admin

Get tenant settings

Admin

Update tenant settings

Admin

Get security settings

Admin

Update security settings

Admin

Get SharePoint settings

Admin

Update SharePoint settings

Admin

Get DocuSign settings

Admin

Update DocuSign settings

Admin

Seed DocuSign templates

Admin

Get database settings

Admin

Update database settings

Admin

Get deployment notification settings

Admin

Create deployment notification

Admin

Update deployment notification

Admin

Test external connection

Admin

Preview document number format

Admin

Get secret settings

Admin

Update secret settings

Admin

Get app configuration

Admin

Update app configuration

Admin

List all users

Admin

Create a user

Admin

Get user details

Admin

Update a user

Admin

Deactivate a user

Admin

Reactivate a user

Admin

Get user roles (admin)

Admin

Assign role (admin)

Admin

Remove role (admin)

Admin

Grant SharePoint access

Admin

Search users

Admin

Get user statistics

Admin

Sync users from Azure AD

Admin

List groups

Admin

Create a group

Admin

Get group details

Admin

Update a group

Admin

Delete a group

Admin

List group members

Admin

Add group member

Admin

Remove group member

Admin

Update group member

Admin

Clone a group

Admin

Filter groups

Admin

Reorder groups

Admin

Sync groups from Azure AD

Admin

List column configurations

Admin

Create a column

Admin

Update columns

Admin

Delete a column

Admin

Sync columns with SharePoint

Admin

Reset column sync

Admin

Set essential fields

Admin

Upload document template

Admin

List checklist item templates

Admin

Create checklist item template

Admin

Get checklist item template

Admin

Update checklist item template

Admin

Delete checklist item template

Admin

Reorder checklist items

Admin

Get all app config

Admin

Create app config entry

Admin

Get config by category

Admin

Get config value

Admin

Update config value

Admin

Delete config value

Admin

List all permissions

Admin

Create permission entry

Admin

Update permissions

Admin

Get role permissions

Admin

Update role permissions

Admin

Add permission to role

Admin

Remove permission from role

Admin

Get workflow configuration

Admin

Update workflow configuration

Admin

Reset workflow configuration

Admin

List archived documents

Admin

Archive/restore documents

Admin

List deleted items

Admin

Get deleted item dependencies

Admin

Restore a deleted item

Admin

Permanently delete an item

Admin

Bulk restore deleted items

Admin

Bulk permanently delete items

Admin

List deletion requests

Admin

Create a deletion request

User Auth

Approve deletion request

Admin

Reject deletion request

Admin

Upload email template image

Admin

Delete email template image

Admin

Create AI metadata columns

Admin

Mark content as AI-generated

Admin

Sync owner display names

Admin

List companies (admin)

Admin

Create SharePoint resources

Admin

Reset SharePoint configuration

Admin

Sync SharePoint permissions

Admin

Internal APIs

44 endpoints

Service-to-service APIs consumed by the DocBrilliant Admin dashboard. Authenticated via X-Service-API-Key header. Used for tenant management, metrics, billing sync, and system configuration.

Health check

Service Key

Platform metrics

Service Key

Usage trend data

Service Key

AI service status

Service Key

Platform audit summary

Service Key

List all tenants

Service Key

Get tenant details

Service Key

Update tenant

Service Key

Suspend a tenant

Service Key

Get tenant configuration

Service Key

Update tenant configuration

Service Key

Restore a suspended tenant

Service Key

Permanently delete tenant

Service Key

Get tenant subscription

Service Key

Update tenant subscription

Service Key

Get tenant invoices

Service Key

Sync plans from admin

Service Key

Sync platform settings

Service Key

Get system configuration

Service Key

Update system configuration

Service Key

Get workflow config (internal)

Service Key

Update workflow config (internal)

Service Key

List workflow statuses (internal)

Service Key

Create workflow status (internal)

Service Key

Get workflow status (internal)

Service Key

Update workflow status (internal)

Service Key

Delete workflow status (internal)

Service Key

Get status dependencies (internal)

Service Key

Reorder workflow statuses (internal)

Service Key

Get Stripe configuration

Service Key

Update Stripe configuration

Service Key

Test Stripe connection

Service Key

Get Creem configuration

Service Key

Update Creem configuration

Service Key

Test Creem connection

Service Key

Sync plan to Stripe

Service Key

List Stripe invoices

Service Key

Get revenue metrics

Service Key

List Stripe subscriptions

Service Key

Sync plan to Paddle

Service Key

Sync plan to LemonSqueezy

Service Key

Sync plan to Creem

Service Key

List custom domains

Service Key

Update custom domain

Service Key

Billing & Webhooks

6 endpoints

Webhook receivers for payment processors and external services. These endpoints receive asynchronous notifications and update tenant billing status accordingly.

Stripe webhook

Public

Paddle webhook

Public

LemonSqueezy webhook

Public

Creem webhook

Public

DocuSign webhook

Public

Vercel deployment webhook

Public

Cron Jobs

6 endpoints

Scheduled task endpoints triggered by system cron jobs. Authenticated via Bearer token (CRON_SECRET). Handle trial expiration, tenant cleanup, document expiry notifications, and domain verification.

Process trial expirations

Cron Secret

Clean up expired tenants

Cron Secret

Send document expiry notifications

Cron Secret

Archive expired documents

Cron Secret

Verify custom domains

Cron Secret

Provision SSL certificates

Cron Secret

AI & Chat

4 endpoints

AI-powered features including conversational document assistant, semantic search enhancement, and document insights. Powered by Claude (Anthropic) via Azure OpenAI gateway.

AI chat (streaming)

User Auth

AI document chat

User Auth

AI-enhanced search

User Auth

Get document insights

User Auth

Configuration

12 endpoints

Public and authenticated endpoints for application configuration, health checks, plan information, and miscellaneous lookups.

Public health check

Public

Get public app configuration

User Auth

Get system configuration

User Auth

Update system configuration

Admin

Get UI configuration

User Auth

Update UI configuration

Admin

Get filter configuration

User Auth

Get public plan list

Public

List departments

User Auth

Create a department

Admin

Get my archived documents

User Auth

Get submission package by tracking number

User Auth