IdentityVerificationProcDef

This type extends the Metadata metadata type and inherits its fullName field.

Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations.

Important

File Suffix and Directory Location

IdentityVerificationProcDef components have the suffix .IdentityVerificationProcDef and are stored in the IdentityVerificationProcDefs folder.

Version

IdentityVerificationProcDef components are available in API version 55.0 and later.

Special Access Rules

The IdentityVerification org perm and IdentityVerificationUserAccess User perm are required to use this metadata type.

Fields

Field Name	Description
identityVerificationProcDtls	Field Type IdentityVerificationProcDtl[] Description Represents the search functionality configuration as well as the minimum number of optional verifiers for identity verification.
masterLabel	Field Type string Description Required. The label of the Identity Verification Process Definition record.
searchLayoutType	Field Type IdentityVerificationSearchLayoutType (enumeration of type string) Description Required. The display layout of the search component. Valid values are: `Stack` `Tab` Tab isn't supported in API version 54.0 and later. Note

IdentityVerificationProcDtl

Represents the search functionality configuration as well as the minimum number of optional verifiers for identity verification.

Field Name	Description
apexClass	Field Type string Description The ID of the Apex class.
dataSourceType	Field Type IdentityVerificationDataSourceType (enumeration of type string) Description Required. The source type of the data Valid values are: `External` `Salesforce`
developerName	Field Type string Description Required. Represents the name of the identity verification process detail. The developer name must be the same as the fullName field name. Note
identityVerificationProcFlds	Field Type IdentityVerificationProcFld[] Description Represents the search and verification fields used in identity verification.
isActive	Field Type boolean Description Indicates whether the record is active (`true`) or not (`false`). The default is `false`.
linkedIdVerfProcessDet	Field Type string Description Stores the identity verification process detail record use for the secondary or tertiary verification. For example, suppose you have two process detail records, Contact Process Detail and Account Process Detail, and Account Process Detail is linked to the contact process detail record. In this case, the contact process detail record is used for primary verification and the account process detail record is used for secondary verification. Then, if your business requirement is to configure a third-level verification process, create another process detail record and set the value of the LinkedIdVerfProcessDetId field in the account process detail record to the third process detail record. Similarly, you can configure more than three levels of verification using this field. You can link process detail records that look up to the same identity verification process definition. Also, you can link to a process detail record that has `LinkedIdVerfProcessDets:null`. You cannot map to an already mapped detail. Here is an example of a valid linked ID verification process detail: `1detail1{ 2 LinkedIdVerfProcessDets:null 3}, 4detail2{ 5 LinkedIdVerfProcessDets:details1 6} 7detail3{ 8 LinkedIdVerfProcessDets:detail1 9}` Here is an example of an invalid linked ID verification process detail: `1detail1{ 2 LinkedIdVerfProcessDets:null 3}, 4detail2{ 5 LinkedIdVerfProcessDets:details1 6} 7detail3{ 8 LinkedIdVerfProcessDets:detail2 9}`
masterLabel	Field Type string Description Required. The label of the Identity Verification Process Detail record.
objectName	Field Type string Description The name of the object on which the search is performed and data is verified.
optionalVerifiersMinVerfCount	Field Type int Description The minimum number of additional verifiers that must be checked.
searchFilter	Field Type string Description Conditions to filter the search results. For example, if you want to perform the search only on Person Account records, enter `isPersonAccount = true`.
searchRecordUniqueIdField	Field Type string Description The field storing the unique identifier of records displayed in the search results.
searchResultSortBy	Field Type string Description The values that are used to sort the search results. For example, if you want to sort the results by policy date, enter PolicyDate__c Desc.
searchSequenceNumber	Field Type int Description Required. The sequence in which the search is performed and the search result is displayed.
searchType	Field Type IdentityVerificationSearchType (enumeration of type string) Description Required. The type of search being performed. Valid values are: `Object-Based` `Text-Based`

IdentityVerificationProcFld

Represents the search and verification fields used in identity verification.

