MIMS SDK Documentation
A comprehensive React SDK for document management, PDF viewing, form filling, and digital signatures. Build powerful document workflows in minutes.
Quick Start
What is MIMS SDK?
MIMS SDK is a complete document infrastructure solution that provides React components and hooks for building document-centric applications. It handles the complexity of PDF rendering, form fields, digital signatures, and secure document submission, letting you focus on your application logic.
Key Features
Document Management
Upload, organize, and process documents at scale with full version control and audit trails.
Digital Signatures
Legally binding e-signatures with multiple signing methods: draw, type, or upload.
AI-Powered Processing
Automatic OCR, data extraction, and document classification powered by machine learning.
Enterprise Security
SOC 2 Type II certified with AES-256 encryption, organization isolation, and audit logging.
Real-time Processing
Process thousands of documents simultaneously with sub-second response times.
React Components
Production-ready components including PDFViewer and SignaturePad with full TypeScript support.
How It Works
The MIMS SDK follows a simple integration pattern that works with any React application. Here's a high-level overview of the integration flow:
Install the SDK
Add the SDK package to your project using your preferred package manager.
npm install @mims/sdk-reactConfigure the Provider
Wrap your application with the MIMSProvider and provide your API key.
import { MIMSProvider } from '@mims/sdk-react';
function App() {
return (
<MIMSProvider apiKey={process.env.NEXT_PUBLIC_MIMS_API_KEY}>
<YourApp />
</MIMSProvider>
);
}Use the Components
Import and use the PDF viewer and other components in your application.
import { PDFViewer } from '@mims/sdk-react';
function DocumentPage({ documentId, documentUrl }) {
return (
<PDFViewer
documentId={documentId}
documentUrl={documentUrl}
onSubmit={(payload) => console.log('Submitted:', payload)}
/>
);
}Handle Submissions
When users complete and submit documents, the SDK automatically sends the data to our API, processes the PDF with embedded fields and signatures, and returns the completed document.
Architecture Overview
The SDK consists of three main parts:
- MIMSProvider - The context provider that handles authentication, API communication, and SDK initialization. It must wrap all other SDK components.
- Components - Ready-to-use React components like PDFViewer and SignaturePad that handle rendering and user interactions.
- Hooks & Store - React hooks and a Zustand-based store for managing document state, field values, and programmatic control.
// The SDK architecture
<MIMSProvider apiKey="..."> {/* Authentication & API layer */}
<PDFViewer {/* UI Component layer */}
documentId="..."
documentUrl="..."
/>
</MIMSProvider>
// Under the hood:
// - MIMSProvider validates API key on mount
// - PDFViewer loads PDF and creates document store
// - User interactions update the store
// - On submit, data is sent to MIMS API
// - Processed PDF with embedded fields is returnedRequirements
Before integrating the SDK, ensure your environment meets these requirements:
- React 18+ - The SDK uses modern React features
- Node.js 18+ - For build and development
- TypeScript 5+ - Recommended for best developer experience
- MIMS API Key - Obtain from your MIMS dashboard
Note