Phone Cleanser

Reltio provides different options to configure the phone cleanser.

Cleanser Name - PhoneCleanserFn

Description

This cleanser takes the phone number, country code, and type and produces many attributes with the ReltioCleanser crosswalk, as per the output mapping.

The phone cleanser works in the same way as the existing custom phone cleanser (that loads from S3).

Mapping Input and Output

The input and output mapping of the phone cleanser can be configured in two ways.

  • Implementation 1 works only when the phone address is configured at the first nested attribute. This implementation does not work when configured at deeper nested levels. However, implementation 2 works when configured at any nested level.
  • Implementation 1 makes it compulsory to use the nested attribute name as Phone. The cleanser does not work if the name is changed. However, for implementation 2, you can use any name for the nested attribute.
Implementation 1
{
  "attribute": "configuration/entityTypes/HCP/attributes/Phone/attributes/Number",
  "mandatory": true,
  "allValues": true,
  "cleanseAttribute": "Phone.Number"
}
Implementation 2
{
  "attribute": "configuration/entityTypes/HCP/attributes/Phone/attributes/Number",
  "mandatory": true,
  "allValues": true,
  "cleanseAttribute": "Number"
}

Options for Phone Cleanser

Table 1. Options
Key Allowed Values Description
licensedCountryCodes ISO3166-2 country codes with a semicolon (;) separator. For example, US;IN;RU This option is enabled in the phone cleanser configuration to support only a few countries. If no value is mentioned, the phone number is returned as given.
  • If no value is mentioned, the phone cleanser cleanses phone numbers of all the countries.
  • If any value is mentioned, the phone cleanser cleanses the phone numbers of that country only.

You can use licensedCountryCodes in one of the following ways:

  • In the Physical Configuration - Contact the Support Team to enable licensedCountryCodes at the physical configuration level.
  • In the L3 Configuration - For more information about using licensedCountryCodes under params, see the L3 Configuration for Implementation 1 and L3 Configuration for Implementation 2 sections below.
returnDataForInValidStatus The following are the allowed values:
  • true - This is the default value.
  • false
The returnDataForInValidStatus option is considered when ValidationStatus is INVALID. The following points explain how the returnDataForInValidStatus option works:
  • When the returnDataForInValidStatus option is set to true, the phone cleanser returns the cleansed data even for those phone numbers that are INVALID.
  • When the returnDataForInValidStatus option is set to false, the phone cleanser does not return the cleansed data. It just returns the user input along with ValidationStatus.
enhanceCleansing The following are the allowed values:
  • true
  • false - This is the default value.
The enhanceCleansing option is active only when ValidationStatus is INVALID. The following points explain how the enhanceCleansing option works:
  • If the enhanceCleansing option is set to true and the input phone number does not have a prefix of '+' or '0', the phone cleanser tries to re-cleanse the phone number by adding the '+' prefix to the input phone number.
  • If the enhanceCleansing option is set to false, the phone cleanser does not try to re-cleanse the phone number.

L3 Configuration

Map the PhoneCleanserFn for any entity in your L3 configuration as per the chosen implementation process.

