IdentityVerificationProcFld

Used to configure the questions or criteria for verifying the identity of a customer and their authorized representative. This object is 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: The source type of the data.
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 may slow while Salesforce generates one for each record.
Note

FieldDataType

Type: picklist
Properties: Filter, Group, Nillable, Restricted picklist, Sort
Description: The type of data stored in an external data source field.
Possible values:
- address
- checkbox
- currency
- dateonly
- datetime
- email
- number
- other
- percent
- phone
- picklist
- reference
- text
- timeonly
- url

FieldName

Type: string
Properties: Filter, Group, Sort
Description: The label of the field that contains the verification data based on the selected field type.

FieldType

Type: picklist
Properties: Filter, Group, Restricted picklist, Sort
Description: The type of field.
Possible values:
- additionalResultField—Fetches data as part of the search query, but the data isn’t displayed in search results. Suppose 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—Displays additional verifiers on the verification screen.
  In API version 56.0 and later, you can display additional verifiers based on fields from the object configured for verification’s parent object. For example, if you set identity verification on the Contact object, you can display fields from the Account object.
  Note
- requiredVerifier—Displays required verifiers on the verification screen.
  In API version 56.0 and later, you can display required verifiers based on fields from the object configured for verification’s parent object. For example, if you set identity verification on the Contact object, you can display fields from the Account object.
  Note
- resultField—Displays fields in search results. For example, when an agent searches for a customer or their representative, you’d like the search results to include the account name, phone number, and email ID.
  In API version 56.0 and later, you can display fields from the parent object of the object configured for verification in the search results. For example, if you set identity verification on the Contact object, which looks up to the Account object, you can display fields from accounts in the search results.
  Note
- searchField—Performs object-based search.
- searchFilter—Filters search results. When this is set as the field type, specify the field name to filter search results using the FieldName attribute. Both static and dynamic filtering are supported. For example, to search for Contacts whose related Account ID is always 001xx000003GZ4lAAG, set AccountId as the field name and the value of FieldValueFormula to 001xx000003GZ4lAAG. Or, if an agent verifies a customer (Account) and then performs a secondary search against all policies (Policy) in which the verified customer is the policy holder, set FieldName to PolicyHolder and FieldValueFormula to the dynamic value {!SelectedParentRecordId}. This value is available from API version 56.0 and later.
  You can only use record IDs to dynamically filter search results.
  Note

FieldValueFormula

Type: string
Properties: Filter, Group, Nillable, Sort
Description: Stores the formula that's applied to the field value.

FullName

Type: string
Properties: Create, Group, Nillable
Description: The full name of the associated IdentityVerificationProcFld in Metadata API. The full name can include a namespaceprefix.
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.

IdentityVerificationProcDtlId

Type: reference
Properties: Filter, Group, Sort
Description: The label of the relevant Identity Verification Process Detail record.
This field is a relationship field.
Relationship Name: IdentityVerificationProcDtl
Relationship Type: Lookup
Refers To: IdentityVerificationProcDtl

IsActive

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

IsManualInput

Type: boolean
Properties: Defaulted on create, Filter, Group, Sort
Description: Indicates whether the user can manually enter the identity verification details (true) or not (false).
This field is available in API version 58.0 and later.
Default value: false

Language

Type: picklist
Properties: Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort
Description: The languages in which translation of record labels is supported.
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)

ManageableState

Type: ManageableState enumerated list
Properties: Filter, Group, Nillable, Restricted picklist, Sort
Description: Indicates the manageable state of the specified component that is contained in a package:
- beta
- deleted
- deprecated
- deprecatedEditable
- installed
- installedEditable
- released
- unmanaged

MasterLabel

Type: string
Properties: Filter, Group, Sort
Description: The label for IdentityVerificationProcFld.

Metadata

Type: complexvalue
Properties: Create, Nillable, Update
Description: The IdentityVerificationProcFld’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 associated with this object. Each Developer Edition organization 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 organizations, the namespace prefix is set to the namespace prefix of the organization for all objects that support it. There is an exception if 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 organization of the package developer.
- In organizations that are not Developer Edition organizations, NamespacePrefix is only set for objects that are part of an installed managed package. There is no namespace prefix for all other objects.

SequenceNumber

Type: int
Properties: Filter, Group, Sort
Description: The sequence number of the field.

Industries Common Resources Developer Guide