Process Received Document Action

This action is available in API version 59.0 and later.

Special Access Rules

The Document Checklist and Intelligent Document Workspace permission set licenses are required to access the Process Received Document action.

Supported REST HTTP Methods

URI: /services/data/vXX.X/actions/standard/processReceivedDocument

Where XX.X is the latest API version.

Formats: JSON, XML

HTTP Methods: POST

Authentication: Authorization: Bearer TOKEN

Where TOKEN is your OAuth access token.

Inputs

Input	Type	Description
additionalFields	sObject	Record containing the additional fields to create or update in the target object, which aren't present in the Intelligent Document Reader field mappings.
documentTypeId	string	ID of the document type record that’s used in the template with the Intelligent Document Reader field mappings to use to process the received document.
ignoreFieldValueConflict	boolean	Indicates whether to ignore conflicts in Optical Character Recognition (OCR) (`true`) or not (`false`). The default value is `false`.
objectApiName	string	API name of the target object to create or update a record for.
overrideConfidenceScoreThreshold	integer	Conflict confidence score threshold value to use for the extracted value.
receivedDocumentId	string	Required. ID of the received document record to process.
recordTypeId	string	ID of the record type of the target object to create a record for.
templateApiName	string	API name of the template with the Intelligent Document Reader field mappings to use to process the received document.

Outputs

Output	Type	Description
recordId	string	ID of the record created by the action.

Example

POST

Here’s a sample request for the Process Received Document action.

{ 
  "inputs" : [
    {
      "receivedDocumentId" : "0ioRM00000002nPYAQ",
      "objectApiName" : "Demo__c",
      "templateApiName" : "InsuranceCard",
      "recordTypeId" : "012RM0000005c7bYAA",
      "documentTypeId" : "0deRM00000000GnYAI"
    }
  ]
}

Here’s a sample response for the Process Received Document action.

[
  {
    "actionName": "processReceivedDocument",
    "errors": null,
    "isSuccess": true,
    "outputValues": {
      "recordId": "a00RM000001DZ6ZYAW"
    }
  }
]