IdentityVerificationProcFld | Salesforce Health Cloud 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

IdentityVerificationProcFld components have the suffix .IdentityVerificationProcFld and are stored in the IdentityVerificationProcFlds folder.

Version

IdentityVerificationProcFld 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
customFieldLabel	Field Type string Description The custom label for the field that contains the verification data. Translation of custom field labels isn't supported in API version 54.0. Note
dataSourceType	Field Type IdentityVerificationProcFldDataSourceType (enumeration of type string) Description Required. The source type of the data. Valid values are: `External` An external data source isn’t supported in API version 54.0. Note `Salesforce`
fieldDataType	Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The type of data stored in an external data source field. Possible 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.
fieldType	Field Type IdentityVerificationProcFldFieldType (enumeration of type string) Description Required. Indicates the type of field. Possible values are: `additionalResultField`—Fetches data as part of the search query, but the data isn’t displayed in search results. Use this value if, for example, 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`—Optional verifier. `requiredVerifier`—Required verifier. `resultField`—Displays field type in search results. Use this value if, 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`—Reserved for future use. `searchFilter`—A comma-separated list of predefined filter conditions that are used to refine the scope of the search.
fieldValueFormula	Field Type string Description Reserved for future use.

isActive	Field Type boolean Description Indicates whether the record is active (`true`) or not (`false`). The default value is `false`.
isManualInput	Field Type boolean Description Indicates whether the user can manually enter the identity verification details (`true`) or not (`false`). The default value is `false`. This field is available in API version 58.0 and later.
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 IdentityVerificationProcFld component.

1<?xml version="1.0" encoding="UTF-8"?>
2<IdentityVerificationProcFld xmlns="http://soap.sforce.com/2006/04/metadata" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
3    <customFieldLabel>field1</customFieldLabel>
4    <dataSourceType>External</dataSourceType>
5    <fieldName>sasa</fieldName>
6    <fieldType>requiredVerifier</fieldType>
7     <fullName>field1</fullName>
8
9    <isActive>false</isActive>
10    <masterLabel>field1</masterLabel>
11    <sequenceNumber>1</sequenceNumber>
12</IdentityVerificationProcFld>

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>IdentityVerificationProcFld</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.