L3 Configuration for Implementation 1
{
  "uri": "configuration/entityTypes/HCP",
  "cleanseConfig": {
    "infos": [
      {
        "uri": "configuration/entityTypes/Individual/cleanse/infos/PhoneCleanserFn",
        "useInCleansing": true,
        "sequence": [
          {
            "chain": [
              {
                "cleanseFunction": "PhoneCleanserFn",
                "resultingValuesSourceTypeUri": "configuration/sources/ReltioCleanser",
                "proceedOnSuccess": true,
                "proceedOnFailure": true,
                "params": {
                  "licensedCountryCodes": "US"
                },
                "mapping": {
                  "inputMapping": [
                    {
                      "attribute": "configuration/entityTypes/HCP/attributes/Phone/attributes/Number",
                      "mandatory": true,
                      "allValues": true,
                      "cleanseAttribute": "Phone.Number"
                    },
                    {
                      "attribute": "configuration/entityTypes/HCP/attributes/Phone/attributes/CountryCode",
                      "mandatory": false,
                      "allValues": true,
                      "cleanseAttribute": "Phone.CountryCode"
                    },
                    {
                      "attribute": "configuration/entityTypes/HCP/attributes/Phone/attributes/Type",
                      "mandatory": false,
                      "allValues": true,
                      "cleanseAttribute": "Phone.Type"
                    }
                  ],
                  "outputMapping": [
                    {
                      "attribute": "configuration/entityTypes/HCP/attributes/Phone/attributes/Type",
                      "mandatory": false,
                      "allValues": false,
                      "cleanseAttribute": "Phone.Type"
                    },
                    {
                      "attribute": "configuration/entityTypes/HCP/attributes/Phone/attributes/Number",
                      "mandatory": true,
                      "allValues": false,
                      "cleanseAttribute": "Phone.Number"
                    },
                    {
                      "attribute": "configuration/entityTypes/HCP/attributes/Phone/attributes/CountryCode",
                      "mandatory": false,
                      "allValues": false,
                      "cleanseAttribute": "Phone.CountryCode"
                    },
                    {
                      "attribute": "configuration/entityTypes/HCP/attributes/Phone/attributes/Extension",
                      "mandatory": false,
                      "allValues": false,
                      "cleanseAttribute": "Phone.Extension"
                    },
                    {
                      "attribute": "configuration/entityTypes/HCP/attributes/Phone/attributes/LineType",
                      "mandatory": false,
                      "allValues": false,
                      "cleanseAttribute": "Phone.LineType"
                    },
                    {
                      "attribute": "configuration/entityTypes/HCP/attributes/Phone/attributes/FormatMask",
                      "mandatory": false,
                      "allValues": false,
                      "cleanseAttribute": "Phone.FormatMask"
                    },
                    {
                      "attribute": "configuration/entityTypes/HCP/attributes/Phone/attributes/ValidationStatus",
                      "mandatory": true,
                      "allValues": false,
                      "cleanseAttribute": "Phone.ValidationStatus"
                    },
                    {
                      "attribute": "configuration/entityTypes/HCP/attributes/Phone/attributes/AreaCode",
                      "mandatory": false,
                      "allValues": false,
                      "cleanseAttribute": "Phone.AreaCode"
                    },
                    {
                      "attribute": "configuration/entityTypes/HCP/attributes/Phone/attributes/GeoCountry",
                      "mandatory": false,
                      "allValues": false,
                      "cleanseAttribute": "Phone.GeoCountry"
                    },
                    {
                      "attribute": "configuration/entityTypes/HCP/attributes/Phone/attributes/GeoArea",
                      "mandatory": false,
                      "allValues": false,
                      "cleanseAttribute": "Phone.GeoArea"
                    },
                    {
                      "attribute": "configuration/entityTypes/HCP/attributes/Phone/attributes/DigitCount",
                      "mandatory": false,
                      "allValues": false,
                      "cleanseAttribute": "Phone.DigitCount"
                    },
                    {
                      "attribute": "configuration/entityTypes/HCP/attributes/Phone/attributes/LocalNumber",
                      "mandatory": true,
                      "allValues": false,
                      "cleanseAttribute": "Phone.LocalNumber"
                    },
                    {
                      "attribute": "configuration/entityTypes/HCP/attributes/Phone/attributes/FormattedNumber",
                      "mandatory": true,
                      "allValues": false,
                      "cleanseAttribute": "Phone.FormattedNumber"
                    }
                  ]
                }
              }
            ]
          }
        ]
      }
    ]
  },
  "attributes": [
    {
      "label": "ID",
      "name": "ID",
      "description": "",
      "type": "String",
      "hidden": false,
      "important": false,
      "system": false,
      "attributeOrdering": {
        "orderingStrategy": "LUD"
      },
      "uri": "configuration/entityTypes/HCP/attributes/ID",
      "skipInDataAccess": false
    },
    {
      "label": "Phone",
      "name": "Phone",
      "type": "Nested",
      "hidden": false,
      "important": false,
      "system": false,
      "required": false,
      "attributeOrdering": {
        "fieldURI": "configuration/entityTypes/HCP/attributes/Phone/attributes/Rank",
        "orderType": "ASC",
        "orderingStrategy": "FieldBased"
      },
      "uri": "configuration/entityTypes/HCP/attributes/Phone",
      "dataLabelPattern": "{Type} {Number}",
      "matchFieldURIs": [
        "configuration/entityTypes/HCP/attributes/Phone/attributes/Number"
      ],
      "attributes": [
        {
          "label": "Type*",
          "name": "Type",
          "description": "",
          "type": "String",
          "hidden": false,
          "important": false,
          "system": false,
          "required": false,
          "values": [
            "Mobile",
            "Home",
            "Work",
            "Fax",
            "Main",
            "Work Fax",
            "Home Fax",
            "Pager",
            "Other"
          ],
          "attributeOrdering": {
            "orderingStrategy": "LUD"
          },
          "uri": "configuration/entityTypes/HCP/attributes/Phone/attributes/Type",
          "skipInDataAccess": false
        },
        {
          "label": "Number*",
          "name": "Number",
          "description": "",
          "type": "String",
          "hidden": false,
          "important": false,
          "system": false,
          "required": false,
          "attributeOrdering": {
            "orderingStrategy": "LUD"
          },
          "uri": "configuration/entityTypes/HCP/attributes/Phone/attributes/Number",
          "skipInDataAccess": false
        },
        {
          "label": "Country Code*",
          "name": "CountryCode",
          "description": "",
          "type": "String",
          "hidden": false,
          "important": false,
          "system": false,
          "required": false,
          "values": [
            "US",
            "IN",
            "GB",
            "AU"
          ],
          "attributeOrdering": {
            "orderingStrategy": "LUD"
          },
          "uri": "configuration/entityTypes/HCP/attributes/Phone/attributes/CountryCode",
          "skipInDataAccess": false
        },
        {
          "label": "Extension",
          "name": "Extension",
          "description": "",
          "type": "String",
          "hidden": false,
          "important": false,
          "system": false,
          "required": false,
          "attributeOrdering": {
            "orderingStrategy": "LUD"
          },
          "uri": "configuration/entityTypes/HCP/attributes/Phone/attributes/Extension",
          "skipInDataAccess": false
        },
        {
          "label": "Formatted Number",
          "name": "FormattedNumber",
          "type": "String",
          "hidden": false,
          "important": false,
          "system": false,
          "required": false,
          "attributeOrdering": {
            "orderingStrategy": "LUD"
          },
          "uri": "configuration/entityTypes/HCP/attributes/Phone/attributes/FormattedNumber",
          "skipInDataAccess": false
        },
        {
          "label": "Rank",
          "name": "Rank",
          "description": "",
          "type": "Int",
          "hidden": false,
          "important": false,
          "system": false,
          "required": false,
          "attributeOrdering": {
            "orderingStrategy": "LUD"
          },
          "uri": "configuration/entityTypes/HCP/attributes/Phone/attributes/Rank",
          "skipInDataAccess": false
        },
        {
          "label": "Area Code",
          "name": "AreaCode",
          "description": "",
          "type": "String",
          "hidden": false,
          "important": false,
          "system": false,
          "required": false,
          "attributeOrdering": {
            "orderingStrategy": "LUD"
          },
          "uri": "configuration/entityTypes/HCP/attributes/Phone/attributes/AreaCode",
          "skipInDataAccess": false
        },
        {
          "label": "Local Number",
          "name": "LocalNumber",
          "description": "",
          "type": "String",
          "hidden": false,
          "important": false,
          "system": false,
          "required": false,
          "attributeOrdering": {
            "orderingStrategy": "LUD"
          },
          "uri": "configuration/entityTypes/HCP/attributes/Phone/attributes/LocalNumber",
          "skipInDataAccess": false
        },
        {
          "label": "Validation Status",
          "name": "ValidationStatus",
          "description": "",
          "type": "String",
          "hidden": false,
          "important": false,
          "system": false,
          "required": false,
          "attributeOrdering": {
            "orderingStrategy": "LUD"
          },
          "uri": "configuration/entityTypes/HCP/attributes/Phone/attributes/ValidationStatus",
          "skipInDataAccess": false
        },
        {
          "label": "Line Type",
          "name": "LineType",
          "description": "",
          "type": "String",
          "hidden": false,
          "important": false,
          "system": false,
          "required": false,
          "attributeOrdering": {
            "orderingStrategy": "LUD"
          },
          "uri": "configuration/entityTypes/HCP/attributes/Phone/attributes/LineType",
          "skipInDataAccess": false
        },
        {
          "label": "Format Mask",
          "name": "FormatMask",
          "description": "",
          "type": "String",
          "hidden": false,
          "important": false,
          "system": false,
          "required": false,
          "attributeOrdering": {
            "orderingStrategy": "LUD"
          },
          "uri": "configuration/entityTypes/HCP/attributes/Phone/attributes/FormatMask",
          "skipInDataAccess": false
        },
        {
          "label": "Digit Count",
          "name": "DigitCount",
          "description": "",
          "type": "Int",
          "hidden": false,
          "important": false,
          "system": false,
          "required": false,
          "attributeOrdering": {
            "orderingStrategy": "LUD"
          },
          "uri": "configuration/entityTypes/HCP/attributes/Phone/attributes/DigitCount",
          "skipInDataAccess": false
        },
        {
          "label": "Geo Area",
          "name": "GeoArea",
          "description": "",
          "type": "String",
          "hidden": false,
          "important": false,
          "system": false,
          "required": false,
          "attributeOrdering": {
            "orderingStrategy": "LUD"
          },
          "uri": "configuration/entityTypes/HCP/attributes/Phone/attributes/GeoArea",
          "skipInDataAccess": false
        },
        {
          "label": "Geo Country",
          "name": "GeoCountry",
          "description": "",
          "type": "String",
          "hidden": false,
          "important": false,
          "system": false,
          "required": false,
          "attributeOrdering": {
            "orderingStrategy": "LUD"
          },
          "uri": "configuration/entityTypes/HCP/attributes/Phone/attributes/GeoCountry",
          "skipInDataAccess": false
        },
        {
          "label": "Active",
          "name": "Active",
          "description": "DO NOT USE THIS ATTRIBUTE - will be deprecated",
          "type": "Boolean",
          "hidden": true,
          "important": false,
          "system": false,
          "required": false,
          "attributeOrdering": {
            "orderingStrategy": "LUD"
          },
          "uri": "configuration/entityTypes/HCP/attributes/Phone/attributes/Active",
          "skipInDataAccess": false
        }
      ],
      "skipInDataAccess": false
    }
  ]
}
L3 Configuration for Implementation 2
{
  "uri": "configuration/entityTypes/HCP",
  "cleanseConfig": {
    "infos": [
      {
        "uri": "configuration/entityTypes/HCP/cleanse/infos/PhoneCleanserFn1",
        "useInCleansing": true,
        "sequence": [
          {
            "chain": [
              {
                "cleanseFunction": "PhoneCleanserFn",
                "resultingValuesSourceTypeUri": "configuration/sources/ReltioCleanser",
                "proceedOnSuccess": true,
                "proceedOnFailure": true,
                "params": {
                  "licensedCountryCodes": "US"
                },
                "mapping": {
                  "inputMapping": [
                    {
                      "attribute": "configuration/entityTypes/HCP/attributes/Address/attributes/Phone/attributes/Number",
                      "mandatory": true,
                      "allValues": true,
                      "cleanseAttribute": "Number"
                    },
                    {
                      "attribute": "configuration/entityTypes/HCP/attributes/Address/attributes/Phone/attributes/CountryCode",
                      "mandatory": false,
                      "allValues": true,
                      "cleanseAttribute": "CountryCode"
                    },
                    {
                      "attribute": "configuration/entityTypes/HCP/attributes/Address/attributes/Phone/attributes/Type",
                      "mandatory": false,
                      "allValues": true,
                      "cleanseAttribute": "Type"
                    }
                  ],
                  "outputMapping": [
                    {
                      "attribute": "configuration/entityTypes/HCP/attributes/Address/attributes/Phone/attributes/Type",
                      "mandatory": false,
                      "allValues": false,
                      "cleanseAttribute": "Type"
                    },
                    {
                      "attribute": "configuration/entityTypes/HCP/attributes/Address/attributes/Phone/attributes/Number",
                      "mandatory": true,
                      "allValues": false,
                      "cleanseAttribute": "Number"
                    },
                    {
                      "attribute": "configuration/entityTypes/HCP/attributes/Address/attributes/Phone/attributes/CountryCode",
                      "mandatory": false,
                      "allValues": false,
                      "cleanseAttribute": "CountryCode"
                    },
                    {
                      "attribute": "configuration/entityTypes/HCP/attributes/Address/attributes/Phone/attributes/Extension",
                      "mandatory": false,
                      "allValues": false,
                      "cleanseAttribute": "Extension"
                    },
                    {
                      "attribute": "configuration/entityTypes/HCP/attributes/Address/attributes/Phone/attributes/LineType",
                      "mandatory": false,
                      "allValues": false,
                      "cleanseAttribute": "LineType"
                    },
                    {
                      "attribute": "configuration/entityTypes/HCP/attributes/Address/attributes/Phone/attributes/FormatMask",
                      "mandatory": false,
                      "allValues": false,
                      "cleanseAttribute": "FormatMask"
                    },
                    {
                      "attribute": "configuration/entityTypes/HCP/attributes/Address/attributes/Phone/attributes/ValidationStatus",
                      "mandatory": true,
                      "allValues": false,
                      "cleanseAttribute": "ValidationStatus"
                    },
                    {
                      "attribute": "configuration/entityTypes/HCP/attributes/Address/attributes/Phone/attributes/AreaCode",
                      "mandatory": false,
                      "allValues": false,
                      "cleanseAttribute": "AreaCode"
                    },
                    {
                      "attribute": "configuration/entityTypes/HCP/attributes/Address/attributes/Phone/attributes/GeoCountry",
                      "mandatory": false,
                      "allValues": false,
                      "cleanseAttribute": "GeoCountry"
                    },
                    {
                      "attribute": "configuration/entityTypes/HCP/attributes/Address/attributes/Phone/attributes/GeoArea",
                      "mandatory": false,
                      "allValues": false,
                      "cleanseAttribute": "GeoArea"
                    },
                    {
                      "attribute": "configuration/entityTypes/HCP/attributes/Address/attributes/Phone/attributes/DigitCount",
                      "mandatory": false,
                      "allValues": false,
                      "cleanseAttribute": "DigitCount"
                    },
                    {
                      "attribute": "configuration/entityTypes/HCP/attributes/Address/attributes/Phone/attributes/LocalNumber",
                      "mandatory": true,
                      "allValues": false,
                      "cleanseAttribute": "LocalNumber"
                    },
                    {
                      "attribute": "configuration/entityTypes/HCP/attributes/Address/attributes/Phone/attributes/FormattedNumber",
                      "mandatory": true,
                      "allValues": false,
                      "cleanseAttribute": "FormattedNumber"
                    }
                  ]
                }
              }
            ]
          }
        ],
        "nestedAttributeToCleanse": "configuration/entityTypes/HCP/attributes/Address/attributes/Phone"
      }
    ]
  },
  "attributes": [
    {
      "uri": "configuration/entityTypes/HCP/attributes/ID",
      "label": "ID",
      "name": "ID",
      "description": "",
      "type": "String",
      "hidden": false,
      "important": false,
      "attributeOrdering": {
        "orderingStrategy": "LUD"
      }
    },
    {
      "uri": "configuration/entityTypes/HCP/attributes/FirstName",
      "label": "First Name",
      "name": "FirstName",
      "description": "",
      "type": "String",
      "hidden": false,
      "important": false,
      "attributeOrdering": {
        "orderingStrategy": "LUD"
      }
    },
    {
      "uri": "configuration/entityTypes/HCP/attributes/MiddleName",
      "label": "Middle Name",
      "name": "MiddleName",
      "description": "",
      "type": "String",
      "hidden": false,
      "important": false,
      "attributeOrdering": {
        "orderingStrategy": "LUD"
      }
    },
    {
      "uri": "configuration/entityTypes/HCP/attributes/LastName",
      "label": "Last Name",
      "name": "LastName",
      "description": "",
      "type": "String",
      "hidden": false,
      "important": false,
      "attributeOrdering": {
        "orderingStrategy": "LUD"
      }
    },
    {
      "uri": "configuration/entityTypes/HCP/attributes/Initial",
      "label": "Initial",
      "name": "Initial",
      "description": "",
      "type": "String",
      "hidden": false,
      "important": false,
      "attributeOrdering": {
        "orderingStrategy": "LUD"
      }
    },
    {
      "uri": "configuration/entityTypes/HCP/attributes/Name",
      "label": "Name",
      "name": "Name",
      "description": "",
      "type": "String",
      "hidden": false,
      "important": false,
      "attributeOrdering": {
        "orderingStrategy": "LUD"
      }
    },
    {
      "uri": "configuration/entityTypes/HCP/attributes/Address",
      "label": "Address",
      "name": "Address",
      "description": "",
      "type": "Nested",
      "hidden": false,
      "important": false,
      "attributeOrdering": {
        "orderingStrategy": "LUD"
      },
      "attributes": [
        {
          "label": "City",
          "name": "City",
          "type": "String",
          "hidden": false,
          "important": false,
          "system": false,
          "faceted": true,
          "searchable": true,
          "attributeOrdering": {
            "orderingStrategy": "LUD"
          },
          "uri": "configuration/entityTypes/HCP/attributes/Address/attributes/City",
          "skipInDataAccess": false
        },
        {
          "label": "State",
          "name": "StateProvince",
          "type": "String",
          "hidden": false,
          "important": false,
          "system": false,
          "faceted": true,
          "searchable": true,
          "attributeOrdering": {
            "orderingStrategy": "LUD"
          },
          "uri": "configuration/entityTypes/HCP/attributes/Address/attributes/StateProvince",
          "lookupCode": "STATE_CODE",
          "skipInDataAccess": false
        },
        {
          "label": "Zip",
          "name": "Zip",
          "type": "Nested",
          "hidden": false,
          "important": false,
          "system": false,
          "faceted": false,
          "searchable": true,
          "attributeOrdering": {
            "orderingStrategy": "LUD"
          },
          "uri": "configuration/entityTypes/HCP/attributes/Address/attributes/Zip",
          "dataLabelPattern": "{Zip5}-{Zip4}",
          "attributes": [
            {
              "label": "Zip4",
              "name": "Zip4",
              "type": "String",
              "hidden": false,
              "important": false,
              "system": false,
              "faceted": false,
              "searchable": true,
              "attributeOrdering": {
                "orderingStrategy": "LUD"
              },
              "uri": "configuration/entityTypes/HCP/attributes/Address/attributes/Zip/attributes/Zip4",
              "skipInDataAccess": false
            },
            {
              "label": "Zip5",
              "name": "Zip5",
              "type": "String",
              "hidden": false,
              "important": false,
              "system": false,
              "faceted": false,
              "searchable": true,
              "attributeOrdering": {
                "orderingStrategy": "LUD"
              },
              "uri": "configuration/entityTypes/HCP/attributes/Address/attributes/Zip/attributes/Zip5",
              "skipInDataAccess": false
            }
          ],
          "skipInDataAccess": false
        },
        {
          "label": "Address Input",
          "name": "AddressInput",
          "type": "Blob",
          "hidden": false,
          "important": false,
          "system": false,
          "attributeOrdering": {
            "orderingStrategy": "LUD"
          },
          "uri": "configuration/entityTypes/HCP/attributes/Address/attributes/AddressInput",
          "skipInDataAccess": false
        },
        {
          "label": "Address Line 1",
          "name": "AddressLine1",
          "type": "String",
          "hidden": false,
          "important": false,
          "system": false,
          "attributeOrdering": {
            "orderingStrategy": "LUD"
          },
          "uri": "configuration/entityTypes/HCP/attributes/Address/attributes/AddressLine1",
          "skipInDataAccess": false
        },
        {
          "label": "Address Line 2",
          "name": "AddressLine2",
          "type": "String",
          "hidden": false,
          "important": false,
          "system": false,
          "attributeOrdering": {
            "orderingStrategy": "LUD"
          },
          "uri": "configuration/entityTypes/HCP/attributes/Address/attributes/AddressLine2",
          "skipInDataAccess": false
        },
        {
          "label": "Country",
          "name": "Country",
          "type": "String",
          "hidden": false,
          "important": false,
          "system": false,
          "attributeOrdering": {
            "orderingStrategy": "LUD"
          },
          "uri": "configuration/entityTypes/HCP/attributes/Address/attributes/Country",
          "skipInDataAccess": false
        },
        {
          "label": "Country Name",
          "name": "CountryName",
          "description": "DO NOT USE this field - use Country instead",
          "type": "String",
          "hidden": false,
          "important": false,
          "system": false,
          "attributeOrdering": {
            "orderingStrategy": "LUD"
          },
          "uri": "configuration/entityTypes/HCP/attributes/Address/attributes/CountryName",
          "skipInDataAccess": false
        },
        {
          "label": "Phone",
          "name": "Phone",
          "type": "Nested",
          "hidden": false,
          "important": false,
          "system": false,
          "required": false,
          "attributeOrdering": {
            "fieldURI": "configuration/entityTypes/HCP/attributes/Address/attributes/Phone/attributes/Rank",
            "orderType": "ASC",
            "orderingStrategy": "FieldBased"
          },
          "uri": "configuration/entityTypes/HCP/attributes/Address/attributes/Phone",
          "dataLabelPattern": "{Type} {Number}",
          "matchFieldURIs": [
            "configuration/entityTypes/HCP/attributes/Address/attributes/Phone/attributes/Number"
          ],
          "attributes": [
            {
              "label": "Type*",
              "name": "Type",
              "description": "",
              "type": "String",
              "hidden": false,
              "important": false,
              "system": false,
              "required": false,
              "values": [
                "Mobile",
                "Home",
                "Work",
                "Fax",
                "Main",
                "Work Fax",
                "Home Fax",
                "Pager",
                "Other"
              ],
              "attributeOrdering": {
                "orderingStrategy": "LUD"
              },
              "uri": "configuration/entityTypes/HCP/attributes/Address/attributes/Phone/attributes/Type"
            },
            {
              "label": "Number*",
              "name": "Number",
              "description": "",
              "type": "String",
              "hidden": false,
              "important": false,
              "system": false,
              "required": false,
              "attributeOrdering": {
                "orderingStrategy": "LUD"
              },
              "uri": "configuration/entityTypes/HCP/attributes/Address/attributes/Phone/attributes/Number"
            },
            {
              "label": "Country Code*",
              "name": "CountryCode",
              "description": "",
              "type": "String",
              "hidden": false,
              "important": false,
              "system": false,
              "required": false,
              "values": [
                "US",
                "IN",
                "GB",
                "AU"
              ],
              "attributeOrdering": {
                "orderingStrategy": "LUD"
              },
              "uri": "configuration/entityTypes/HCP/attributes/Address/attributes/Phone/attributes/CountryCode"
            },
            {
              "label": "Extension",
              "name": "Extension",
              "description": "",
              "type": "String",
              "hidden": false,
              "important": false,
              "system": false,
              "required": false,
              "attributeOrdering": {
                "orderingStrategy": "LUD"
              },
              "uri": "configuration/entityTypes/HCP/attributes/Address/attributes/Phone/attributes/Extension"
            },
            {
              "label": "Formatted Number",
              "name": "FormattedNumber",
              "type": "String",
              "hidden": false,
              "important": false,
              "system": false,
              "required": false,
              "attributeOrdering": {
                "orderingStrategy": "LUD"
              },
              "uri": "configuration/entityTypes/HCP/attributes/Address/attributes/Phone/attributes/FormattedNumber"
            },
            {
              "label": "Rank",
              "name": "Rank",
              "description": "",
              "type": "Int",
              "hidden": false,
              "important": false,
              "system": false,
              "required": false,
              "attributeOrdering": {
                "orderingStrategy": "LUD"
              },
              "uri": "configuration/entityTypes/HCP/attributes/Address/attributes/Phone/attributes/Rank"
            },
            {
              "label": "Area Code",
              "name": "AreaCode",
              "description": "",
              "type": "String",
              "hidden": false,
              "important": false,
              "system": false,
              "required": false,
              "attributeOrdering": {
                "orderingStrategy": "LUD"
              },
              "uri": "configuration/entityTypes/HCP/attributes/Address/attributes/Phone/attributes/AreaCode"
            },
            {
              "label": "Local Number",
              "name": "LocalNumber",
              "description": "",
              "type": "String",
              "hidden": false,
              "important": false,
              "system": false,
              "required": false,
              "attributeOrdering": {
                "orderingStrategy": "LUD"
              },
              "uri": "configuration/entityTypes/HCP/attributes/Address/attributes/Phone/attributes/LocalNumber"
            },
            {
              "label": "Validation Status",
              "name": "ValidationStatus",
              "description": "",
              "type": "String",
              "hidden": false,
              "important": false,
              "system": false,
              "required": false,
              "attributeOrdering": {
                "orderingStrategy": "LUD"
              },
              "uri": "configuration/entityTypes/HCP/attributes/Address/attributes/Phone/attributes/ValidationStatus"
            },
            {
              "label": "Line Type",
              "name": "LineType",
              "description": "",
              "type": "String",
              "hidden": false,
              "important": false,
              "system": false,
              "required": false,
              "attributeOrdering": {
                "orderingStrategy": "LUD"
              },
              "uri": "configuration/entityTypes/HCP/attributes/Address/attributes/Phone/attributes/LineType"
            },
            {
              "label": "Format Mask",
              "name": "FormatMask",
              "description": "",
              "type": "String",
              "hidden": false,
              "important": false,
              "system": false,
              "required": false,
              "attributeOrdering": {
                "orderingStrategy": "LUD"
              },
              "uri": "configuration/entityTypes/HCP/attributes/Address/attributes/Phone/attributes/FormatMask"
            },
            {
              "label": "Digit Count",
              "name": "DigitCount",
              "description": "",
              "type": "Int",
              "hidden": false,
              "important": false,
              "system": false,
              "required": false,
              "attributeOrdering": {
                "orderingStrategy": "LUD"
              },
              "uri": "configuration/entityTypes/HCP/attributes/Address/attributes/Phone/attributes/DigitCount"
            },
            {
              "label": "Geo Area",
              "name": "GeoArea",
              "description": "",
              "type": "String",
              "hidden": false,
              "important": false,
              "system": false,
              "required": false,
              "attributeOrdering": {
                "orderingStrategy": "LUD"
              },t
              "uri": "configuration/entityTypes/HCP/attributes/Address/attributes/Phone/attributes/GeoArea"
            },
            {
              "label": "Geo Country",
              "name": "GeoCountry",
              "description": "",
              "type": "String",
              "hidden": false,
              "important": false,
              "system": false,
              "required": false,
              "attributeOrdering": {
                "orderingStrategy": "LUD"
              },
              "uri": "configuration/entityTypes/HCP/attributes/Address/attributes/Phone/attributes/GeoCountry"
            },
            {
              "label": "Active",
              "name": "Active",
              "description": "DO NOT USE THIS ATTRIBUTE - will be deprecated",
              "type": "Boolean",
              "hidden": true,
              "important": false,
              "system": false,
              "required": false,
              "attributeOrdering": {
                "orderingStrategy": "LUD"
              },
              "uri": "configuration/entityTypes/HCP/attributes/Address/attributes/Phone/attributes/Active"
            }
          ]
        }
      ]
    }
  ]
}

