afv-library/skills/platform-metadata-api-context-get/assets/metadata_api/IdentityVerificationProcFld.json

{
  "sections": [
    "title",
    "description",
    "file_information",
    "directory_location",
    "fields",
    "wsdl_segment",
    "declarative_metadata_sample_definition"
  ],
  "title": "IdentityVerificationProcFld - Metadata API",
  "description": "Represents the search and verification fields used in identity verification. This type extends the Metadata metadata type and inherits its fullName field.",
  "file_information": ".IdentityVerificationProcFld",
  "directory_location": "IdentityVerificationProcFlds",
  "fields_columns": [
    "type",
    "description",
    "required",
    "properties"
  ],
  "fields": {
    "customFieldLabel": {
      "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."
    },
    "dataSourceType": {
      "type": "IdentityVerificationProcFldDataSourceType (enumeration of type string)",
      "required": true,
      "description": "The source type of the data. Valid values are: ExternalAn external data source isn’t supported in API version 54.0. 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": {
      "type": "string",
      "required": true,
      "description": "The label of the field that contains the verification data based on the selected field type."
    },
    "fieldType": {
      "type": "IdentityVerificationProcFldFieldType (enumeration of type string)",
      "required": true,
      "description": "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": {
      "type": "string",
      "description": "Reserved for future use."
    },
    "isActive": {
      "type": "boolean",
      "description": "Indicates whether the record is active (true) or not (false). The default value is false."
    },
    "isManualInput": {
      "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": {
      "type": "string",
      "required": true,
      "description": "The label of the Identity Verification Process Field record."
    },
    "sequenceNumber": {
      "type": "int",
      "required": true,
      "description": "The sequence number of the field."
    }
  },
  "wsdl_segment": "```xml\n<xsd:complexType name=\"IdentityVerificationProcDef\">\n  <xsd:complexContent>\n    <xsd:extension base=\"tns:Metadata\">\n      <xsd:sequence>\n        <xsd:element name=\"identityVerificationProcDtls\" minOccurs=\"0\" maxOccurs=\"unbounded\" type=\"tns:IdentityVerificationProcDtl\"/>\n        <xsd:element name=\"masterLabel\" type=\"xsd:string\"/>\n        <xsd:element name=\"searchLayoutType\" type=\"tns:IdentityVerificationSearchLayoutType\"/>\n      </xsd:sequence>\n    </xsd:extension>\n  </xsd:complexContent>\n</xsd:complexType>\n<xsd:complexType name=\"IdentityVerificationProcDtl\">\n  <xsd:complexContent>\n    <xsd:extension base=\"tns:Metadata\">\n      <xsd:sequence>\n        <xsd:element name=\"apexClass\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <xsd:element name=\"dataSourceType\" type=\"tns:IdentityVerificationDataSourceType\"/>\n        <xsd:element name=\"developerName\" type=\"xsd:string\"/>\n        <xsd:element name=\"displayRecordFieldName\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <xsd:element name=\"identityVerificationProcFlds\" minOccurs=\"0\" maxOccurs=\"unbounded\" type=\"tns:IdentityVerificationProcFld\"/>\n        <xsd:element name=\"isActive\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <xsd:element name=\"isRetryAllowedAfterLimit\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <xsd:element name=\"linkedIdVerfProcessDet\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <xsd:element name=\"masterLabel\" type=\"xsd:string\"/>\n        <xsd:element name=\"objectName\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <xsd:element name=\"optionalVerifiersMinVerfCount\" minOccurs=\"0\" type=\"xsd:int\"/>\n        <xsd:element name=\"retryLimit\" minOccurs=\"0\" type=\"xsd:int\"/>\n        <xsd:element name=\"searchFilter\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <xsd:element name=\"searchRecordUniqueIdField\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <xsd:element name=\"searchResultSortBy\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <xsd:element name=\"searchSequenceNumber\" type=\"xsd:int\"/>\n        <xsd:element name=\"searchType\" type=\"tns:IdentityVerificationSearchType\"/>\n      </xsd:sequence>\n    </xsd:extension>\n  </xsd:complexContent>\n</xsd:complexType>\n<xsd:complexType name=\"IdentityVerificationProcFld\">\n  <xsd:complexContent>\n    <xsd:extension base=\"tns:Metadata\">\n      <xsd:sequence>\n        <xsd:element name=\"customFieldLabel\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <xsd:element name=\"dataSourceType\" type=\"tns:IdentityVerificationProcFldDataSourceType\"/>\n        <xsd:element name=\"developerName\" type=\"xsd:string\"/>\n        <xsd:element name=\"fieldDataType\" minOccurs=\"0\" type=\"tns:IdentityVerificationProcFldFieldDataType\"/>\n        <xsd:element name=\"fieldName\" type=\"xsd:string\"/>\n        <xsd:element name=\"fieldType\" type=\"tns:IdentityVerificationProcFldFieldType\"/>\n        <xsd:element name=\"fieldValueFormula\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <xsd:element name=\"isActive\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <xsd:element name=\"isManualInput\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <xsd:element name=\"masterLabel\" type=\"xsd:string\"/>\n        <xsd:element name=\"sequenceNumber\" type=\"xsd:int\"/>\n      </xsd:sequence>\n    </xsd:extension>\n  </xsd:complexContent>\n</xsd:complexType>\n<xsd:simpleType name=\"IdentityVerificationProcFldDataSourceType\">\n  <xsd:restriction base=\"xsd:string\">\n    <xsd:enumeration value=\"Salesforce\"/>\n    <xsd:enumeration value=\"External\"/>\n  </xsd:restriction>\n</xsd:simpleType>\n<xsd:simpleType name=\"IdentityVerificationProcFldFieldDataType\">\n  <xsd:restriction base=\"xsd:string\">\n    <xsd:enumeration value=\"address\"/>\n    <xsd:enumeration value=\"checkbox\"/>\n    <xsd:enumeration value=\"currency\"/>\n    <xsd:enumeration value=\"dateonly\"/>\n    <xsd:enumeration value=\"datetime\"/>\n    <xsd:enumeration value=\"email\"/>\n    <xsd:enumeration value=\"number\"/>\n    <xsd:enumeration value=\"percent\"/>\n    <xsd:enumeration value=\"phone\"/>\n    <xsd:enumeration value=\"picklist\"/>\n    <xsd:enumeration value=\"reference\"/>\n    <xsd:enumeration value=\"text\"/>\n    <xsd:enumeration value=\"timeonly\"/>\n    <xsd:enumeration value=\"url\"/>\n    <xsd:enumeration value=\"other\"/>\n  </xsd:restriction>\n</xsd:simpleType>\n<xsd:simpleType name=\"IdentityVerificationProcFldFieldType\">\n  <xsd:restriction base=\"xsd:string\">\n    <xsd:enumeration value=\"requiredVerifier\"/>\n    <xsd:enumeration value=\"optionalVerifier\"/>\n    <xsd:enumeration value=\"searchField\"/>\n    <xsd:enumeration value=\"resultField\"/>\n    <xsd:enumeration value=\"additionalResultField\"/>\n    <xsd:enumeration value=\"searchFilter\"/>\n  </xsd:restriction>\n</xsd:simpleType>\n<xsd:complexType name=\"Metadata\">\n  <xsd:sequence>\n    <xsd:element name=\"fullName\" minOccurs=\"0\" type=\"xsd:string\"/>\n  </xsd:sequence>\n</xsd:complexType>\n```",
  "declarative_metadata_sample_definition": [
    {
      "description": "The following is an example of an IdentityVerificationProcFld component.",
      "code": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<IdentityVerificationProcFld xmlns=\"http://soap.sforce.com/2006/04/metadata\" xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\">\n    <customFieldLabel>field1</customFieldLabel>\n    <dataSourceType>External</dataSourceType>\n    <fieldName>sasa</fieldName>\n    <fieldType>requiredVerifier</fieldType>\n     <fullName>field1</fullName>\n\n    <isActive>false</isActive>\n    <masterLabel>field1</masterLabel>\n    <sequenceNumber>1</sequenceNumber>\n</IdentityVerificationProcFld>"
    }
  ]
}