Skip to main content
POST
Start validation run

Authorizations

Authorization
string
header
required

Path Parameters

workspaceID
string
required

Workspace ID

Body

application/json

Start validation run request

The body is of type object.

Response

Validation initiated

failureCode
enum<string>

FailureCode identifies a stable terminal failure reason.

Available options:
validation_scope_empty,
insufficient_credits,
validation_execution_failed,
validation_timed_out,
validation_results_sync_failed,
credit_reservation_failed,
credit_reconciliation_failed,
validation_processing_failed
matched
integer

Matched counts contacts returned while resolving the submitted scope. Deprecated: use selected at submission and validation results after completion.

message
string

Deprecated: inspect status and failureCode on validation results instead.

selected
integer

Selected counts the exact candidates frozen for this run.

skipped
object

Skipped reports exact request-time duplicate exclusions.

started
boolean

Deprecated: Started is retained as true for accepted asynchronous submissions.

status
enum<string>

Status is the lifecycle status at submission completion.

Available options:
pending,
failed
Example:

"pending"

validationJobID
string