--- schema_version: "1" id: 48b6605325d7fc19ef6e85fed7a8b28fdea2cd14fc5f19786a14bcb55cf950c0 title: IdentityVerificationProcDef collection: legacydeveloper version: current locale: en-us portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/api_meta/meta_identityverificationprocdef.md canonical_url: https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_identityverificationprocdef.htm source_site: developer.salesforce.com content_type: documentation content_hash: 6c41ff2b1249a3339388afbadc4a084f617f585768377db109cad03c0d796080 description: Represents the definition of the identity verification process. --- # IdentityVerificationProcDef Represents the definition of the identity verification process. ![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png) #### Important 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. ## Parent Type This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") 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\[\]](#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\[\]](#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. Sample93AccountSearch Salesforce Sample93AccountSearch Sample93AccountName Salesforce Sample93AccountName Name requiredVerifier false Sample93 Account Name abcd Name 1 false Sample93Phone Salesforce Sample93Phone phone optionalVerifier false Sample93 Phone 93 false Sample93PostalCode Salesforce Sample93PostalCode BillingPostalCode optionalVerifier true Sample93 Postal Code 4 false Sample93Account Salesforce Sample93Account Name resultField false Sample93 Account 1 false true Sample93 Account Search Account Id 1 Text-Based Name 1 false 5 LastModifiedById Sample93 Verification Flow Tab This is an example package.xml that references the previous definition. \* IdentityVerificationProcDef 54.0 ## 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](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/file_based_zip_file.htm "The deploy() and retrieve() calls are used to deploy and retrieve a .zip file. Within the .zip file is a project manifest (package.xml) that lists what to retrieve or deploy, and one or more XML components that are organized into folders.").