Configure email and phone verification

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

Configure email and phone verification by adding an attributeVerificationConfig section to your tenant's L3 configuration. This section defines the verification function, input and output mappings, and freshness settings used when verification results are written back to entity attributes.

Some provider-level settings are configured separately in Tenant Configuration in Reltio Console. For more information, see Email verification and Phone verification.

L3 configuration is required for the Entity Verification API, Email Verification Task, and Phone Verification Task. It is not required for batch verification APIs, which return verification results in the response without writing them to entities.

Prerequisites

Make sure your tenant has a valid license for this feature. Contact your CSM or account manager to enable it for your tenant.
You must have the ROLE_ADMIN_TENANT role, or a custom role with permission to update the L3 configuration.

To configure email and phone verification:

Get your tenant’s L3 configuration. See GET Configuration.
Under the relevant entity type, add an attributeVerificationConfig section inside cleanseConfig.

Define the verificationFunction, resultingValuesSourceTypeUri, params, inputMapping, and outputMapping values for email and phone verification.

The following example shows 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 and phone verification function:


Name	Type	Description
`verificationFunction`	String	Defines the verification function to use. Use `EmailVerifier` for email verification and `PhoneVerifier` for phone verification.
`resultingValuesSourceTypeUri`	String	Specifies the source type used to store verification results. You can reuse an existing source, such as `configuration/sources/ReltioCleanser`, or create a dedicated source, such as `configuration/sources/ReltioVerifier`.
`maxVerificationAge`	Integer	Specifies the number of days a previous verification result can be reused before a new verification is required. This parameter applies to the Entity Verification API and the Email Verification Task. It does not apply to batch verification APIs. When `forceVerify` is `false` and the stored result is older than this value, the platform performs a new verification. When `forceVerify` is `true`, the platform ignores `maxVerificationAge` and performs a new verification.
`inputMapping`	Array	Maps verification request attributes to your entity attributes. Use this mapping to define which entity attributes provide the input values for verification. For more information about supported request attributes, see Email batch verification and Phone batch verification .
`outputMapping`	Array	Maps verification response attributes to your entity attributes. Use this mapping to define where verification results are written on the entity. For more information about supported response attributes, see Email batch verification and Phone batch verification .

Save the updated configuration back to your tenant.

Result

Your tenant is now configured for entity-based email and phone verification. The Entity Verification API and the Email Verification Task can use this configuration to validate values, apply freshness rules, and write verification results to mapped attributes.

Unify and manage your data

Configure email and phone verification

Footer