Identity Verification Search

Search the Salesforce record to verify a caller’s identity.

Resource

1/connect/identity-verification/search

Example URI

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

Available version

54.0

Requires Chatter

HTTP methods

POST

Request body for POST

Root XML tag

<searchInput>

JSON example

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

Properties

Name	Type	Description	Required or Optional	Available Version
`searchTerm`	String	The search term for the account to use when performing a search.	Required	54.0
`verificationContext`	Verification Context Input	The structure that contains the setup data and context required to perform the search.	Required	54.0

Response body for POST

Search Output

JSON example

1{
2  "isSuccess" : true,
3  "message" : "Search is a success",
4  "searchResult" : [ {
5    "searchFields" : [ {
6      "developerName" : "SamplePhone",
7      "value" : "6500000014"
8    }, {
9      "developerName" : "AccountNumberSample",
10      "value" : "10014"
11    }, {
12      "developerName" : "SamplePhoneNumber",
13      "value" : "6500000014"
14    }, {
15      "developerName" : "SampleAccount",
16      "value" : "Joe Tester"
17    }, {
18      "developerName" : "SampleAccountName",
19      "value" : "Joe Tester"
20    }, {
21      "developerName" : "SampleAccountNumber",
22      "value" : "10014"
23    }, {
24      "developerName" : "SamplePostalCode",
25      "value" : "94566"
26    }, {
27      "developerName" : "Id",
28      "value" : "001RM00000141414"
29    } ]
30  } ],
31  "searchResultHeader" : [ {
32    "dataType" : "Phone",
33    "developerName" : "SamplePhone",
34    "displayLabel" : "Phone"
35  }, {
36    "dataType" : "Text",
37    "developerName" : "AccountNumberSample",
38    "displayLabel" : "Account Number"
39  }, {
40    "dataType" : "Phone",
41    "developerName" : "SamplePhoneNumber",
42    "displayLabel" : "Phone"
43  }, {
44    "dataType" : "Name",
45    "developerName" : "SampleAccount",
46    "displayLabel" : "Account Name"
47  }, {
48    "dataType" : "Name",
49    "developerName" : "SampleAccountName",
50    "displayLabel" : "Account Name"
51  }, {
52    "dataType" : "Text",
53    "developerName" : "SampleAccountNumber",
54    "displayLabel" : "Account Number"
55  }, {
56    "dataType" : "Text",
57    "developerName" : "SamplePostalCode",
58    "displayLabel" : "Billing Zip/Postal Code"
59  }, {
60    "dataType" : "Lookup",
61    "developerName" : "Id",
62    "displayLabel" : "Account ID"
63  } ]
64}

Salesforce Health Cloud Developer Guide

Identity Verification Search