IdentityVerificationProcDtl

Represents the search functionality configuration and the minimum number of optional verifiers for identity verification. 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

IdentityVerificationProcDtl components have the suffix .IdentityVerificationProcDtl and are stored in the IdentityVerificationProcDtls folder.

Version

IdentityVerificationProcDtl 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
apexClass	Field Type string Description Reserved for future use.
dataSourceType	Field Type IdentityVerificationDataSourceType (enumeration of type string) Description Required. The source type of the data. Valid values are: `External`—Reserved for future use. `Salesforce`
identityVerificationProcDef	Field Type string Description The identity verification process definition.
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 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 optional verifiers that must be checked.
searchFilter	Field Type string Description Conditions on which 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 that stores the unique identifier of the records that are 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. Enter 1 as the search sequence number. In API version 54.0 and later, this field is reserved for future use, and the value you enter doesn't affect sequencing. Note
searchType	Field Type IdentityVerificationSearchType (enumeration of type string) Description Required. The type of search being performed. Valid values are: `Object-Based`—Reserved for future use. `Text-Based`

Declarative Metadata Sample Definition

The following is an example of an identityVerificationProcDtl component.

1<?xml version="1.0" encoding="UTF-8"?>
2<IdentityVerificationProcDtl xmlns="http://soap.sforce.com/2006/04/metadata">
3    <dataSourceType>Salesforce</dataSourceType>
4    <isActive>true</isActive>
5    <masterLabel>detail1</masterLabel>
6     <fullName>detail1</fullName>
7    <objectName>Account</objectName>
8    <optionalVerifiersMinVerfCount>11</optionalVerifiersMinVerfCount>
9    <searchFilter>asd</searchFilter>
10    <searchRecordUniqueIdField>Id</searchRecordUniqueIdField>
11    <searchResultSortBy>asd</searchResultSortBy>
12    <searchSequenceNumber>1</searchSequenceNumber>
13    <searchType>Text-Based</searchType>
14</IdentityVerificationProcDtl>

The following 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>IdentityVerificationProcDtl</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.

Metadata API Developer Guide