Regulyn

Scoped Enterprise integrations

Build on Regulyn

Bring Regulyn's HR compliance checks into your own systems through a private, scoped Enterprise implementation. We agree the use case, access and integration surface with you during onboarding.

See the capabilities
25+
Scoped API endpoints
5
Capability areas
REST
JSON and SSE

Scoped Enterprise integrations

Available today
We configure private API access, authentication and the agreed integration surface during Enterprise onboarding and implementation.

Public self-service developer access

Product roadmap
Productised public API access, outbound webhooks and self-service developer tooling are later standard-product milestones, not public sign-up features today.

Use cases

What you can build

Connect Regulyn to your existing tools and workflows through a scoped Enterprise implementation. These examples are shaped with your team during onboarding.

01

Embed the handbook chatbot

Add an assistant to your intranet, Slack or Teams that answers employee policy questions using your actual handbook.
  • Slack bot for policy questions
  • Teams integration
  • Intranet widget
  • Mobile app assistant

02

Automate document generation

Trigger HR document creation from your HRIS, ticketing system or custom workflows. 40+ document types covering employment, leave, performance, exit and more, each generated as a Microsoft Word document.
  • Generate offer letters from your ATS
  • Create disciplinary documents from HR tickets
  • Compliance-check uploaded employment documents
  • Settlement agreement drafting

03

Sync compliance status

Pull current compliance scores and gap analysis into your dashboards, so you know when policies need attention.
  • Executive compliance dashboard
  • Risk management integration
  • Audit reporting
  • Policy health monitoring

04

Surface legal change alerts

Poll the legal-change feed and pipe UK employment law updates into your GRC, ticketing or alerting stack. You bridge it with your own scheduler; there are no Regulyn-managed webhooks to configure.
  • Hourly poll into a GRC dashboard
  • Create Jira tickets automatically
  • Slack or Teams alert bots
  • Custom email digests

Enterprise integration surface

Five capability areas, scoped to your implementation

We scope each Enterprise implementation from 25+ integration-shaped endpoints covering read access, AI analysis, exports and the legal-change feed. Authentication, credentials, tenant isolation controls and agreed routes are configured during onboarding; this is not a public self-service API.

Capabilities

  • Server-Sent Events streaming for token-by-token answers
  • Source citations attached to every response
  • Session-aware: pass a sessionId to continue a conversation
  • Counts against the customer's monthly chat session limit
  • Slack, Teams, intranet and mobile-app integration patterns

Key endpoints

POST/handbooks/{id}/query/stream
Streaming SSE response
POST/handbooks/{id}/query
Non-streaming JSON response

Need an endpoint that is not listed here? Section editing, tone profiles and policy group management can be considered for a scoped Enterprise implementation. Talk to us about your use case.

Capabilities

Five capabilities for a scoped implementation

These capabilities can be included in a scoped Enterprise implementation. We configure the agreed endpoints and credentials during onboarding.

Handbook chatbot

POST /handbooks/{id}/query/stream

Ask natural language questions against the handbook. Streaming SSE responses with source citations, follow-up suggestions and session-based conversation history.

  • Streaming responses
  • Source citations
  • Follow-up suggestions
  • Session history

Compliance analysis

POST /sections/analyse

Paste any policy text and get a compliance analysis back. Issues are categorised by severity (critical, high, medium, low) with legal citations and recommendations.

  • Severity ratings
  • Legal citations
  • Recommendations
  • Issue tracking

Redrafting

POST /sections/redraft

Generate compliant versions of non-compliant policies. Every change is tracked with an explanation, and the draft respects your company tone profile.

  • Change tracking
  • Tone profile support
  • Legal grounding
  • Before and after diff

Document generation

POST /document-checker/generate

Generate 40+ HR document types through a guided wizard. Checks handbook coverage, detects gaps and exports to Microsoft Word.

  • 40+ document types
  • Gap detection
  • Guided wizard
  • Microsoft Word export

Export formats

GET /handbooks/{id}/versions/{v}/export-docx

