Unify and manage your data

Entity verification API

Verify email or phone attributes on a specific entity and persist the results.

The entity verification checks email and phone attributes on a given entity based on your license. When invoked, it verifies the operational values, updates verification attributes such as VerificationStatus, IsValid, and LastVerifiedTime, and returns the full updated entity. To optimize performance and reduce external calls, the API reuses stored results if they are still considered fresh, based on the configurable maxVerificationAge. You can override this behavior with the forceVerify parameter.

Request

Operation Endpoint:

POST /entities/{entityUri}/attributeVerification/_verify
CategoryParameterRequiredDescription
HeadersAuthorizationYesBearer token for authentication. Format: "Bearer <accessToken>".
Content-TypeYesMust be application/json.
EnvironmentURLYesThe Reltio environment URL.
PathentityUriYesThe URI of the entity to verify.
QueryforceVerifyNoIf set to true, forces verification even if existing results are still within maxVerificationAge.
QueryclientFilterNoRestricts verification to a type. Supported values: EmailVerifier, PhoneVerifier. Omit to run all applicable verifiers.

Response

Response Structure:

  • Returns the full entity JSON with updated verification attributes for email and phone values based on the output mapping in the L3 configuration
  • If cached results are reused, the entity is returned without a new call.
  • In case of errors, the response contains errorCode, errorMessage, and detailed cause information.

Request

POST /entities/0000N4L/attributeVerification/_verify?forceVerify=false&clientFilter=PhoneVerifier
Authorization: Bearer <accessToken>
Content-Type: application/json

Response