Field Name	Description
customFieldLabel	Field Type string Description The custom label for the field that contains the verification data.
dataSourceType	Field Type IdentityVerificationProcFldDataSourceType (enumeration of type string) Description Required. The source type of the data. Valid values are: `External` `Salesforce`
developerName	Field Type string Description Required. Represents the name of the verification field. The developer name must be the same as the fullName field name. Note
fieldDataType	Field Type string Description The data type of a field in an external data source. Valid values are: `address` `checkbox` `currency` `dateonly` `datetime` `email` `number` `percent` `phone` `picklist` `reference` `text` `timeonly` `url` `other`
fieldName	Field Type string Description Required. The label of the field that contains the verification data based on the selected field type.
fieldType	Field Type IdentityVerificationProcFldFieldType (enumeration of type string) Description Required. The type of field. Valid values are: `additionalResultField`—To fetch data as part of the search query, but the data isn’t displayed in search results. Suppose you want to fetch the policy number and the age of the policy owner as a result of the search but the agent isn’t supposed to see this data. You can write custom logic to process this additional data. `optionalVerifier`—To fetch data used to ask additional verification questions. In API version 56.0 and later, you can display additional verifiers based on fields from the object configured for verification’s parent object. For example, if you set identity verification on the Contact object, you can display fields from the Account object. Note `requiredVerifier`—To fetch data used to ask required verification questions. In API version 56.0 and later, you can display required verifiers based on fields from the object configured for verification’s parent object. For example, if you set identity verification on the Contact object, you can display fields from the Account object. Note `resultField`—To display in search results. For example, when an agent searches for a caller, you’d like the search results to include the account name, phone number, and email ID. `searchField`—To perform object-based search. `searchFilter`—Filters search results. When this is set as the field type, specify the field name to filter search results using the FieldName field. Both static and dynamic filtering are supported. For example, to search for Contacts whose related Account ID is always `001xx000003GZ4lAAG`, set `AccountId` as the field name and the value of `FieldValueFormula` to `001xx000003GZ4lAAG`. Or, if an agent verifies a customer (Account) and then performs a secondary search against all policies (Policy) in which the verified customer is the policy holder, set `FieldName` to `PolicyHolder` and `FieldValueFormula` to the dynamic value `{!SelectedParentRecordId}`. This value is available from API version 56.0 and later. You can only use record IDs to dynamically filter search results. Note
fieldValueFormula	Field Type string Description Stores the formula that's applied to the field value.
isActive	Field Type boolean Description Indicates whether the record is active (`true`) or not (`false`). The default value is `false`.
masterLabel	Field Type string Description Required. The label of the Identity Verification Process Field record.
sequenceNumber	Field Type int Description Required. The sequence number of the field.

Declarative Metadata Sample Definition

The following is an example of an IdentityVerificationProcDef component.

1<IdentityVerificationProcDef
2	xmlns="http://soap.sforce.com/2006/04/metadata">
3	<identityVerificationProcDtls>
4		<fullName>Sample93AccountSearch</fullName>
5		<dataSourceType>External</dataSourceType>
6		<developerName>Sample93AccountSearch</developerName>
7		<identityVerificationProcFlds>
8			<fullName>Sample93AccountName</fullName>
9			<dataSourceType>External</dataSourceType>
10			<developerName>Sample93AccountName</developerName>
11			<fieldName>Name</fieldName>
12			<fieldType>requiredVerifier</fieldType>
13			<isActive>false</isActive>
14			<masterLabel>Sample93 Account Name</masterLabel>
15			<fieldValueFormula>abcd</fieldValueFormula>
16			<customFieldLabel>Name</customFieldLabel>
17			<sequenceNumber>1</sequenceNumber>
18		</identityVerificationProcFlds>
19		<identityVerificationProcFlds>
20			<fullName>Sample93Phone</fullName>
21			<dataSourceType>External</dataSourceType>
22			<developerName>Sample93Phone</developerName>
23			<fieldName>phone21231</fieldName>
24			<fieldType>optionalVerifier</fieldType>
25			<isActive>false</isActive>
26			<masterLabel>Sample93 Phone</masterLabel>
27			<sequenceNumber>93</sequenceNumber>
28		</identityVerificationProcFlds>
29		<identityVerificationProcFlds>
30			<fullName>Sample93PostalCode</fullName>
31			<dataSourceType>External</dataSourceType>
32			<developerName>Sample93PostalCode</developerName>
33			<fieldName>BillingPostalCode</fieldName>
34			<fieldType>optionalVerifier</fieldType>
35			<isActive>true</isActive>
36			<masterLabel>Sample93 Postal Code</masterLabel>
37			<sequenceNumber>4</sequenceNumber>
38		</identityVerificationProcFlds>
39		<identityVerificationProcFlds>
40			<fullName>Sample93Account</fullName>
41			<dataSourceType>External</dataSourceType>
42			<developerName>Sample93Account</developerName>
43			<fieldName>Name</fieldName>
44			<fieldType>resultField</fieldType>
45			<isActive>false</isActive>
46			<masterLabel>Sample93 Account</masterLabel>
47			<sequenceNumber>1</sequenceNumber>
48		</identityVerificationProcFlds>
49		<isActive>true</isActive>
50		<masterLabel>Sample93 Account Search</masterLabel>
51		<objectName>Account</objectName>
52		<searchRecordUniqueIdField>Id</searchRecordUniqueIdField>
53		<searchSequenceNumber>1</searchSequenceNumber>
54		<searchType>Text-Based</searchType>
55		<searchResultSortBy>desc</searchResultSortBy>
56		<optionalVerifiersMinVerfCount>1</optionalVerifiersMinVerfCount>
57		<searchFilter>string</searchFilter>
58	</identityVerificationProcDtls>
59	<masterLabel>Sample93 Verification Flow</masterLabel>
60	<searchLayoutType>Tab</searchLayoutType>
61</IdentityVerificationProcDef>

The following is an example package.xml that references the previous definition.

1<?xml version="1.0" encoding="UTF-8"?>
2<Package
3	xmlns="http://soap.sforce.com/2006/04/metadata">
4	<types>
5		<members>*</members>
6		<name>IdentityVerificationProcDef</name>
7	</types>
8	<version>55.0</version>
9</Package>

Wildcard Support in the Manifest File

This metadata type supports the wildcard character * (asterisk) in the package.xml manifest file. For information about using the manifest file, see Deploying and Retrieving Metadata with the Zip File.

Industries Common Resources Developer Guide