home

Objectives

ReltioProductsDeveloper resourcesRolesApplicationsObjectives
ReltioProductsDeveloper resourcesRolesApplicationsObjectives

Unify and manage your data

Show Contents

thumbnailObjectives

Out-of-the-box Cleanse Functions

Phone cleanser

Learn about the different options available 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.
Important: This validation does not guarantee a phone number exists and is reachable. The cleanser only validates and corrects the format of the number based on the country code.

The phone cleanser works in the same way as the existing custom phone cleanser (configured in the 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 doesn’t 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 doesn’t 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
KeyAllowed ValuesDescription
licensedCountryCodesISO3166-2 country codes with a semicolon (;) separator. For example, US;IN;RUThis 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 the 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.
returnDataForInValidStatusThe following options are available:
  • 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 doesn’t return the cleansed data. It just returns the user input along with ValidationStatus.
enhanceCleansingThe following options are available:
  • 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 doesn’t 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 doesn’t try to re-cleanse the phone number.
formatTypeThe following format types are supported:
  • E164
  • INTERNATIONAL
  • NATIONAL
  • RFC3966
Use this option to determine the output format of the phone number. The default format is NATIONAL. For example:
  • E164: +15417543010
  • INTERNATIONAL: +1 541-754-3010
  • NATIONAL: (541) 754-3010
  • RFC3966:+1-541-754-3010

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",
	      "formatType": "E164"
                },
                "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": false,
                      "allValues": false,
                      "cleanseAttribute": "Phone.LocalNumber"
                    },
                    {
                      "attribute": "configuration/entityTypes/HCP/attributes/Phone/attributes/CarrierInfo",
                      "mandatory": false,
                      "allValues": false,
                      "cleanseAttribute": "Phone.CarrierInfo"
                    },
                    {
                      "attribute": "configuration/entityTypes/HCP/attributes/Phone/attributes/FormattedNumber",
                      "mandatory": true,
                      "allValues": false,
                      "cleanseAttribute": "Phone.FormattedNumber"
                    },
                    {
                      "attribute": "configuration/entityTypes/HCP/attributes/Phone/attributes/FormattedNumber-NATIONAL",
                      "mandatory": false,
                      "allValues": false,
                      "cleanseAttribute": "Phone.FormattedNumber-NATIONAL"
                    },
                    {
                      "attribute": "configuration/entityTypes/HCP/attributes/Phone/attributes/FormattedNumber-INTERNATIONAL",
                      "mandatory": false,
                      "allValues": false,
                      "cleanseAttribute": "Phone.FormattedNumber-INTERNATIONAL"
                    },
                    {
                      "attribute": "configuration/entityTypes/HCP/attributes/Phone/attributes/FormattedNumber-E164",
                      "mandatory": false,
                      "allValues": false,
                      "cleanseAttribute": "Phone.FormattedNumber-E164"
                    },
                    {
                      "attribute": "configuration/entityTypes/HCP/attributes/Phone/attributes/FormattedNumber-RFC3966",
                      "mandatory": false,
                      "allValues": false,
                      "cleanseAttribute": "Phone.FormattedNumber-RFC3966"
                    }
                  ]
                }
              }
            ]
          }
        ]
      }
    ]
  },
  "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/FormattedNumber"
      ],
      "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": "National Formatted Number",
          "name": "FormattedNumber-NATIONAL",
          "type": "String",
          "hidden": false,
          "important": false,
          "system": false,
          "required": false,
          "attributeOrdering": {
            "orderingStrategy": "LUD"
          },
          "uri": "configuration/entityTypes/HCP/attributes/Phone/attributes/FormattedNumber-NATIONAL",
          "skipInDataAccess": false
        },
        {
          "label": "International Formatted Number",
          "name": "FormattedNumber-INTERNATIONAL",
          "type": "String",
          "hidden": false,
          "important": false,
          "system": false,
          "required": false,
          "attributeOrdering": {
            "orderingStrategy": "LUD"
          },
          "uri": "configuration/entityTypes/HCP/attributes/Phone/attributes/FormattedNumber-INTERNATIONAL",
          "skipInDataAccess": false
        },
        {
          "label": "E164 Formatted Number",
          "name": "FormattedNumber-E164",
          "type": "String",
          "hidden": false,
          "important": false,
          "system": false,
          "required": false,
          "attributeOrdering": {
            "orderingStrategy": "LUD"
          },
          "uri": "configuration/entityTypes/HCP/attributes/Phone/attributes/FormattedNumber-E164",
          "skipInDataAccess": false
        },
        {
          "label": "RFC3966 Formatted Number",
          "name": "FormattedNumber-RFC3966",
          "type": "String",
          "hidden": false,
          "important": false,
          "system": false,
          "required": false,
          "attributeOrdering": {
            "orderingStrategy": "LUD"
          },
          "uri": "configuration/entityTypes/HCP/attributes/Phone/attributes/FormattedNumber-RFC3966",
          "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": "CarrierInfo",
          "name": "CarrierInfo",
          "description": "",
          "type": "String",
          "hidden": false,
          "important": false,
          "system": false,
          "required": false,
          "attributeOrdering": {
            "orderingStrategy": "LUD"
          },
          "uri": "configuration/entityTypes/HCP/attributes/Phone/attributes/CarrierInfo",
          "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",
	      "formatType": "E164"
                },
                "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": false,
                      "allValues": false,
                      "cleanseAttribute": "LocalNumber"
                    },
                    {
                      "attribute": "configuration/entityTypes/HCP/attributes/Address/attributes/Phone/attributes/CarrierInfo",
                      "mandatory": false,
                      "allValues": false,
                      "cleanseAttribute": "CarrierInfo"
                    },
                    {
                      "attribute": "configuration/entityTypes/HCP/attributes/Address/attributes/Phone/attributes/FormattedNumber",
                      "mandatory": true,
                      "allValues": false,
                      "cleanseAttribute": "FormattedNumber"
                    },
                    {
                      "attribute": "configuration/entityTypes/HCP/attributes/Address/attributes/Phone/attributes/FormattedNumber-NATIONAL",
                      "mandatory": false,
                      "allValues": false,
                      "cleanseAttribute": "FormattedNumber-NATIONAL"
                    },
                    {
                      "attribute": "configuration/entityTypes/HCP/attributes/Address/attributes/Phone/attributes/FormattedNumber-INTERNATIONAL",
                      "mandatory": false,
                      "allValues": false,
                      "cleanseAttribute": "FormattedNumber-INTERNATIONAL"
                    },
                    {
                      "attribute": "configuration/entityTypes/HCP/attributes/Address/attributes/Phone/attributes/FormattedNumber-E164",
                      "mandatory": false,
                      "allValues": false,
                      "cleanseAttribute": "FormattedNumber-E164"
                    },
                    {
                      "attribute": "configuration/entityTypes/HCP/attributes/Address/attributes/Phone/attributes/FormattedNumber-RFC3966",
                      "mandatory": false,
                      "allValues": false,
                      "cleanseAttribute": "FormattedNumber-RFC3966"
                    }
                  ]
                }
              }
            ]
          }
        ],
        "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/FormattedNumber"
          ],
          "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": "National Formatted Number",
              "name": "FormattedNumber-NATIONAL",
              "type": "String",
              "hidden": false,
              "important": false,
              "system": false,
              "required": false,
              "attributeOrdering": {
                "orderingStrategy": "LUD"
              },
              "uri": "configuration/entityTypes/HCP/attributes/Address/attributes/Phone/attributes/FormattedNumber-NATIONAL"
            },
            {
              "label": "International Formatted Number",
              "name": "FormattedNumber-INTERNATIONAL",
              "type": "String",
              "hidden": false,
              "important": false,
              "system": false,
              "required": false,
              "attributeOrdering": {
                "orderingStrategy": "LUD"
              },
              "uri": "configuration/entityTypes/HCP/attributes/Address/attributes/Phone/attributes/FormattedNumber-INTERNATIONAL"
            },
            {
              "label": "E164 Formatted Number",
              "name": "FormattedNumber-E164",
              "type": "String",
              "hidden": false,
              "important": false,
              "system": false,
              "required": false,
              "attributeOrdering": {
                "orderingStrategy": "LUD"
              },
              "uri": "configuration/entityTypes/HCP/attributes/Address/attributes/Phone/attributes/FormattedNumber-E164"
            },
            {
              "label": "RFC3966 Formatted Number",
              "name": "FormattedNumber-RFC3966",
              "type": "String",
              "hidden": false,
              "important": false,
              "system": false,
              "required": false,
              "attributeOrdering": {
                "orderingStrategy": "LUD"
              },
              "uri": "configuration/entityTypes/HCP/attributes/Address/attributes/Phone/attributes/FormattedNumber-RFC3966"
            },
            {
              "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": "CarrierInfo",
              "name": "CarrierInfo",
              "description": "",
              "type": "String",
              "hidden": true,
              "important": false,
              "system": false,
              "required": false,
              "attributeOrdering": {
                "orderingStrategy": "LUD"
              },
              "uri": "configuration/entityTypes/HCP/attributes/Address/attributes/Phone/attributes/CarrierInfo"
            }
          ]
        }
      ]
    }
  ]
}

