IdentityVerificationProcDef | Metadata API Developer Guide

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 the Metadata metadata type and inherits its fullName field.

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 54.0 and later.

Special Access Rules

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

Fields

Field Name	Description
identityVerificationProcDtls	Field Type IdentityVerificationProcDtl[] Description A list of Identity Verification Process Detail elements.
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`

IdentityVerificationProcDtl

Represents the verification-related details such as search criteria, verification criteria, or the custom apex class.

Field Name	Description
apexClass	Field Type string Description The Apex class that is used to search and verify data in an external system.
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. The developer name of Identity verification process detail. Can contain only underscores and alphanumeric characters and must be unique in your org. It must begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores.
displayRecordFieldName	Field Type string Description The name of the field that contains information about the record that's shown to the user after identity verification is successful. Available in API version 58.0 and later.
identityVerificationProcFlds	Field Type IdentityVerificationProcFld[] Description A list of Identity Verification Process Field elements.
isActive	Field Type boolean Description Indicates whether the record is active (`true`) or not (`false`).
isRetryAllowedAfterLimit	Field Type boolean Description For internal use only.
linkedIdVerfProcessDet	Field Type string Description The record containing the details of the linked identity verification process. Available in API version 58.0 and later.
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 number of optional verifiers that must be checked.
retryLimit	Field Type int Description For internal use only.
searchFilter	Field Type string Description A comma-separated list of predefined filter conditions that are used to refine the scope of the search.
searchRecordUniqueIdField	Field Type string Description The field storing the unique identifier of a record displayed in the search results.
searchResultSortBy	Field Type string Description The values that are used to sort the search results.
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 a set of fields necessary to configure the questions that CCA asks the caller before providing them with the information they need.

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. The developer name of Identity Verification Process Field. Can contain only underscores and alphanumeric characters and must be unique in your org. It must begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores. Available in API version 58.0 and later.
fieldDataType	Field Type IdentityVerificationProcFldFieldDataType (enumeration of type string) Description The data type of the field in the external data source that's defined in the identity verification process detail. Available in API version 58.0 and later. Valid values are: `address` `checkbox` `currency` `dateonly` `datetime` `email` `number` `other` `percent` `phone` `picklist` `reference` `text` `timeonly` `url`
fieldName	Field Type string Description Required. The label of the field that contains the verification data based on the selected field type. Available in API version 58.0 and later.
fieldType	Field Type IdentityVerificationProcFldFieldType (enumeration of type string) Description Required. Indicates the type of field. Valid values are: `additionalResultField` `optionalVerifier` `requiredVerifier` `resultField` `searchField` `searchFilter`
fieldValueFormula	Field Type string Description Stores the formula that is applied to the field value.
isActive	Field Type boolean Description Indicates whether the record is active (`true`) or not (`false`).
isManualInput	Field Type boolean Description Indicates whether the user can manually enter the identity verification details (`true`) or not (`false`). The default value of this field is `false`. Available in API version 58.0 and later.
masterLabel	Field Type string Description Required. A user-friendly name for Identity Verification Process Field.
sequenceNumber	Field Type int Description Required. The sequence number of the field.

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.