Process Received Document Action

Create a record with the processed results of the specified received document.

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/v63.0/actions/standard/processReceivedDocument
Formats: JSON, XML
HTTP Methods: POST
Authentication: Authorization: Bearer token

Inputs

Input	Details
additionalFields	Type sObject Description 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	Type string Description 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	Type boolean Description Indicates whether to ignore conflicts in Optical Character Recognition (OCR) (`true`) or not (`false`). The default value is `false`.
objectApiName	Type string Description API name of the target object to create or update a record for.
overrideConfidenceScoreThreshold	Type integer Description Conflict confidence score threshold value to use for the extracted value.
receivedDocumentId	Type string Description Required. ID of the received document record to process.
recordTypeId	Type string Description ID of the record type of the target object to create a record for.
templateApiName	Type string Description API name of the template with the Intelligent Document Reader field mappings to use to process the received document.

Outputs

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

Example

POST

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

1{ 
2  "inputs" : [
3    {
4      "receivedDocumentId" : "0ioRM00000002nPYAQ",
5      "objectApiName" : "Demo__c",
6      "templateApiName" : "InsuranceCard",
7      "recordTypeId" : "012RM0000005c7bYAA",
8      "documentTypeId" : "0deRM00000000GnYAI"
9    }
10  ]
11}

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

1[
2  {
3    "actionName": "processReceivedDocument",
4    "errors": null,
5    "isSuccess": true,
6    "outputValues": {
7      "recordId": "a00RM000001DZ6ZYAW"
8    }
9  }
10]

Salesforce Health Cloud Developer Guide