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.

Identity Verification

Verify the caller's identity.

Resource

1/connect/identity-verification/verification

Example URI

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

Available version

54.0

Requires Chatter

HTTP methods

POST

Request body for POST

Root XML tag

<verificationContext>

JSON example

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

Properties

Name	Type	Description	Required or Optional	Available Version
`processDefinition`	Process Definition Input	Represents the identity verification process definition.	Required	54.0
`selectedSearchResult`	Selected Search Result Input	Represents the details of the object and fields to appear in the search result.	Required	54.0
`verifiedResult`	Verified Result Input	Represents the verified result. Reserved for future use. Note	Optional	54.0

Response body for POST

Verification Context Output

JSON example

1{
2  "isSuccess" : true,
3  "message" : "Fetched verification information successfully for User Id : 001RM00000141414.",
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          "developerName" : "SampleAccountName",
17          "fieldName" : "Name",
18          "fieldType" : "optionalVerifier",
19          "label" : "Account Name"
20        }, {
21          "dataSourceType" : "Salesforce",
22          "developerName" : "SampleAccountNumber",
23          "fieldName" : "AccountNumber",
24          "fieldType" : "optionalVerifier",
25          "label" : "Account Number"
26        }, {
27          "dataSourceType" : "Salesforce",
28          "developerName" : "SamplePhone",
29          "fieldName" : "Phone",
30          "fieldType" : "optionalVerifier",
31          "label" : "Phone"
32        }, {
33          "dataSourceType" : "Salesforce",
34          "developerName" : "SamplePostalCode",
35          "fieldName" : "BillingPostalCode",
36          "fieldType" : "optionalVerifier",
37          "label" : "Billing Zip/Postal Code"
38        }, {
39          "dataSourceType" : "Salesforce",
40          "developerName" : "SampleAccount",
41          "fieldName" : "Name",
42          "fieldType" : "resultField",
43          "label" : "Account Name"
44        }, {
45          "dataSourceType" : "Salesforce",
46          "developerName" : "AccountNumberSample",
47          "fieldName" : "AccountNumber",
48          "fieldType" : "resultField",
49          "label" : "Account Number"
50        }, {
51          "dataSourceType" : "Salesforce",
52          "developerName" : "SamplePhoneNumber",
53          "fieldName" : "Phone",
54          "fieldType" : "resultField",
55          "label" : "Phone"
56        } ]
57      }
58    } ]
59  },
60  "selectedSearchResult" : {
61    "objectName" : "Account",
62    "selectedRecordId" : "001RM00000141414",
63    "selectedRecordObject" : [ {
64      "developerName" : "SampleAccountName",
65      "value" : "Joe Tester"
66    }, {
67      "developerName" : "SampleAccountNumber",
68      "value" : "10014"
69    }, {
70      "developerName" : "SamplePhone",
71      "value" : "6500000014"
72    }, {
73      "developerName" : "SamplePostalCode",
74      "value" : "94566"
75    }, {
76      "developerName" : "SampleAccount",
77      "value" : "Joe Tester"
78    }, {
79      "developerName" : "AccountNumberSample",
80      "value" : "10014"
81    }, {
82      "developerName" : "SamplePhoneNumber",
83      "value" : "6500000014"
84    } ]
85  },
86  "verifiedResult" : {
87    "optionalVerifiers" : [ {
88      "developerName" : "SampleAccountName",
89      "verificationState" : ""
90    }, {
91      "developerName" : "SampleAccountNumber",
92      "verificationState" : ""
93    }, {
94      "developerName" : "SamplePhone",
95      "verificationState" : ""
96    }, {
97      "developerName" : "SamplePostalCode",
98      "verificationState" : ""
99    } ],
100    "requiredVerifiers" : [ ]
101  }
102}

Agentforce Health Developer Guide

Identity Verification