IdentityVerificationProcDtl | 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

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`
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`). 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`

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

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>    <developerName>Sample93AccountSearch</developerName>
5    <identityVerificationProcFlds>
6       <fullName>Sample93AccountName</fullName>
7       <dataSourceType>Salesforce</dataSourceType>
8       <developerName>Sample93AccountName</developerName>
9       <fieldName>Name</fieldName>
10       <fieldType>requiredVerifier</fieldType>
11       <isActive>false</isActive>
12       <masterLabel>Sample93 Account Name</masterLabel>
13       <fieldValueFormula>abcd</fieldValueFormula>
14       <customFieldLabel>Name</customFieldLabel>
15       <sequenceNumber>1</sequenceNumber>
16       <isManualInput>false</isManualInput>
17    </identityVerificationProcFlds>
18    <identityVerificationProcFlds>
19       <fullName>Sample93Phone</fullName>
20       <dataSourceType>Salesforce</dataSourceType>
21       <developerName>Sample93Phone</developerName>
22       <fieldName>phone</fieldName>
23       <fieldType>optionalVerifier</fieldType>
24       <isActive>false</isActive>
25       <masterLabel>Sample93 Phone</masterLabel>
26       <sequenceNumber>93</sequenceNumber>
27       <isManualInput>false</isManualInput>
28    </identityVerificationProcFlds>
29    <masterLabel>detail1</masterLabel>
30     <fullName>detail1</fullName>
31    <objectName>Account</objectName>
32    <optionalVerifiersMinVerfCount>11</optionalVerifiersMinVerfCount>
33    <searchFilter>asd</searchFilter>
34    <searchRecordUniqueIdField>Id</searchRecordUniqueIdField>
35    <searchResultSortBy>asd</searchResultSortBy>
36    <searchSequenceNumber>1</searchSequenceNumber>
37    <searchType>Text-Based</searchType>
38</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.