Configure email and phone verification

Learn how to configure email and phone verification in your tenant.

Before you configure phone and email verification, ensure your tenant has a valid license for the verification feature. Connect with your CSM / Account Manager to license the feature. Once enabled on your tenant by Reltio, you can update the L3 configuration to use the Entity Verification API. Batch Verification API does not require L3 update.You must have the ROLE_ADMIN_TENANT role, or a custom role with permission to update L3 configuration.

Configure email and phone verification by adding an attributeVerificationConfig section to your tenant’s L3 configuration. This defines the verifier type, input and output mappings, and freshness settings. The configuration is required only for entity verification API and Email verification task. L3 configuration is not required if you want to use only the batch APIs - to verify the data but not store the results in an entity in Reltio

Get your tenant’s L3 configuration. See GET Configuration.
Update the L3 configuration by adding the attributeVerificationConfig section with email and phone verifier definitions.

Define the input and output mappings for email and phone attributes at the entity type level.

Example mappings for an HCP entity type:

{
  "uri": "configuration/entityTypes/HCP",
  "cleanseConfig": {
    "attributeVerificationConfig": [
      {
        "verificationFunction": "EmailVerifier",
        "resultingValuesSourceTypeUri": "configuration/sources/ReltioVerifier",
        "params": {
          "maxVerificationAge": 21
        },
        "inputMapping": [
          {
            "attribute": "configuration/entityTypes/HCP/attributes/Email/attributes/Email",
            "verificationAttribute": "Email",
            "mandatory": true
          }
        ],
        "outputMapping": [
          {
            "attribute": "configuration/entityTypes/HCP/attributes/Email/attributes/VerificationStatus",
            "verificationAttribute": "Status",
            "mandatory": true
          },
          {
            "attribute": "configuration/entityTypes/HCP/attributes/Email/attributes/LastVerifiedTime",
            "verificationAttribute": "VerifiedOn",
            "mandatory": true
          },
          {
            "attribute": "configuration/entityTypes/HCP/attributes/Email/attributes/IsDisposable",
            "verificationAttribute": "IsDisposable",
            "mandatory": false
          },
          {
            "attribute": "configuration/entityTypes/HCP/attributes/Email/attributes/IsSystemMailbox",
            "verificationAttribute": "IsSystemMailbox",
            "mandatory": false
          }
        ]
      },
      {
        "verificationFunction": "PhoneVerifier",
        "resultingValuesSourceTypeUri": "configuration/sources/ReltioVerifier",
        "params": {
          "maxVerificationAge": 21
        },
        "inputMapping": [
          {
            "attribute": "configuration/entityTypes/HCP/attributes/Phone/attributes/Number",
            "verificationAttribute": "Phone",
            "mandatory": true
          },
          {
            "attribute": "configuration/entityTypes/HCP/attributes/Phone/attributes/CountryCode",
            "verificationAttribute": "Country",
            "mandatory": false
          }
        ],
        "outputMapping": [
          {
            "attribute": "configuration/entityTypes/HCP/attributes/Phone/attributes/IsValid",
            "verificationAttribute": "IsValid",
            "mandatory": true
          },
          {
            "attribute": "configuration/entityTypes/HCP/attributes/Phone/attributes/LastVerifiedTime",
            "verificationAttribute": "VerifiedOn",
            "mandatory": true
          },
          {
            "attribute": "configuration/entityTypes/HCP/attributes/Phone/attributes/NetworkName",
            "verificationAttribute": "NetworkName",
            "mandatory": false
          }
        ]
      }
    ]
  }
}

The following parameters control the behavior of the email verification function:


Name	Type	Description
verificationFunction	String	Defines the verifier to be used. For email verification, use "EmailVerifier". For phone verification, use "PhoneVerifier"
resultingValuesSourceTypeUri	String	Source type that stores the verification results. You can reuse an existing source like "configuration/sources/ReltioCleanser" or create a new source like "configuration/sources/ReltioVerifier"
maxVerificationAge	Integer	The number of days after which stored verification results are considered stale. This is used only for Entity Verification API and Entity Verification Task. It is not useful for batch APIs. When `forceVerify` is false and the previously verified result is older than this value, the system performs a new verification. Otherwise, the previously verified result is returned. When `forceVerify` is true, `maxVerificationAge` is ignored and platform performs a fresh verification

Save the updated configuration back to your tenant. See Set Configuration.

Your tenant is now configured to use email and phone verification. The verification APIs will use this configuration to validate attribute values, enforce freshness rules, and persist results in entities where applicable.

For more information about using the APIs, see topics:

Unify and manage your data

Configure email and phone verification

Footer