{
  "uri": "entities/0000N4L",
  "type": "configuration/entityTypes/HCP",
  "createdBy": "ayush.shetty@reltio.com",
  "createdTime": 1757578426739,
  "updatedBy": "ayush.shetty@reltio.com",
  "updatedTime": 1757578434846,
  "attributes": {
    "Phone": [
      {
        "label": "9686777126",
        "value": {
          "Number": [
            {
              "type": "configuration/entityTypes/HCP/attributes/Phone/attributes/Number",
              "ov": true,
              "value": "9686777126",
              "uri": "entities/0000N4L/attributes/Phone/1n1iFl/Number/1n1mW1"
            }
          ],
          "CountryCode": [
            {
              "type": "configuration/entityTypes/HCP/attributes/Phone/attributes/CountryCode",
              "ov": true,
              "value": "IN",
              "uri": "entities/0000N4L/attributes/Phone/1n1iFl/CountryCode/1n1qmH"
            }
          ],
          "isValid": [
            {
              "type": "configuration/entityTypes/HCP/attributes/Phone/attributes/isValid",
              "ov": true,
              "value": "Yes",
              "uri": "entities/0000N4L/attributes/Phone/1n1iFl/isValid/1n2wyP"
            }
          ],
          "LastVerifiedTime": [
            {
              "type": "configuration/entityTypes/HCP/attributes/Phone/attributes/LastVerifiedTime",
              "ov": true,
              "value": "2025-09-11T08:13:56.361591200Z",
              "uri": "entities/0000N4L/attributes/Phone/1n1iFl/LastVerifiedTime/1n35Uv"
            }
          ],
          "NetworkName": [
            {
              "type": "configuration/entityTypes/HCP/attributes/Phone/attributes/NetworkName",
              "ov": true,
              "value": "Airtel India - Karnataka (45) (Bharti Airtel)",
              "uri": "entities/0000N4L/attributes/Phone/1n1iFl/NetworkName/1n3E1R"
            }
          ]
        },
        "ov": true,
        "uri": "entities/0000N4L/attributes/Phone/1n1iFl"
      }
    ],
    "Email": [
      {
        "label": "jane.doe@healthcare.org",
        "value": {
          "Email": [
            {
              "type": "configuration/entityTypes/HCP/attributes/Email/attributes/Email",
              "ov": true,
              "value": "jane.doe@healthcare.org",
              "uri": "entities/0000N4L/attributes/Email/1n1RCj/Email/1n1VSz"
            }
          ],
          "VerificationStatus": [
            {
              "type": "configuration/entityTypes/HCP/attributes/Email/attributes/VerificationStatus",
              "ov": true,
              "value": "Invalid",
              "uri": "entities/0000N4L/attributes/Email/1n1RCj/VerificationStatus/1n27pJ"
            }
          ],
          "LastVerifiedTime": [
            {
              "type": "configuration/entityTypes/HCP/attributes/Email/attributes/LastVerifiedTime",
              "ov": true,
              "value": "2025-09-11T08:13:54.894801500Z",
              "uri": "entities/0000N4L/attributes/Email/1n1RCj/LastVerifiedTime/1n2GLp"
            }
          ],
          "IsSystemMailbox": [
            {
              "type": "configuration/entityTypes/HCP/attributes/Email/attributes/IsSystemMailbox",
              "ov": true,
              "value": "false",
              "uri": "entities/0000N4L/attributes/Email/1n1RCj/IsSystemMailbox/1n2OsL"
            }
          ]
        },
        "ov": true,
        "uri": "entities/0000N4L/attributes/Email/1n1RCj"
      },
      {
        "label": "john.doe@healthcare.org",
        "value": {
          "Email": [
            {
              "type": "configuration/entityTypes/HCP/attributes/Email/attributes/Email",
              "ov": true,
              "value": "john.doe@healthcare.org",
              "uri": "entities/0000N4L/attributes/Email/1n1ZjF/Email/1n1dzV"
            }
          ],
          "VerificationStatus": [
            {
              "type": "configuration/entityTypes/HCP/attributes/Email/attributes/VerificationStatus",
              "ov": true,
              "value": "Invalid",
              "uri": "entities/0000N4L/attributes/Email/1n1ZjF/VerificationStatus/1n2XOr"
            }
          ],
          "LastVerifiedTime": [
            {
              "type": "configuration/entityTypes/HCP/attributes/Email/attributes/LastVerifiedTime",
              "ov": true,
              "value": "2025-09-11T08:13:54.894801500Z",
              "uri": "entities/0000N4L/attributes/Email/1n1ZjF/LastVerifiedTime/1n2fvN"
            }
          ],
          "IsSystemMailbox": [
            {
              "type": "configuration/entityTypes/HCP/attributes/Email/attributes/IsSystemMailbox",
              "ov": true,
              "value": "false",
              "uri": "entities/0000N4L/attributes/Email/1n1ZjF/IsSystemMailbox/1n2oRt"
            }
          ]
        },
        "ov": true,
        "uri": "entities/0000N4L/attributes/Email/1n1ZjF"
      }
    ]
  },
  "isFavorite": false,
  "crosswalks": [
    {
      "uri": "entities/0000N4L/crosswalks/1n1v2X",
      "type": "configuration/sources/Reltio",
      "value": "0000N4L",
      "reltioLoadDate": "2025-09-11T13:43:46.739+05:30",
      "createDate": "2025-09-11T13:43:46.739+05:30",
      "updateDate": "2025-09-11T13:43:46.739+05:30",
      "attributes": [
        "entities/0000N4L/attributes/Phone/1n1iFl/Number/1n1mW1",
        "entities/0000N4L/attributes/Email/1n1ZjF",
        "entities/0000N4L/attributes/Email/1n1RCj",
        "entities/0000N4L/attributes/Phone/1n1iFl",
        "entities/0000N4L/attributes/Email/1n1RCj/Email/1n1VSz",
        "entities/0000N4L/attributes/Phone/1n1iFl/CountryCode/1n1qmH",
        "entities/0000N4L/attributes/Email/1n1ZjF/Email/1n1dzV"
      ],
      "singleAttributeUpdateDates": {}
    },
    {
      "uri": "entities/0000N4L/crosswalks/1n23Z3",
      "type": "configuration/sources/ReltioVerifier",
      "value": "0000N4L",
      "reltioLoadDate": "2025-09-11T13:43:54.846+05:30",
      "createDate": "2025-09-11T13:43:54.846+05:30",
      "updateDate": "2025-09-11T13:43:54.846+05:30",
      "attributes": [
        "entities/0000N4L/attributes/Email/1n1RCj/IsSystemMailbox/1n2OsL",
        "entities/0000N4L/attributes/Phone/1n1iFl/LastVerifiedTime/1n35Uv",
        "entities/0000N4L/attributes/Phone/1n1iFl/NetworkName/1n3E1R",
        "entities/0000N4L/attributes/Email/1n1RCj/LastVerifiedTime/1n2GLp",
        "entities/0000N4L/attributes/Email/1n1ZjF/VerificationStatus/1n2XOr",
        "entities/0000N4L/attributes/Email/1n1ZjF/LastVerifiedTime/1n2fvN",
        "entities/0000N4L/attributes/Phone/1n1iFl/isValid/1n2wyP",
        "entities/0000N4L/attributes/Email/1n1RCj/VerificationStatus/1n27pJ",
        "entities/0000N4L/attributes/Email/1n1ZjF/IsSystemMailbox/1n2oRt"
      ],
      "singleAttributeUpdateDates": {
        "entities/0000N4L/attributes/Email/1n1RCj/IsSystemMailbox/1n2OsL": "2025-09-11T13:43:54.846+05:30",
        "entities/0000N4L/attributes/Phone/1n1iFl/LastVerifiedTime/1n35Uv": "2025-09-11T13:43:54.846+05:30",
        "entities/0000N4L/attributes/Phone/1n1iFl/NetworkName/1n3E1R": "2025-09-11T13:43:54.846+05:30",
        "entities/0000N4L/attributes/Email/1n1RCj/LastVerifiedTime/1n2GLp": "2025-09-11T13:43:54.846+05:30",
        "entities/0000N4L/attributes/Email/1n1ZjF/VerificationStatus/1n2XOr": "2025-09-11T13:43:54.846+05:30",
        "entities/0000N4L/attributes/Email/1n1ZjF/LastVerifiedTime/1n2fvN": "2025-09-11T13:43:54.846+05:30",
        "entities/0000N4L/attributes/Phone/1n1iFl/isValid/1n2wyP": "2025-09-11T13:43:54.846+05:30",
        "entities/0000N4L/attributes/Email/1n1RCj/VerificationStatus/1n27pJ": "2025-09-11T13:43:54.846+05:30",
        "entities/0000N4L/attributes/Email/1n1ZjF/IsSystemMailbox/1n2oRt": "2025-09-11T13:43:54.846+05:30"
      }
    }
  ],
  "analyticsAttributes": {},
  "label": "",
  "secondaryLabel": ""
}