Resource
/connect/identity-verification/verification
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/verification
Available Version
54.0
Requires Chatter
No
HTTP Methods
POST
Root XML tag
<verificationContext>
JSON example
{
"processDefinition":{
"layoutType":"Tab",
"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"
}
]
}
},
"selectedSearchResult":{
"objectName":"Account",
"selectedRecordId":"001RM00000141414",
"selectedRecordObject":{
"selectedRecordObjectList":[]
}
}
}
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. Note: Reserved for future use. |
Optional | 54.0 |
Response Body for POST
JSON Example
{
"isSuccess" : true,
"message" : "Fetched verification information successfully for User Id : 001RM00000141414.",
"processDefinition" : {
"layoutType" : "Tab",
"processDetail" : [ {
"dataSourceType" : "Salesforce",
"optionalVerifierCount" : 1,
"searchObjectName" : "Account",
"searchResultUniqueIdField" : "Id",
"searchSequenceNo" : 1,
"searchType" : "Text-Based",
"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"
} ]
}
} ]
},
"selectedSearchResult" : {
"objectName" : "Account",
"selectedRecordId" : "001RM00000141414",
"selectedRecordObject" : [ {
"developerName" : "SampleAccountName",
"value" : "Joe Tester"
}, {
"developerName" : "SampleAccountNumber",
"value" : "10014"
}, {
"developerName" : "SamplePhone",
"value" : "6500000014"
}, {
"developerName" : "SamplePostalCode",
"value" : "94566"
}, {
"developerName" : "SampleAccount",
"value" : "Joe Tester"
}, {
"developerName" : "AccountNumberSample",
"value" : "10014"
}, {
"developerName" : "SamplePhoneNumber",
"value" : "6500000014"
} ]
},
"verifiedResult" : {
"optionalVerifiers" : [ {
"developerName" : "SampleAccountName",
"verificationState" : ""
}, {
"developerName" : "SampleAccountNumber",
"verificationState" : ""
}, {
"developerName" : "SamplePhone",
"verificationState" : ""
}, {
"developerName" : "SamplePostalCode",
"verificationState" : ""
} ],
"requiredVerifiers" : [ ]
}
}