OCR Text Extraction (GET, POST)

Retrieve details of the extracted key-value pairs for a document from the latest version of the OCR document scan result. Create an OCR document scan result record using the extracted text from the latest version of a document.

Resource

1/connect/form-reader/contentDocuments/${contentDocumentId}/ocrDocumentScanResults

Examples for GET

1https://yourInstance.salesforce.com/services/data/vXX.X/connect
2/form-reader/contentDocuments/069RM0000001ex5YAA/ocrDocumentScanResults

1https://yourInstance.salesforce.com/services/data/vXX.X/connect
2/form-reader/contentDocuments/069RM0000001ex5YAA/ocrDocumentScanResults?startPageIndex=1

1https://yourInstance.salesforce.com/services/data/vXX.X/connect
2/form-reader/contentDocuments/069RM0000001ex5YAA/ocrDocumentScanResults?endPageIndex=1

1https://yourInstance.salesforce.com/services/data/vXX.X/connect
2/form-reader/contentDocuments/069RM0000001ex5YAA/ocrDocumentScanResults?startPageIndex=1&endPageIndex=1

Example for POST

1https://yourInstance.salesforce.com/services/data/vXX.X/connect
2/form-reader/contentDocuments/069RM0000001ex5YAA/ocrDocumentScanResults

Available version

55.0

Requires Chatter

HTTP methods

GET, POST

Request parameters for GET

Parameter Name	Type	Description	Required or Optional	Available Version
`endPageIndex`	Integer	Page number in the document to end extraction.	Optional	55.0
`isCalledFromInvocableAction`	Boolean	Indicates whether the Connect API was invoked from an invocable action (`true`) or not (`false`). The default value is `false`. For internal use only. Note	Optional	58.0
`startPageIndex`	Integer	Page number in the document to start extraction.	Optional	55.0

Response body for GET

Document Extraction Output

Request body for POST

JSON examples

1{
2
3   "startPageIndex" : 4,
4   "endPageIndex" : 4
5}

1{
2   "startPageIndex" : 4
3}

1{
2   "endPageIndex" : 4
3}

1{
2   "ocrService" : "AMAZON_TEXTRACT_ANALYZED_ID"
3}

1{
2
3   "startPageIndex" : 4,
4   "endPageIndex" : 4,
5   "ocrService" : "AMAZON_TEXTRACT_ANALYZED_ID"
6}

Parameter Name	Type	Description	Required or Optional	Available Version
`endPageIndex`	Integer	Page number in the document to end extraction.	Optional	55.0
`startPageIndex`	Integer	Page number in the document to start extraction.	Optional	55.0
`ocrService`	String	Name of the service that gets the extraction results. Valid values are: `AMAZON_TEXTRACT`—Indicates AWS Document service. `AMAZON_TEXTRACT_ANALYZED_ID`—Indicates AWS Analyze ID service. The default value is `AMAZON_TEXTRACT`.	Optional	58.0

Response body for POST

Trigger Text Extraction Output

Industries Common Resources Developer Guide

OCR Text Extraction (GET, POST)