Phone verification task

Learn more about how to start an asynchronous task that verifies entity phone attributes using the configured verification provider.

Use the Phone verification task to start an asynchronous background task that verifies entity phone attributes using the configured external verifier. You can run the task for all entities in a tenant, entities of a specific type, or a subset of entities identified by URI.

The Phone verification task runs in the background and does not support distributed execution.

HTTP method and endpoint

Use the following HTTP method and endpoint path to submit the request:

POST {EnvironmentURL}/reltio/api/{tenantId}/verification/phoneVerifyTask

Replace {EnvironmentURL} with your Reltio environment URL.

The following table describes the endpoint path parameters.


Parameter	Type	Required	Description
`tenantId`	String	Yes	The unique identifier of the tenant. Specifies the tenant context for the request.

Query parameters

The following table describes the query parameters and their values.


Name	Type	Required	Description	Accepted values / Default
`entityType`	String	No	Limits verification to entities of a specific type.	Example: `HCP`
`updateSince`	Number	No	UNIX timestamp. When specified, only entities updated at or after this time are verified.	No default
`forceVerify`	Boolean	No	Forces verification regardless of the max age of the last verification result.	`true` or `false`. Default: `false`

Request headers

The following request headers must be included.


Header	Value	Required
`Authorization`	Bearer `<access_token>`	Yes
`Content-Type`	application/json	Yes

Request body

The following table describes the request body parameters, including accepted values and defaults.


Parameter	Type	Required	Description	Accepted values / Default
`urisList`	Array of strings	No	List of entity URIs to verify. When provided, the task runs only for those entities.	No default

Example request

Use the following example to see how a complete request is structured with headers and a JSON body.

POST {EnvironmentURL}/reltio/api/ThiruTest/verification/phoneVerifyTask?entityType=HCP&forceVerify=true
Authorization: Bearer <accessToken>
Content-Type: application/json

[
  "entities/f143fa23",
  "entities/156sf156",
  "entities/0000N4L"
]

Response body

The following table describes the fields returned in the response body.


Field	Type	Description
`id`	String	Unique identifier of the task instance.
`groupId`	String	Identifier of the task group associated with the task instance.
`createdTime`	Number	Time when the task was created, in epoch milliseconds.
`createdBy`	String	User who created the task.
`updatedTime`	Number	Time when the task was last updated, in epoch milliseconds.
`updatedBy`	String	User or process that last updated the task.
`type`	String	Internal task type for the scheduled phone verification task.
`status`	String	Current task status, such as `SCHEDULED`, `RUNNING`, or `COMPLETED`.
`name`	String	Human-readable task name.
`createdOnHost`	String	Host where the task was created.
`parallelExecution`	Boolean	Indicates whether the task supports parallel execution.
`nodesGroup`	String	Node group assigned to the task.
`parameters`	Object	Parameters used to run the task, such as tenant, entity type, updated-since value, force flag, and URI list.
`currentState`	Object	Current runtime state of the task.
`duration`	String	Elapsed task duration.

Example response

The following example starts an phone verification task for a specific entity type and a specific list of entities.

[
  {
    "id": "ac72c210-5921-4eca-a6a0-1bd896696b9e",
    "groupId": "32636aad-bd93-43cf-9a9d-63aa4a48a379",
    "createdTime": 1760512978272,
    "createdBy": "testuser@reltio.com",
    "updatedTime": 1760512978272,
    "updatedBy": "testuser@reltio.com",
    "type": "[To confirm: phone verification task type]",
    "status": "SCHEDULED",
    "name": "[To confirm: phone verification task name]",
    "createdOnHost": "Thirupathis-MacBook-Pro.local",
    "parallelExecution": false,
    "nodesGroup": "default",
    "parameters": {
      "tenantId": "ThiruTest",
      "entityType": "HCP",
      "updatedSince": "0",
      "force": "true",
      "uriList": "",
      "batchSize": "100",
      "forceCleansing": "false"
    },
    "currentState": {},
    "duration": "0s"
  }
]

Unify and manage your data