Public Sector Developer Guide

Public Sector Data Models
Public Sector Standard Objects
PublicSectrSltn Namespace
Public Sector APIs
REST Reference
Resources
Action Plan Templates (GET, POST)
Benefit Disbursements (POST)
Benefit Sessions of a Care Plan (GET)
Cancel File Upload
Care Plans (GET, PATCH)
Care Plans (POST)
Care Plan Definitions (GET)
Care Plan Templates (GET)
Care Plan Templates (POST)
Claims (POST)
Complete File Upload
External Storage Search Status (GET)
Initiate File Upload
Intelligent Application Processing Extract (POST)
Recompute Regulatory Transaction Fee (POST)
Tax Constituent Activity (POST)
Tax Revenue Profile (POST)
Search External Storage (POST)
Request Bodies
Response Bodies
Public Sector Standard Invocable Actions
Public Sector Tooling API Objects
Public Sector Metadata API Types
Public Sector Associated Objects
StandardValueSet Names and Standard Picklist Fields
Upload Files to Amazon S3
Accounting Subledger
Action Launcher
Business Rules Engine
Criteria-Based Search and Filter
Decision Explainer
Discovery Framework
Engagement
Group Membership and Households
Identity Verification
Intelligent Document Reader
Interest Tagging
Omnistudio Business REST APIs
Outcome Management Developer Guide
Record Alerts
Record Rollup Definitions
Service Process Studio
Tax and Revenue Management
Timeline
PDF

Intelligent Application Processing Extract (POST)

Extract data from an uploaded file by using Unstructured Document Processing, and optionally create a Document Checklist Item (DCI) record.
Resource
1/connect/intelligent-application-processing/extract
Available version
67.0 and later
HTTP methods
POST
Request body for POST
Intelligent Application Processing Extract Input
Response body for POST
Intelligent Application Processing Extract Output

Usage

Send a POST request with a ContentVersion ID and an Intelligent Document Processing (IDP) configuration. Unstructured Document Processing extracts structured data from the file. When extraction succeeds, the response includes the extracted data as a JSON string. When you also pass a context recordId, the resource can create a Document Checklist Item record and return its ID.

This resource uses POST because the request body is structured JSON, not because the operation updates a record.

Limitations

  • Maximum file size is 10 MB. Larger files return extractionStatus of SKIPPED with skipReason of FILE_TOO_LARGE.
  • Supported MIME types are application/pdf, image/jpeg, and image/png. Other types return extractionStatus of SKIPPED with skipReason of UNSUPPORTED_MIME.

Response Status Codes

Status Code Description
200 The request completed. Check extractionStatus to determine whether data was extracted or skipped.
400 The request failed validation or the search query is invalid.
500 The request failed due to an internal server error.