Form Reader Mappings (POST)

Retrieve the mappings between the values of the keys extracted from the document to the Salesforce object fields with respect to a given template.

Permission

To use this resource, you must have the EinsteinDocReader permission and the Intelligent Form Reader feature enabled in your Salesforce organization.

Usage

Use the corresponding template ID and the scan result ID for the OCR document scan result (ODSR) record of the document from which you want to fetch the values. Using the values from the document and field mapping from the template, you get the mapping between values and target field based on the key in both the document and template.

Here’s a sample of how the Salesforce UI displays mapping of form types to objects:

A representation of the map form types to objects Mapping screen.

Resource

1/connect/form-reader/mapping

Example

1https://{yourInstance}.salesforce.com/services/data/vXX.X/connect
2/form-reader/mapping

{yourInstance} is the domain name of your Salesforce instance.

Available Version

54.0

Requires Chatter

HTTP Methods

POST

See Also

Request Body for POST

JSON Example

1{
2   "scanResultId" : "0ixS7000000001TIAQ",
3   "templateId" : "48tS70000004C9DIAU"
4}

Properties

Name	Type	Description	Required or Optional	Available Version
isExactMatch	Boolean	Indicates whether the mapping between values and target field must be returned only when the key matches in both the document and template (`true`) or not (`false`). Default value is `true`.	Optional	55.0
`scanResultId`	String	The ID of the OCR document scan result. The scan result contains the contents of a document after optical character recognition (OCR) processing.	Required	54.0
`templateId`	String	The ID of the OCR template. This represents the details of the mapping between a document and a Salesforce object using Intelligent Form Reader.	Required	54.0

Response Body for POST

Form Reader Map Output