Input cleanse attributes

Field nameRequired
NumberYes
CountryCodeNo
TypeNo

Output cleanse fields

Field nameRequired
NumberYes
CountryCodeNo
TypeNo
ExtensionNo
LineTypeNo
FormatMaskNo
AreaCodeNo
GeoCountryNo
GeoAreaNo
DigitCountNo
LocalNumberNo
FormattedNumberYes
ValidationStatusYes
CarrierInfoNo
FormattedNumber-NATIONALNo
FormattedNumber-INTERNATIONALNo
FormattedNumber-E164No
FormattedNumber-RFC3966No

Example to understand the input and output fields

Table 2. Example
OptionsInput FieldsOutput 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"
}
{ "licensedCountryCodes" : "RU;IN" } 
{
"Number": "(541)-754-3010",
"CountryCode": "US",
"Type": "Work"
}
 
{
"Type": "Work",
"Number": "(541)-754-3010",
"CountryCode": "US"
}
{ "formatType" : "E164" } 
{
"Number": "(541)-754-3010",
"CountryCode": "US",
"Type": "Work"
}
 
{
"Type": "Work",
"Number": "+15417543010",
"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"
}

Updated on December 9, 2024

Footer

You've found your way to a temporary environment. Content is not complete or final. Looking for Reltio documentation? Go to docs.reltio.com.

Company

Leadership

Careers

Awards

Contact Us

Reltio Newsroom

Press Releases

Media Coverage

Media & Analyst Resources

Customer Support

Support

Reltio Learn

Community

Developer Portal

100 Marine Parkway, Suite 275

Redwood Shores, CA 94065

USA

North America: +1(855)360-3282

Europe: +44(800)368-7643

Email: sales@reltio.com

© 2024 The RELTIO® mark is a registered trademark of Reltio, Inc. in the United States and other countries; DataDriven and Reltio Data Cloud are trademarks of Reltio, Inc. Other names or marks are trademarks of their respective owners.

Terms, Privacy Policy, and