iDeals

Supergood | iDeals API

Alex Klarfeld

Alex Klarfeld

— 6 min read
Supergood | iDeals API

Programmatically access iDeals virtual data rooms, documents, Q&A workflows, permissions, and audit trails with a stable REST API. Supergood builds and operates production-grade, unofficial iDeals integrations so your team can automate deal operations without heavy custom engineering.

Plain English: iDeals is a secure virtual data room (VDR) used for M&A due diligence, fundraising, corporate governance, and other confidential document sharing. An unofficial API lets you programmatically pull data rooms, users and groups, folder structures, documents and versions, Q&A threads, permissions, and activity logs—and push uploads, user invites, Q&A items, and permission updates back into iDeals.

For a tech company integrating with iDeals, this means you can ingest real-time room and document metadata for reporting, synchronize Q&A workflows to your CRM or deal platform, automate document uploads with classification and watermark settings, manage user provisioning and group permissions from your system, and stream audit activity for compliance analytics and GRC. Many teams complain that VDR integrations are portal-first, offer only manual/Excel exports, and restrict or charge heavily for official APIs; an unofficial API helps you plug in automation, keep data current, and avoid brittle browser scripting.

What is iDeals?

iDeals (https://www.idealsvdr.com/) is a cloud-based Virtual Data Room platform built for secure document sharing and collaboration during transactions and governance processes. Organizations use iDeals to centralize sensitive documents, enforce granular permissions and watermarks, route and answer Q&A during diligence, and maintain auditable activity histories across buyers, sellers, advisors, and internal teams.

Core product areas include:

  • Document Management (Rooms, Folders, Documents, Versions, Tags, Dynamic Watermarking, View-Only/DRM)
  • User & Access Control (Users, Groups, Roles, Invitations, NDA/Terms Acceptance, Permission Profiles)
  • Q&A Workflow (Questions, Answers, Categories, Routing, Redaction, Status/Visibility)
  • Analytics & Audit (Activity Logs, Engagement Reports, Document Access Statistics)
  • Room Administration (Indexing, Branding, Room Settings, Security Policies, Expiration/Archival)

Common data entities:

  • Data Rooms (metadata, status, transaction type)
  • Users and Groups (roles, invitations, access scopes)
  • Folders and Documents (versions, DRM/watermark settings, tags)
  • Q&A Threads (questions, answers, categories, attachments, status)
  • Permissions (folder-level/document-level rights: view, download, print, Q&A access)
  • Activity Events (document views/downloads, login, Q&A actions, invites)

The iDeals Integration Challenge

Teams rely on iDeals for mission-critical deal workflows, but turning portal-based processes into API-driven automation is non-trivial:

  • Complex permission matrices: Groups, roles, and exceptions at folder/document levels must be respected for security and compliance
  • DRM and watermark controls: View-only modes, fence view, and restricted downloads can complicate automated ingestion and export
  • Q&A orchestration: Multi-step routing, redaction, and visibility states are optimized for manual portal flows
  • Authentication complexity: SSO/MFA and challenge lifecycles make headless automation fragile without careful session management
  • Limited native exports: Many reports/Q&A lists are available as XLSX/CSV downloads, not as structured APIs, making data normalization key

How Supergood Creates iDeals APIs

Supergood reverse-engineers authenticated browser flows and network interactions to deliver a resilient API endpoint layer for your iDeals tenant.

  • Handles username/password, SSO/OAuth, and MFA (SMS, email, TOTP) securely
  • Maintains session continuity with automated refresh and change detection
  • Normalizes responses so you can integrate once and rely on consistent objects across modules
  • Aligns with customer entitlements and role-based permissions to ensure compliant access
  • Supports large file uploads with chunking, hashing, and resumable retries

Use Cases

Data Room & User Sync

  • Mirror data rooms, users, and groups into your internal systems
  • Keep room metadata and statuses current for analytics and reporting
  • Standardize group roles and invitation lifecycles across deals

Document Ingestion & Classification

  • Automate uploads with folder routing, tags, watermark policies, and view-only settings
  • Synchronize document versions and maintain integrity via file hashing
  • Trigger notifications to specific groups when new docs are available

Q&A Workflow Automation

  • Create and route questions from your product to deal coordinators
  • Track categories, priorities, and visibility states for investor/buyer access
  • Ingest answers and attachments to keep stakeholders aligned

Audit & Compliance Reporting

  • Stream activity logs (views, downloads, logins, Q&A) into your GRC or data warehouse
  • Build engagement dashboards and alerts based on document interaction
  • Maintain immutable audit records aligned to your governance requirements

Available Endpoints

Authentication

POST /sessions: Establish a session using credentials. Supergood manages MFA (SMS, email, TOTP) and SSO/OAuth when enabled. Returns a short-lived auth token maintained by the platform.

curl --request POST \
  --url https://api.supergood.ai/integrations/<integration_id>/sessions \
  --header 'Authorization: Basic <Base64 encoded token>' \
  --header 'Content-Type: application/json' \
  --data '{
    "username": "[email protected]",
    "password": "<password>",
    "mfa": { "type": "totp", "code": "123456" }
  }'

Example response

{
  "authToken": "eyJhbGciOi...",
  "expiresIn": 3600,
  "user": {
    "id": "u_idls_7a21f9",
    "name": "Deal Admin",
    "entitlements": ["rooms", "documents", "qna", "audit"]
  }
}

POST /sessions/refresh: Refresh an existing token to keep sessions uninterrupted.

Data Rooms

GET /data-rooms: List rooms with filters and summary details.

