IdentityVerificationProcDef

Represents the definition of the identity verification process.

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

Parent Type 

This type extends Metadata and inherits its fields.

File Suffix and Directory Location 

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

Version 

Introduced in API version 54.0.

Special Access Rules 

The Health Cloud permission set license is required to use this metadata type.

Fields 

identityVerificationProcDtls 

masterLabel 

  • Type: string

  • Required: Yes

  • Description: Required.

    The label of the Identity Verification Process Definition record.

searchLayoutType 

  • Type: IdentityVerificationSearchLayoutType (enumeration of type string)
  • Required: Yes
  • Description: Required.

Declarative Metadata Sample Definition 

This is an example of an IdentityVerificationProcDef component.

1<?xml version="1.0" encoding="UTF-8"?>
2<IdentityVerificationProcDef xmlns="http://soap.sforce.com/2006/04/metadata">
3   <identityVerificationProcDtls>
4      <fullName>Sample93AccountSearch</fullName>
5      <dataSourceType>Salesforce</dataSourceType>
6      <developerName>Sample93AccountSearch</developerName>
7      <identityVerificationProcFlds>
8         <fullName>Sample93AccountName</fullName>
9         <dataSourceType>Salesforce</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         <isManualInput>false</isManualInput>
19      </identityVerificationProcFlds>
20      <identityVerificationProcFlds>
21         <fullName>Sample93Phone</fullName>
22         <dataSourceType>Salesforce</dataSourceType>
23         <developerName>Sample93Phone</developerName>
24         <fieldName>phone</fieldName>
25         <fieldType>optionalVerifier</fieldType>
26         <isActive>false</isActive>
27         <masterLabel>Sample93 Phone</masterLabel>
28         <sequenceNumber>93</sequenceNumber>
29         <isManualInput>false</isManualInput>
30      </identityVerificationProcFlds>
31      <identityVerificationProcFlds>
32         <fullName>Sample93PostalCode</fullName>
33         <dataSourceType>Salesforce</dataSourceType>
34         <developerName>Sample93PostalCode</developerName>
35         <fieldName>BillingPostalCode</fieldName>
36         <fieldType>optionalVerifier</fieldType>
37         <isActive>true</isActive>
38         <masterLabel>Sample93 Postal Code</masterLabel>
39         <sequenceNumber>4</sequenceNumber>
40         <isManualInput>false</isManualInput>
41      </identityVerificationProcFlds>
42      <identityVerificationProcFlds>
43         <fullName>Sample93Account</fullName>
44         <dataSourceType>Salesforce</dataSourceType>
45         <developerName>Sample93Account</developerName>
46         <fieldName>Name</fieldName>
47         <fieldType>resultField</fieldType>
48         <isActive>false</isActive>
49         <masterLabel>Sample93 Account</masterLabel>
50         <sequenceNumber>1</sequenceNumber>
51         <isManualInput>false</isManualInput>
52      </identityVerificationProcFlds>
53      <isActive>true</isActive>
54      <masterLabel>Sample93 Account Search</masterLabel>
55      <objectName>Account</objectName>
56      <searchRecordUniqueIdField>Id</searchRecordUniqueIdField>
57      <searchSequenceNumber>1</searchSequenceNumber>
58      <searchType>Text-Based</searchType>
59      <searchResultSortBy>Name</searchResultSortBy>
60      <optionalVerifiersMinVerfCount>1</optionalVerifiersMinVerfCount>
61      <isRetryAllowedAfterLimit>false</isRetryAllowedAfterLimit>
62      <retryLimit>5</retryLimit>
63      <searchFilter></searchFilter>
64      <displayRecordFieldName>LastModifiedById</displayRecordFieldName>
65   </identityVerificationProcDtls>
66   <masterLabel>Sample93 Verification Flow</masterLabel>
67   <searchLayoutType>Tab</searchLayoutType>
68</IdentityVerificationProcDef>

This is an example package.xml that references the previous definition.

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