Build Identity Verification Context

Resource

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

Example URI

Replace {yourInstance.salesforce.com} with the My Domain host of your Salesforce org, and replace {vXX.X} with the API version, including the leading v.

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

Available Version

54.0

Requires Chatter

No

HTTP Methods

POST

Root XML tag

<buildVerificationContextInput>

JSON example

{
   "objectName":"Account",
   "selectedRecordId":"001xx000003GZeFAAW"
}

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

{
  "isSuccess" : true,
  "message" : "Build Context for Identity Verification API called successfully for Process Definition: SampleVerificationFlow",
  "processDefinition" : {
    "layoutType" : "Tab",
    "processDetail" : [ {
      "dataSourceType" : "Salesforce",
      "optionalVerifierCount" : 1,
      "searchObjectName" : "Account",
      "searchResultUniqueIdField" : "Id",
      "searchSequenceNo" : 1,
      "searchType" : "Text-Based",
      "verificationProcessFieldList" : {
        "verificationProcessFields" : [ {
          "dataSourceType" : "Salesforce",
          "dataType" : "Name",
          "developerName" : "SampleAccountName",
          "fieldName" : "Name",
          "fieldType" : "optionalVerifier",
          "label" : "Account Name"
        }, {
          "dataSourceType" : "Salesforce",
          "dataType" : "Text",
          "developerName" : "SampleAccountNumber",
          "fieldName" : "AccountNumber",
          "fieldType" : "optionalVerifier",
          "label" : "Account Number"
        }, {
          "dataSourceType" : "Salesforce",
          "dataType" : "Phone",
          "developerName" : "SamplePhone",
          "fieldName" : "Phone",
          "fieldType" : "optionalVerifier",
          "label" : "Phone"
        }, {
          "dataSourceType" : "Salesforce",
          "dataType" : "Text",
          "developerName" : "SamplePostalCode",
          "fieldName" : "BillingPostalCode",
          "fieldType" : "optionalVerifier",
          "label" : "Billing Zip/Postal Code"
        }, {
          "dataSourceType" : "Salesforce",
          "dataType" : "Name",
          "developerName" : "SampleAccount",
          "fieldName" : "Name",
          "fieldType" : "resultField",
          "label" : "Account Name"
        }, {
          "dataSourceType" : "Salesforce",
          "dataType" : "Text",
          "developerName" : "AccountNumberSample",
          "fieldName" : "AccountNumber",
          "fieldType" : "resultField",
          "label" : "Account Number"
        }, {
          "dataSourceType" : "Salesforce",
          "dataType" : "Phone",
          "developerName" : "SamplePhoneNumber",
          "fieldName" : "Phone",
          "fieldType" : "resultField",
          "label" : "Phone"
        } ]
      }
    } ]
  },
  "selectedSearchResult" : {
    "selectedRecordObject" : [ ]
  },
  "verifiedResult" : {
    "optionalVerifiers" : [ ],
    "requiredVerifiers" : [ ]
  }
}