Query parameters

  • status: active | archived | pending
  • projectType: m_and_a | fundraising | board | other
  • updatedFrom, updatedTo: ISO 8601 timestamps
  • page, pageSize: integers for pagination

Example response

{
  "items": [
    {
      "roomId": "rm_0e91a0",
      "name": "Project Falcon – Sell-Side",
      "projectType": "m_and_a",
      "status": "active",
      "ownerCompany": "Falcon Holdings LLC",
      "adminEmail": "[email protected]",
      "createdAt": "2026-01-10T09:22:15Z",
      "updatedAt": "2026-01-20T18:45:00Z"
    }
  ],
  "page": 1,
  "pageSize": 50,
  "total": 1
}

Documents

POST /data-rooms/{roomId}/documents: Upload a document to a folder with classification and security settings.

curl --request POST \
  --url https://api.supergood.ai/integrations/<integration_id>/data-rooms/rm_0e91a0/documents \
  --header 'Authorization: Bearer <authToken>' \
  --header 'Content-Type: application/json' \
  --data '{
    "folderId": "fld_19c2e7",
    "fileName": "Financials_Q4_2025.pdf",
    "sizeBytes": 2948573,
    "sha256": "0a5c9f...",
    "classificationTags": ["Financials", "Confidential"],
    "watermarkPolicy": {
      "type": "dynamic",
      "text": "Confidential – <user_email> – <timestamp>",
      "opacity": 0.2
    },
    "restrictedDownload": true,
    "drmFenceView": false,
    "versionNote": "Initial upload",
    "notifyGroupIds": ["grp_buyers_01", "grp_advisors_02"],
    "attachments": [
      {"fileName": "notes.txt", "uploadToken": "upl_08ab73"}
    ]
  }'

Example response

{
  "documentId": "doc_90e412",
  "versionId": "ver_1",
  "status": "available",
  "restrictedDownload": true,
  "createdAt": "2026-01-21T10:03:11Z"
}

Q&A

POST /data-rooms/{roomId}/qna/questions: Create a Q&A question with routing, visibility, and attachments.

curl --request POST \
  --url https://api.supergood.ai/integrations/<integration_id>/data-rooms/rm_0e91a0/qna/questions \
  --header 'Authorization: Bearer <authToken>' \
  --header 'Content-Type: application/json' \
  --data '{
    "subject": "Clarification on revenue recognition",
    "questionText": "Please explain revenue recognition policy for multi-year contracts.",
    "categoryId": "cat_finance",
    "priority": "high",
    "visibility": "external", 
    "restrictedToGroupIds": ["grp_buyers_01"],
    "assigneeUserId": "u_idls_coordinator_12",
    "attachments": [
      {"fileName": "policy_reference.pdf", "uploadToken": "upl_7fa223"}
    ],
    "referenceId": "crm-opp-2981"
  }'

Example response

{
  "questionId": "q_51af80",
  "status": "submitted",
  "categoryId": "cat_finance",
  "createdAt": "2026-01-21T11:20:44Z"
}

Get full API Specs →

Technical Specifications

  • Authentication: Username/password with MFA (SMS, email, TOTP) and SSO/OAuth where enabled; supports service accounts or customer-managed credentials
  • Response format: JSON with consistent resource schemas and pagination across modules
  • Rate limits: Tuned for enterprise throughput while honoring customer entitlements and usage controls
  • Session management: Automatic reauth and cookie/session rotation with health checks
  • Data freshness: Near real-time retrieval of rooms, documents, Q&A, and audit events
  • Security: Encrypted transport, scoped tokens, and audit logging; respects iDeals role-based permissions and document restrictions
  • Webhooks: Optional asynchronous delivery for long-running workflows (e.g., Q&A updates, document uploads)

Performance Characteristics

  • Latency: Sub-second responses for list/detail queries under normal load
  • Throughput: Designed for high-volume document upload and activity log export
  • Reliability: Retry logic, backoff, and idempotency keys minimize duplicate actions
  • Adaptation: Continuous monitoring for UI/API changes with rapid adapter updates

Getting Started

  1. Schedule Integration Assessment

Book a 30-minute session to confirm your modules, licensing, and authentication model.

  1. Supergood Builds and Validates Your API

We deliver a hardened iDeals adapter tailored to your workflows and entitlements.

  1. Deploy with Monitoring

Go live with continuous monitoring and automatic adjustments as iDeals evolves.

Schedule Integration Call →

Frequently Asked Questions

Q: Which iDeals modules can this integration cover?

Supergood supports workflows across commonly used modules such as Document Management (Rooms, Folders, Documents, Versions), Q&A (Questions, Answers, Categories), Access Control (Users, Groups, Permissions), and Analytics/Audit (Activity Logs), subject to your licensing and entitlements. We scope coverage during integration assessment.

Q: How are MFA and SSO handled for automation?

We support username/password + MFA (SMS, email, TOTP) and can operate behind SSO/OAuth when enabled. Sessions are refreshed automatically with secure challenge handling.

Q: Can you export audit trails and Q&A to our warehouse/BI or GRC?

Yes. We can normalize views/downloads/login/Q&A events and deliver updates via webhooks or polling while complying with rate and permission constraints. We commonly push to data warehouses and compliance platforms.

Q: Are watermarks, DRM, and restricted downloads respected?

Yes. We model watermark policies and DRM settings in our normalized responses and enforce restricted download/view-only rules. Uploads can set watermark/DRM flags, and downloads comply with room policies.

Ready to automate your iDeals workflows?

Supergood can have your iDeals integration live in days with no ongoing engineering maintenance.

Get Started →

Read more