Email verification task API
Start an asynchronous background task to verify entity email attributes using the configured external verifier.
The email verification task runs an asynchronous background job that verifies email attributes for entities
using the configured external verifier. The API verifies all entities in a tenant,
entities of a specific type, or a subset of entities identified by URIs.
Note: The task runs in the background and does not support distributed execution.
Parameters
Use this API to trigger large-scale email verification asynchronously. You can limit the verification by entity type, restrict it to recently updated entities, or provide a list of specific entity URIs. The API schedules a background task and returns a task object representing its status.
Operation Endpoint:
POST /{tenantId}/verification/emailVerifyTask| Category | Parameter | Required | Description |
|---|---|---|---|
| Headers | Authorization | Yes | Bearer token for authentication. Format: "Bearer <accessToken>". |
Content-Type | Yes | Must be application/json. | |
EnvironmentURL | Yes | The Reltio environment URL where the tenant is hosted. | |
| Path | tenantId | Yes | The tenant identifier. The API uses the tenant’s attribute verification configuration to perform validation using the Loqate provider. |
| Query | entityType | No | Specifies the entity type to validate (for example, HCP). |
| Query | updateSince | No | A UNIX timestamp. When specified, only entities updated on or after this time are verified. |
| Query | forceVerify | No |
If true, forces re-verification even when existing results are still valid
based on maxVerificationAge. Default value: false.
|
| Body | urisList | No | Optional list of entity URIs to run verification on. When provided, the task runs only for these specific entities. |
Response structure
- Returns a JSON array containing metadata for the scheduled verification task.
- Each object represents one asynchronous task instance with details such as
id,status,type,createdBy, andparameters. - The
statusfield shows the current state of the task (for example,SCHEDULED,RUNNING,COMPLETED). - Tasks are executed in the background and can be tracked via standard Reltio task monitoring endpoints.
Example request
POST /{tenantId}/verification/emailVerifyTask?entityType=HCP&forceVerify=true
Authorization: Bearer <accessToken>
Content-Type: application/json
[
"entities/f143fa23",
"entities/156sf156",
"entities/0000N4L"
]Example response
[
{
"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": "com.reltio.businesslogic.tasks.cleanse.validator.EmailVerificationTask",
"status": "SCHEDULED",
"name": "Re-Validation of tenant ThiruTest background task. (started by thirupathi.reddy@reltio.com)",
"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"
}
]