IdentityVerificationProcDtl

Used to configure the search function as well as the minimum number of verifiers for the identity verification process. Available in API version 54.0 and later.

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

Supported SOAP API Calls

create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert()

Supported REST API Methods

DELETE, GET, HEAD, PATCH, POST, Query

Fields

DataSourceType

Type: picklist
Properties: Filter, Group, Restricted picklist, Sort
Description: Specifies whether source of data for identity verification is external or within Salesforce.
Possible values:
- External
- Salesforce

DeveloperName

Type: string
Properties: Filter, Group, Sort
Description: The unique name of the object in the API. This name 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. In managed packages, this field prevents naming conflicts on package installations. With this field, a developer can change the object’s name in a managed package and the changes are reflected in a subscriber’s organization. Label is Record Type Name. This field is automatically generated, but you can supply your own value if you create the record using the API.

When creating large sets of data, always specify a unique DeveloperName for each record. If no DeveloperName is specified, performance slows down while Salesforce generates one for each record.

Note

FullName

Type: string
Properties: Create, Group, Nillable
Description: The full name of the associated IdentityVerificationProcDtl type in Metadata API. The full name can include a namespace prefix.

Query this field only if the query result contains no more than one record. Otherwise, an error is returned. If more than one record exists, use multiple queries to retrieve the records. This limit protects performance.

IdentityVerificationProcDefId

Type: reference
Properties: Filter, Group, Sort
Description: The label of the relevant Identity Verification Process Definition record

This field is a relationship field.
Relationship Name: IdentityVerificationProcDef
Relationship Type: Lookup
Refers To: IdentityVerificationProcDef

IsActive

Type: boolean
Properties: Defaulted on create, Filter, Group, Sort
Description: Indicates whether the record is active.
Default value: false

Language

Type: picklist
Properties: Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort
Description: The language of the IdentityVerificationProcDtl.
Possible values:
- da—Danish
- de—German
- en_US—English
- es—Spanish
- es_MX—Spanish (Mexico)
- fi—Finnish
- fr—French
- it—Italian
- ja—Japanese
- ko—Korean
- nl_NL—Dutch
- no—Norwegian
- pt_BR—Portuguese (Brazil)
- ru—Russian
- sv—Swedish
- th—Thai
- zh_CN—Chinese (Simplified)
- zh_TW—Chinese (Traditional)

LinkedIdVerfProcessDetId

Type: reference
Properties: Filter, Group, Nillable, Sort
Description: The identity verification process detail record to be used for secondary verification.

This field is a relationship field.
Relationship Name: LinkedIdVerfProcessDet
Relationship Type: Lookup
Refers To: IdentityVerificationProcDtl

ManageableState

Type: picklist
Properties: Filter, Group, Nillable, Restricted picklist, Sort
Description: Indicates the manageable state of the specified component that is contained in a package.
Possible values:
- beta—Managed-Beta
- deleted—Managed-Proposed-Deleted
- deprecated—Managed-Proposed-Deprecated
- deprecatedEditable—SecondGen-Installed-Deprecated
- installed—Managed-Installed
- installedEditable—SecondGen-Installed-Editable
- released—Managed-Released
- unmanaged—Unmanaged

MasterLabel

Type: string
Properties: Filter, Group, Sort
Description: Label that identifies the IdentityVerificationProcDtl throughout the Salesforce user interface.

Metadata

Type: complexvalue
Properties: Create, Nillable, Update
Description: The IdentityVerificationProcDtl’s metadata.

Query this field only if the query result contains no more than one record. Otherwise, an error is returned. If more than one record exists, use multiple queries to retrieve the records. This limit protects performance.

NamespacePrefix

Type: string
Properties: Filter, Group, Nillable, Sort
Description: The namespace prefix that is associated with this object. Each Developer Edition org that creates a managed package has a unique namespace prefix. Limit: 15 characters. You can refer to a component in a managed package by using the namespacePrefix__componentName notation.

The namespace prefix can have one of the following values.
- In Developer Edition orgs, NamespacePrefix is set to the namespace prefix of the org for all objects that support it, unless an object is in an installed managed package. In that case, the object has the namespace prefix of the installed managed package. This field’s value is the namespace prefix of the Developer Edition org of the package developer.
- In orgs that are not Developer Edition orgs, NamespacePrefix is set only for objects that are part of an installed managed package. All other objects have no namespace prefix.

ObjectName

Type: string
Properties: Filter, Group, Nillable, Sort
Description: The name of the object on which the search is performed and data is verified.

OptionalVerifiersMinVerfCount

Type: int
Properties: Filter, Group, Nillable, Sort
Description: The minimum number of additional verifiers that must be checked.

SearchFilter

Type: string
Properties: Filter, Group, Nillable, Sort
Description: Conditions to filter the search results.

For example, if you want to perform the search only on Person Account records, enter isPersonAccount = true

Use the AND operator to enter multiple conditions. The OR operator isn’t currently supported.
Note

.

SearchRecordUniqueIdField

Type: string
Properties: Filter, Group, Nillable, Sort
Description: The field storing the unique identifier of records displayed in the search results.

SearchResultSortBy

Type: string
Properties: Filter, Group, Nillable, Sort
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

Type: int
Properties: Filter, Group, Sort
Description: The sequence in which the search is performed and the search result is displayed.

SearchType

Type: picklist
Properties: Filter, Group, Restricted picklist, Sort
Description: The type of search being performed.

Text-based search enables users to enter search keywords in the search field. In object-based search, users search for data using available fields.
Note
Possible values:
- Object-Based
- Text-Based