Note: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.

Build Identity Verification Context

Build the context required to perform identity verification.

Resource

1/connect/identity-verification/build-context/${processDefinitionName}

Example URI

1https://yourInstance.salesforce.com/services/data/vXX.X
2/connect/identity-verification/build-context/SampleVerificationFlow

Available version

54.0

Requires Chatter

HTTP methods

POST

Request body for POST

Root XML tag

<buildVerificationContextInput>

JSON example

1{
2   "objectName":"Account",
3   "selectedRecordId":"001xx000003GZeFAAW"
4}

Properties

Name	Type	Description	Required or Optional	Available Version
`objectName`	String	The API name of the caller’s object.	Optional	54.0
`selectedRecordId`	String	The record ID of the caller.	Optional	54.0

Response body for POST

Verification Context Output

JSON example

1{
2  "isSuccess" : true,
3  "message" : "Build Context for Identity Verification API called successfully for Process Definition: SampleVerificationFlow",
4  "processDefinition" : {
5    "layoutType" : "Tab",
6    "processDetail" : [ {
7      "dataSourceType" : "Salesforce",
8      "optionalVerifierCount" : 1,
9      "searchObjectName" : "Account",
10      "searchResultUniqueIdField" : "Id",
11      "searchSequenceNo" : 1,
12      "searchType" : "Text-Based",
13      "verificationProcessFieldList" : {
14        "verificationProcessFields" : [ {
15          "dataSourceType" : "Salesforce",
16          "dataType" : "Name",
17          "developerName" : "SampleAccountName",
18          "fieldName" : "Name",
19          "fieldType" : "optionalVerifier",
20          "label" : "Account Name"
21        }, {
22          "dataSourceType" : "Salesforce",
23          "dataType" : "Text",
24          "developerName" : "SampleAccountNumber",
25          "fieldName" : "AccountNumber",
26          "fieldType" : "optionalVerifier",
27          "label" : "Account Number"
28        }, {
29          "dataSourceType" : "Salesforce",
30          "dataType" : "Phone",
31          "developerName" : "SamplePhone",
32          "fieldName" : "Phone",
33          "fieldType" : "optionalVerifier",
34          "label" : "Phone"
35        }, {
36          "dataSourceType" : "Salesforce",
37          "dataType" : "Text",
38          "developerName" : "SamplePostalCode",
39          "fieldName" : "BillingPostalCode",
40          "fieldType" : "optionalVerifier",
41          "label" : "Billing Zip/Postal Code"
42        }, {
43          "dataSourceType" : "Salesforce",
44          "dataType" : "Name",
45          "developerName" : "SampleAccount",
46          "fieldName" : "Name",
47          "fieldType" : "resultField",
48          "label" : "Account Name"
49        }, {
50          "dataSourceType" : "Salesforce",
51          "dataType" : "Text",
52          "developerName" : "AccountNumberSample",
53          "fieldName" : "AccountNumber",
54          "fieldType" : "resultField",
55          "label" : "Account Number"
56        }, {
57          "dataSourceType" : "Salesforce",
58          "dataType" : "Phone",
59          "developerName" : "SamplePhoneNumber",
60          "fieldName" : "Phone",
61          "fieldType" : "resultField",
62          "label" : "Phone"
63        } ]
64      }
65    } ]
66  },
67  "selectedSearchResult" : {
68    "selectedRecordObject" : [ ]
69  },
70  "verifiedResult" : {
71    "optionalVerifiers" : [ ],
72    "requiredVerifiers" : [ ]
73  }
74}

Agentforce Health Developer Guide

Build Identity Verification Context