File Extract

Returns the extraction status, extracted data (if extraction succeeded), and the created DCI record ID (if applicable).

Property NameTypeDescriptionFilter Group and VersionAvailable Version
dciRecordIdStringID of the created Document Checklist Item record. Returned only when the input included a recordId and DCI creation succeeded.Big, 67.067.0
extractedDataStringData extracted from the input file, in JSON format. Returned only when extractionStatus is EXTRACTED.Big, 67.067.0
extractionStatusStringAlways returned. Indicates whether data was extracted from the file. Values are:
  • EXTRACTED—Document AI returned data and created a Document Checklist Item record (if applicable).
  • SKIPPED—Extraction was skipped because the file didn’t meet requirements. When the status is SKIPPED, extractedData and dciRecordId aren’t returned. See skipReason for details.
Big, 67.067.0
skipReasonStringReturned only when extractionStatus is SKIPPED. Specifies why extraction was skipped. Values are:
  • FILE_TOO_LARGE—File exceeds the 10 MB size limit.
  • UNSUPPORTED_MIME—File type isn’t supported. Supported types: application/pdf, image/jpeg, and image/png.
Big, 67.067.0

See Also

Public Sector Data Models
Public Sector Standard Objects
Public Sector Associated Objects
Public Sector Namespaces
Apex Reference
Public Sector APIs
REST Reference
Resources
Request Bodies
Response Bodies
Action Plan Output
Action Plan Template
Action Plan Template Items
Action Plan Template Item
Action Plan Template List
Benefit Assignment List
Benefit Assignment
Benefit List
Benefit Output
Care Plan Output
Care Plan Benefit Session Output
Care Plan Benefit Session Info List
Care Plan Benefit Session Info
Care Plan Session Enrollee Info List
Care Plan Session Enrollee Info
Care Plan Definition Output
Care Plan Generic Output
Care Plan Task
Care Plan Tasks
Care Plan Task List
Care Plan Template
Care Plan Template Benefit
Care Plan Template Benefit List
Care Plan Template Goal
Care Plan Template Goal List
Claim Collection Output
Claim Error
Claim Item Result
Claim Payment Request Error
Claim Payment Request Result
Claim Result
Claim Submission Result
Claims Submit Output
Content Document Link Result
Content Hub External Upload Request Output
Content Hub File Upload Output
Custom Field
Custom Field List
Document Result
Evaluation Output Variables
External Storage Search Response
External Storage Search Result
External Storage Search Status
File Extract
Goal Assignment List
Goal Assignment
Goal Definition List
Goal Definition Output
Integrated Application Benefit Amounts List
Integrated Application Benefit Amounts
Integrated Application Benefits List
Integrated Application Benefits
Integrated Application Data
Merge Extractions
Problem Definition Output
Regulatory Transaction Fee Recompute Output
Tax Activity Section
Tax Constituent Activity
Tax Document
Tax Document Item
Tax Filing
Tax Filing Address
Tax Filing Assessment
Tax Filing Line Item
Tax Filing Line Item Assessment
Tax Filing Participant
Tax Payment
Tax Refund
Tax Revenue Profile
Tax Revenue Profile Tax Account
Public Sector Standard Invocable Actions
Public Sector Tooling API Objects
Public Sector Metadata API Types
StandardValueSet Names and Standard Picklist Fields
Upload Files to Amazon S3
Accounting Subledger
Industries Common Resources
Tax and Revenue Management
Previous Versions