Identity Verification Search

Search the Salesforce record to verify a caller’s identity.
Resource
/connect/identity-verification/search
Example URI
https://yourInstance.salesforce.com/services/data/vXX.X/connect/identity-verification/search
Available version
54.0
Requires Chatter
No
HTTP methods
POST
Request body for POST
Root XML tag
<searchInput>
JSON example
{
   "searchTerm":"Joe Tester",
   "verificationContext":{
      "processDefinition":{
         "processDetail":{
            "processDetailList":[
               {
                  "verificationProcessFieldList":{
                     "verificationProcessFields":[
                          {
                            "dataSourceType" : "Salesforce",
                            "developerName" : "SampleAccountName",
                            "fieldName" : "Name",
                            "fieldType" : "optionalVerifier",
                            "label" : "Account Name"
                          }, {
                            "dataSourceType" : "Salesforce",
                            "developerName" : "SampleAccountNumber",
                            "fieldName" : "AccountNumber",
                            "fieldType" : "optionalVerifier",
                            "label" : "Account Number"
                          }, {
                            "dataSourceType" : "Salesforce",
                            "developerName" : "SamplePhone",
                            "fieldName" : "Phone",
                            "fieldType" : "optionalVerifier",
                            "label" : "Phone"
                          }, {
                            "dataSourceType" : "Salesforce",
                            "developerName" : "SamplePostalCode",
                            "fieldName" : "BillingPostalCode",
                            "fieldType" : "optionalVerifier",
                            "label" : "Billing Zip/Postal Code"
                          }, {
                            "dataSourceType" : "Salesforce",
                            "developerName" : "SampleAccount",
                            "fieldName" : "Name",
                            "fieldType" : "resultField",
                            "label" : "Account Name"
                          }, {
                            "dataSourceType" : "Salesforce",
                            "developerName" : "AccountNumberSample",
                            "fieldName" : "AccountNumber",
                            "fieldType" : "resultField",
                            "label" : "Account Number"
                          }, {
                            "dataSourceType" : "Salesforce",
                            "developerName" : "SamplePhoneNumber",
                            "fieldName" : "Phone",
                            "fieldType" : "resultField",
                            "label" : "Phone"
                          }
                     ]
                  },
                  "searchType": "Text-Based",
                  "searchSequenceNo": 1,
                  "searchResultUniqueIdField": "Id",
                  "searchObjectName": "Account",
                  "optionalVerifierCount": 1,
                  "dataSourceType": "Salesforce"
               }
            ]
         }
      }
   }
}
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
{
  "isSuccess" : true,
  "message" : "Search is a success",
  "searchResult" : [ {
    "searchFields" : [ {
      "developerName" : "SamplePhone",
      "value" : "6500000014"
    }, {
      "developerName" : "AccountNumberSample",
      "value" : "10014"
    }, {
      "developerName" : "SamplePhoneNumber",
      "value" : "6500000014"
    }, {
      "developerName" : "SampleAccount",
      "value" : "Joe Tester"
    }, {
      "developerName" : "SampleAccountName",
      "value" : "Joe Tester"
    }, {
      "developerName" : "SampleAccountNumber",
      "value" : "10014"
    }, {
      "developerName" : "SamplePostalCode",
      "value" : "94566"
    }, {
      "developerName" : "Id",
      "value" : "001RM00000141414"
    } ]
  } ],
  "searchResultHeader" : [ {
    "dataType" : "Phone",
    "developerName" : "SamplePhone",
    "displayLabel" : "Phone"
  }, {
    "dataType" : "Text",
    "developerName" : "AccountNumberSample",
    "displayLabel" : "Account Number"
  }, {
    "dataType" : "Phone",
    "developerName" : "SamplePhoneNumber",
    "displayLabel" : "Phone"
  }, {
    "dataType" : "Name",
    "developerName" : "SampleAccount",
    "displayLabel" : "Account Name"
  }, {
    "dataType" : "Name",
    "developerName" : "SampleAccountName",
    "displayLabel" : "Account Name"
  }, {
    "dataType" : "Text",
    "developerName" : "SampleAccountNumber",
    "displayLabel" : "Account Number"
  }, {
    "dataType" : "Text",
    "developerName" : "SamplePostalCode",
    "displayLabel" : "Billing Zip/Postal Code"
  }, {
    "dataType" : "Lookup",
    "developerName" : "Id",
    "displayLabel" : "Account ID"
  } ]
}