Ingestion Methods API
Query all available document entry channels for the authenticated organization — including Secure Inbound Email, Scan-to-Cloud & Network MFPs, Telecom Carrier eFax trunks, Direct UI Dropzone, and Developer REST APIs.
/v1/ingestion-methodsReturns an array of configured and active ingestion channels for the organization. Also accessible via aliases GET /v1/ingestion and GET /v1/ingestion/methods.
Response Example (200 OK)
{
"success": true,
"organizationId": "org_4f8a1290bb",
"organizationName": "Acme Health Systems",
"ingestionMethods": [
{
"id": "secure_email",
"name": "Secure Inbound Email",
"type": "SECURE_EMAIL",
"connector": "SECURE_EMAIL",
"status": "ACTIVE",
"details": {
"inboundEmailAddress": "[email protected]",
"supportedAttachments": ["PDF", "TIFF", "TIF", "PNG", "JPG", "JPEG", "DICOM"],
"encryption": "TLS 1.2+, SPF/DKIM Verification, HIPAA-Compliant AES-256 Storage",
"autoOcrExtraction": true,
"forwardingInstructions": "Forward scanned clinical records, fax attachments, or referral emails directly to your dedicated inbox address."
},
"description": "Direct email-to-fax & document ingestion via dedicated organizational inbox addresses."
},
{
"id": "scan_to_cloud",
"name": "Scan-to-Cloud & Network MFPs",
"type": "SCAN_TO_CLOUD",
"connector": "SCAN_TO_CLOUD",
"status": "ACTIVE",
"details": {
"endpointUrl": "https://api.intellectua.ai/v1/scan/upload",
"httpMethod": "POST",
"contentType": "multipart/form-data",
"supportedDevices": [
"Fujitsu ScanSnap iX1600 / iX1400",
"Xerox WorkCentre / VersaLink",
"Ricoh Aficio / IM Series",
"HP Enterprise LaserJet",
"Canon imageRUNNER ADVANCE",
"Brother TWAIN / SANE Stations"
],
"requiredHeaders": {
"Authorization": "Bearer <API_KEY>"
}
},
"description": "Direct REST multipart upload for physical clinic scanning stations, high-volume document scanners, and MFPs."
},
{
"id": "carrier_efax",
"name": "Telecom Carrier eFax (DIDs)",
"type": "CARRIER_EFAX",
"connector": "SINCH_EFAX",
"status": "ACTIVE",
"details": {
"activeNumberCount": 1,
"provisionedNumbers": [
{
"id": "pn_4f8a1290bb",
"number": "+14155552671",
"friendlyName": "Primary Clinical Intake",
"carrier": "SINCH",
"inboundRoutingNumber": "+14155552671",
"autoProcessAi": true
}
],
"connectedCarriers": ["SINCH"],
"webhookEndpoints": {
"SINCH": "https://api.intellectua.ai/webhooks/sinch/fax",
"RINGCENTRAL": "https://api.intellectua.ai/webhooks/ringcentral/fax"
}
},
"description": "Direct carrier inbound fax lines across Sinch, RingCentral, and Praxis."
},
{
"id": "direct_upload",
"name": "Intellectua UI Direct Upload",
"type": "DIRECT_UPLOAD",
"connector": "DIRECT_UPLOAD",
"status": "ACTIVE",
"details": {
"maxFileSizeMb": 50,
"supportedFormats": ["PDF", "TIFF", "PNG", "JPEG"],
"encryption": "Client-Side AES-256-GCM Envelope Encryption"
},
"description": "Manual browser drag-and-drop document upload with instant encryption and queue indexing."
},
{
"id": "developer_api",
"name": "Developer REST API",
"type": "API",
"connector": "DEVELOPER_API",
"status": "ACTIVE",
"details": {
"endpoints": [
{
"method": "POST",
"path": "/v1/documents",
"description": "Direct JSON or multipart document submission with custom metadata"
},
{
"method": "POST",
"path": "/v1/scan/upload",
"description": "Dedicated network scanner raw buffer ingestion"
}
],
"authentication": "Bearer <API_KEY> or Header 'x-api-key: <API_KEY>'"
},
"description": "Programmatic REST API for custom EMR integrations, EHR backends, and clinic workflow pipelines."
},
{
"id": "patient_portal",
"name": "Patient & Referring Provider Intake Portal",
"type": "PATIENT_PORTAL",
"connector": "PATIENT_PORTAL",
"status": "ACTIVE",
"details": {
"portalUrl": "https://app.intellectua.ai/portal/efmcm"
},
"description": "Secure, branded intake web portal for patients, referring specialists, and external medical clinics."
}
]
}Supported Ingestion Channels Summary
Secure Email
Inbound MX routing with SPF/DKIM verification. Automatically converts email attachments into indexed queue items.
Scan-to-Cloud
Direct REST multipart ingestion from network MFP workstations, Fujitsu ScanSnap stations, and TWAIN scanners.
Telecom eFax (DIDs)
Direct inbound fax webhook listening across Sinch, RingCentral, and Praxis carriers.
Direct UI Upload
Browser drag-and-drop file upload with client-side AES envelope encryption and real-time classification.
Developer REST API
Programmatic REST endpoints for custom EMR/EHR sync pipelines with Bearer API Key authentication.
Intake Portal
Branded zero-login web intake portal for patients, referring specialists, and partner medical practices.