Export complete handbooks or individual versions as Microsoft Word (.docx) or branded PDF.

  • Microsoft Word export
  • PDF export
  • Versioned exports
  • Professional formatting

Enterprise implementation

Chatbot integration

Embed an assistant that answers employee questions using your actual handbook content. Streaming responses, source citations and conversation history are available within a scoped implementation configured during onboarding.

Streaming responses
Server-Sent Events (SSE) deliver the answer token by token.
Source citations
Every answer includes references to specific handbook sections.
Conversation context
Session-based history supports natural follow-up questions.

illustrative-enterprise-request.js

// Credentials and routes are issued during Enterprise onboarding
// Stream chatbot responses with source citations
const response = await fetch(
  'https://api.regulyn.co.uk/api/v1/handbooks/{id}/query/stream',
  {
    method: 'POST',
    headers: {
      'X-API-Key': 'YOUR_API_KEY',
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({
      query: "What's our policy on flexible working?"
    })
  }
);

// Handle SSE streaming response
const reader = response.body.getReader();
const decoder = new TextDecoder();

while (true) {
  const { done, value } = await reader.read();
  if (done) break;

  const chunk = decoder.decode(value);
  // SSE events include:
  // - text: streaming answer tokens
  // - sources: referenced handbook sections
  // - suggestions: follow-up questions
}

Integrations

Works where your team works

Examples we can scope through Enterprise onboarding, bringing HR compliance checks to the tools your employees already use.

01

Slack

Build a Slack bot that lets employees ask policy questions directly in channels or direct messages.
  • Slash commands
  • Interactive messages
  • Thread replies

02

Microsoft Teams

Create a Teams bot or tab that surfaces handbook information where your team works.
  • Bot framework
  • Adaptive cards
  • Tab integration

03

Intranet and SharePoint

Embed a chatbot widget on your company intranet for self-service policy queries.
  • Embeddable widget
  • SSO configured during onboarding
  • Custom styling

04

Mobile apps

Add policy questions and answers to your employee mobile app through a scoped private API implementation.
  • iOS and Android
  • Push notifications
  • Offline cache

Developer experience

Built for a supported implementation

Plain integration patterns, implementation documentation and predictable behaviour, with credentials and scope configured during Enterprise onboarding.

01

Versioned REST integration

Standard REST conventions with JSON request and response bodies under a versioned /api/v1/* prefix, exposed only as agreed for your Enterprise implementation.

02

Streaming responses

Server-Sent Events (SSE) for chatbot responses. Token-by-token streaming for a responsive interface, with metadata events carrying source citations.

03

Pollable legal change feed

The legal-change endpoint is built for polling on your schedule. It drives your own GRC dashboards, ticketing or alerting, with no Regulyn-managed webhook delivery to configure.

04

Implementation authentication

Authentication, credentials, tenant isolation controls and agreed routes are configured for each scoped Enterprise implementation.

05

OpenAPI documentation

Swagger UI is shared with Enterprise customers during onboarding. It is tagged by capability area so the schema matches the categories on this page.

06

Rate limiting

AI and chatbot endpoints apply rate limits. The relevant limits and integration controls are confirmed during onboarding.

Security

How your data is protected

Your handbook data is sensitive. We treat it that way.

Encryption

All data is encrypted in transit and at rest. HSTS is enforced.

Authentication

Authentication, credentials, tenant isolation controls and agreed routes are configured as part of each scoped Enterprise implementation.

Activity logging

Regulyn records method, matched route, status and duration for authenticated application requests. Integration logging and access are agreed during implementation.

Data protection

Technical and organisational controls are designed to support UK GDPR obligations. Primary service data is hosted within the UK or EEA where practicable. A Data Processing Agreement is available on request.

Enterprise plan

What the Enterprise plan includes

  • Scoped API implementation
  • Custom branding
  • SSO configured in onboarding
  • Dedicated support
  • SLA guarantee
  • Priority rate limits

Ready to integrate?

Scoped API access is available through Enterprise onboarding and implementation. Talk to our team about the systems and workflows you want to connect.