Hyland OnBase API
Hyland OnBase is an enterprise content services and document management platform that captures, stores, routes, and governs business documents across departments and industries. An unofficial API lets you programmatically retrieve documents, keywords, folders, workflow queues, and case data—and push updates like new document uploads, keyword changes, and workflow transitions back into OnBase.
What is Hyland OnBase?
Hyland OnBase is an enterprise content services and document management platform that captures, stores, manages, and routes business documents across an organization. Customers use OnBase to intelligently capture and classify content from multiple channels, automate content-centric workflows with configurable rules and forms, manage records through their full retention and destruction lifecycle, run case management, and feed high-quality data into everyday business systems—serving healthcare, financial services, insurance, government, education, and other verticals.
Core product areas include:
- Document Management & Capture (multichannel capture, automatic classification, and verification)
- Workflow & Process Automation (configurable workflows, customizable forms, and built-in rules)
- Records Management & Retention (automated secure retention and destruction)
- Case Management (documents, emails, tasks, approvals, compliance, and verifications)
- Collaboration & Analytics (secure content sharing, version control, dashboards, and audit trails)
Common data entities:
- Documents, Document Types, Document Type Groups, Revisions
- Keywords, Keyword Types, Keyword Type Groups
- Folders, Folder Types, File Cabinets
- Workflow Queues, Life Cycles, Tasks, Work Items
- Cases, Notes, Annotations, Signatures
- Users, Groups, Retention Plans, Audit Trails
The Hyland OnBase Integration Challenge
Organizations run mission-critical content workflows on OnBase daily, but turning its capture, workflow, and records surfaces into API-driven automation is non-trivial:
- Per-deployment configuration: Document types, keyword types, workflow life cycles, and forms are tailored per customer—generic integrations break across installations
- Version and module variability: REST API Server coverage differs by OnBase foundation version (e.g., 22.1, 23.1, 24.1) and the modules a customer has licensed
- On-prem and hybrid deployments: Many OnBase installs run on-premises behind IIS with customer-specific network configuration and authentication modules
- Authentication complexity: OnBase supports multiple IIS authentication modules and SSO, which complicate headless, server-to-server automation
- Binary document handling: Uploading and downloading document content, revisions, and renditions requires careful streaming and metadata alignment
- Workflow and retention rules: Queue transitions, ad-hoc tasks, and retention/destruction actions carry audit and compliance requirements that must be preserved
How Supergood Creates Hyland OnBase APIs
Supergood reverse-engineers authenticated browser flows and OnBase's REST API Server interactions to deliver a resilient API layer for your OnBase deployment—across capture, document management, workflow, and records.
- Handles OnBase authentication, IIS auth modules, and SSO securely within a managed session
- Maintains session continuity with automated refresh and change detection across foundation versions
- Normalizes responses across Documents, Keywords, Folders, Workflow, and Cases so you integrate once and rely on consistent objects
- Aligns with deployment-specific document types, keyword types, and retention plans to ensure compliant access
Use Hyland OnBase with AI agents: Hyland OnBase MCP Server →
Getting Started
- Schedule Integration Assessment
Book a 30-minute session to confirm your OnBase modules, foundation version, and authentication model.
- Supergood Builds and Validates Your API
We deliver a hardened OnBase adapter tailored to your deployment configuration and entitlements.
- Deploy with Monitoring
Go live with continuous monitoring and automatic adjustments as OnBase evolves.
API Endpoints
Authentication
/authenticateAuthenticate to an OnBase deployment using credentials or SSO and obtain a session token for downstream calls.
Documents
/documentsSearch and list documents with filters for document type, keyword values, date range, and status.
Documents
/create_documentUpload a new document with its document type, file content, and keyword metadata into OnBase.
Keywords
/keywordsRetrieve keyword types, keyword type groups, and keyword values associated with a document.
Workflow
/workflow_queuesList workflow queues, life cycles, and the work items currently routed to each queue.
Workflow
/execute_taskExecute an ad-hoc or system task to transition a document between workflow queues or life cycle states.
Use Cases
Sync documents and metadata into a warehouse
- Pull documents, document types, and keyword values from OnBase into a single repository - Stream new captures and revisions to downstream BI and analytics tools - Reconcile folder and case structures across departments for unified search
Automate capture and document upload
- Push documents from external systems into OnBase with the correct document type and keywords - Trigger classification and verification workflows without manual portal entry - Attach renditions and supporting files to existing documents programmatically
Drive workflow and case automation
- List workflow queues and route work items between life cycle states via API - Execute ad-hoc tasks, approvals, and exception handling from external applications - Surface pending tasks and case status to dashboards and ticketing systems
Govern records and retention
- Apply retention plans and trigger lifecycle actions across document sets - Pull audit trails and activity history for compliance reporting - Reconcile destruction and disposition events with external governance systems
Technical Specifications
Authentication
OnBase credentials, IIS authentication modules, and SSO handled in a managed session
Connectivity
Authenticated browser flows plus the OnBase REST API Server where exposed by the deployment
Response format
Normalized JSON across Documents, Keywords, Folders, Workflow, and Case objects
Rate limits
Adaptive throttling tuned to your OnBase application server to avoid system-side limits
Session management
Automatic session refresh, SSO replay handling, and credential rotation
Data freshness
Near real-time pulls for documents, keywords, and workflow items with optional scheduled batch syncs
Security
Encrypted credential vault, scoped access tokens, SOC 2-aligned controls, and audit logging
Webhooks
Event-style callbacks for document capture, keyword changes, workflow transitions, and retention events
Latency
Sub-second reads on cached entities; multi-second writes when uploading documents and executing workflow tasks
Throughput
Horizontally scaled workers sized to high-volume capture and workflow processing
Reliability
Retry, backoff, and idempotency keys for document uploads, keyword updates, and workflow transitions
Adaptation
Continuous monitoring of OnBase foundation releases and deployment-specific configuration drift
Frequently asked questions
Yes. Supergood adapts to on-prem, hybrid, and cloud OnBase installs. We operate against the same authenticated REST API Server and browser surfaces, with network and IIS authentication configuration tuned to your environment.
Supergood profiles your specific OnBase foundation version (for example 22.1, 23.1, or 24.1) and licensed modules, then adapts to the REST API Server coverage available in that release rather than assuming a fixed endpoint set.
Each deployment is profiled against its configured document types, keyword types, and keyword type groups. Supergood preserves your custom metadata model rather than forcing a generic schema.
Yes. Workflow queues, life cycles, ad-hoc tasks, and case data are exposed through the normalized API surface, so you can list queues and execute transitions from external applications.
Yes. Retention plans, lifecycle actions, and audit trails are surfaced through the API so compliance and governance controls are preserved when you automate against OnBase.