Example to Understand the Input and Output Fields

Table 2. Example
Options Input Fields Output Fields
{ 
"returnDataForInValidStatus" : "true" 
}
{
"Number": "4420718876",
"CountryCode": "United Kingdom",
"Type": "Home"
}
{
"Type": "Home",
"Number": "4420718876",
"CountryCode": "US",
"FormattedNumber": " 4420718876",
"LocalNumber": "4420718876",
"ValidationStatus": "INVALID",
"LineType": "UNKNOWN",
"FormatMask": "nnnnnnnnnnnn",
"DigitCount": "10",
"GeoArea": "",
"GeoCountry": "United States"
}
{ 
"returnDataForInValidStatus" : "false" 
}
{
"Number": "4420718876",
"CountryCode": "United Kingdom",
"Type": "Home"
}
{
"Type": "Home",
"Number": "4420718876",
"CountryCode": "United Kingdom",
"ValidationStatus": "INVALID"
}
{ 
"enhanceCleansing" : "false" 
}
{
"Number": "442071884676",
"CountryCode": "US",
"Type": "Home"
}
{
"Type": "Home",
"Number": "442071884676",
"CountryCode": "US",
"FormattedNumber": " 442071884676",
"LocalNumber": "442071884676",
"ValidationStatus": "INVALID",
"LineType": "UNKNOWN",
"FormatMask": "nnnnnnnnnnnn",
"DigitCount": "12",
"GeoArea": "",
"GeoCountry": "United States"
}
{ 
"enhanceCleansing" : "true" 
}
{
"Number": "442071884676",
"CountryCode": "US",
"Type": "Home"
}
{
"Type": "Home",
"Number": "+442071884676",
"CountryCode": "GB",
"FormattedNumber": " 020 7188 4676",
"LocalNumber": "71884676",
"ValidationStatus": "VALID",
"LineType": "FIXED_LINE",
"FormatMask": "nnn nnnn nnnn",
"DigitCount": "12",
"GeoArea": "London",
"GeoCountry": "United Kingdom"
}
{ 
"licensedCountryCodes" : "US;IN" 
}
{
"Number": "+919966305879",
"CountryCode": "IN",
"Type": "Home"
}
{
"Type": "Home",
"Number": "+919966305879",
"CountryCode": "IN",
"FormattedNumber": "099663 05879",
"LocalNumber": "9966305879",
"ValidationStatus": "VALID",
"LineType": "MOBILE",
"FormatMask": "nnnnnn nnnnn",
"DigitCount": "11",
"GeoArea": "India",
"GeoCountry": "India"
}
{}
{
"Number": "+919966305879"
}
{
"Number": "+919966305879",
"CountryCode": "IN",
"FormattedNumber": "099663 05879",
"LocalNumber": "9966305879",
"ValidationStatus": "VALID",
"LineType": "MOBILE",
"FormatMask": "nnnnnn nnnnn",
"DigitCount": "11",
"GeoArea": "India",
"GeoCountry": "India"
}
{}
{
"Number": "9966305879"
}
{
"Number": "9966305879",
"CountryCode": "US",
"FormattedNumber": "(996) 630-5879",
"LocalNumber": "9966305879",
"ValidationStatus": "INVALID",
"LineType": "UNKNOWN",
"FormatMask": "(nnn) nnn-nnnn",
"DigitCount": "10"
}
{}
{
"Number": "202-555-0191",
"Type": "Office"
}
{
"Type": "Office",
"Number": "202-555-0191",
"CountryCode": "US",
"FormattedNumber": "(202) 555-0191",
"AreaCode": "202",
"LocalNumber": "5550191",
"ValidationStatus": "VALID",
"LineType": "FIXED_LINE_OR_MOBILE",
"FormatMask": "(nnn) nnn-nnnn",
"DigitCount": "10",
"GeoArea": "Washington D.C.",
"GeoCountry": "United States"
}
{}
{
"Number": "001-541-754-3010",
"CountryCode": "US",
"Type": "Work"
}
{
"Type": "Work",
"Number": "001-541-754-3010",
"CountryCode": "US",
"FormattedNumber": "0015417543010",
"LocalNumber": "0015417543010",
"ValidationStatus": "INVALID",
"LineType": "UNKNOWN",
"FormatMask": "nnnnnnnnnnnnn",
"DigitCount": "13"
}
{}
{
"Number": "1-541-754-3010",
"CountryCode": "US",
"Type": "Work"
}
{
"Type": "Work",
"Number": "1-541-754-3010",
"CountryCode": "US",
"FormattedNumber": "(541) 754-3010",
"AreaCode": "541",
"LocalNumber": "7543010",
"ValidationStatus": "VALID",
"LineType": "FIXED_LINE_OR_MOBILE",
"FormatMask": "(nnn) nnn-nnnn",
"DigitCount": "10",
"GeoArea": "Corvallis, OR",
"GeoCountry": "United States"
}
{}
{
"Number": "+1-541-754-3010",
"CountryCode": "US",
"Type": "Work"
}
{
"Type": "Work",
"Number": "+1-541-754-3010",
"CountryCode": "US",
"FormattedNumber": "(541) 754-3010",
"AreaCode": "541",
"LocalNumber": "7543010",
"ValidationStatus": "VALID",
"LineType": "FIXED_LINE_OR_MOBILE",
"FormatMask": "(nnn) nnn-nnnn",
"DigitCount": "10",
"GeoArea": "Corvallis, OR",
"GeoCountry": "United States"
}
{}
{
"Number": "(541)-754-3010",
"CountryCode": "US",
"Type": "Work"
}
{
"Type": "Work",
"Number": "(541)-754-3010",
"CountryCode": "US",
"FormattedNumber": "(541) 754-3010",
"AreaCode": "541",
"LocalNumber": "7543010",
"ValidationStatus": "VALID",
"LineType": "FIXED_LINE_OR_MOBILE",
"FormatMask": "(nnn) nnn-nnnn",
"DigitCount": "10",
"GeoArea": "Corvallis, OR",
"GeoCountry": "United States"
}
{}
{
"Number": "(541)-754-3010",
"CountryCode": "US",
"Type": "Work"
}
{
"Type": "Work",
"Number": "(541)-754-3010",
"CountryCode": "US"
}