Verifier · Developers
Verifier · Developers
WorkspaceOpenAPI JSONQuickstartAPI reference

API reference

107 operations across 12 families. The source contract is available as OpenAPI JSON.

Verification and finder

  • POST /v1/check_email — Verifies an email address and returns a result.
  • GET /v1/emails/{email}/history — Returns the verification history timeline for a specific email address.
  • POST /v1/find_email
  • GET /v1/find_email/{job_id}
  • POST /v1/reputation/check
  • PUT /v1/reverification
  • GET /v1/reverification/status

Bulk and observability

  • POST /v1/bulk — Creates a tenant-scoped bulk job for async processing.
  • GET /v1/bulk/{job_id} — Returns status and current progress for a tenant-scoped v1 bulk job.
  • GET /v1/bulk/{job_id}/results — Returns terminal results for a tenant-scoped v1 bulk job.
  • GET /v1/events — Returns a paginated, filterable audit log of all job events for the tenant.
  • GET /v1/jobs/{job_id} — Returns progress summary and state for a tenant-scoped bulk job.
  • GET /v1/jobs/{job_id}/approval — Returns a pre-send approval checklist summarizing list quality.
  • POST /v1/jobs/{job_id}/cancel — Requests cancellation for a tenant-scoped bulk job.
  • GET /v1/jobs/{job_id}/download — Streams all terminal task results for a tenant-scoped bulk job.
  • GET /v1/jobs/{job_id}/events — Returns paginated event history for a tenant-scoped bulk job.
  • GET /v1/jobs/{job_id}/failure-center
  • GET /v1/jobs/{job_id}/failure-report
  • GET /v1/jobs/{job_id}/latency — Returns verification latency analytics for a job (p50, p95, p99, avg, min, max).
  • GET /v1/jobs/{job_id}/results — Returns paginated completed task results for a tenant-scoped bulk job.
  • POST /v1/jobs/{job_id}/retry — Retries all failed or dead-lettered tasks in a tenant-scoped bulk job.
  • GET /v1/query — Flexible historical query API for verification results across jobs.
  • GET /v1/sources/quality

Lists and collaboration

  • GET /v1/comments
  • POST /v1/comments
  • DELETE /v1/comments/{comment_id}
  • GET /v1/lists
  • POST /v1/lists
  • DELETE /v1/lists/{list_id}
  • GET /v1/lists/{list_id}
  • GET /v1/lists/{list_id}/download
  • GET /v1/lists/{list_id}/quality — Returns a quality benchmark report for a list.
  • POST /v1/lists/{list_id}/remediation-exports
  • GET /v1/lists/{list_id}/remediation-exports/{export_id}/download
  • GET /v1/lists/{list_id}/remediation-plan
  • POST /v1/lists/{list_id}/remediation-plan

Suppressions

  • GET /v1/suppressions
  • POST /v1/suppressions
  • DELETE /v1/suppressions/{id}
  • GET /v1/suppressions/{id}/events
  • GET /v1/suppressions/check
  • GET /v1/suppressions/export
  • POST /v1/suppressions/import

Feedback and providers

  • GET /v1/outcomes
  • POST /v1/outcomes
  • GET /v1/provider-endpoints
  • POST /v1/provider-endpoints
  • DELETE /v1/provider-endpoints/{endpoint_id}
  • PATCH /v1/provider-endpoints/{endpoint_id}

Pipelines

  • GET /v1/pipelines
  • POST /v1/pipelines
  • DELETE /v1/pipelines/{pipeline_id}
  • GET /v1/pipelines/{pipeline_id}
  • PATCH /v1/pipelines/{pipeline_id}
  • POST /v1/pipelines/{pipeline_id}/pause
  • POST /v1/pipelines/{pipeline_id}/push
  • POST /v1/pipelines/{pipeline_id}/resume
  • GET /v1/pipelines/{pipeline_id}/runs
  • GET /v1/pipelines/{pipeline_id}/runs/{run_id}
  • POST /v1/pipelines/{pipeline_id}/trigger

Workspace account

  • GET /v1/me — Returns the authenticated tenant context and quota metadata.
  • GET /v1/me/api-keys — List API keys for the authenticated tenant.
  • POST /v1/me/api-keys — Create a new API key for the authenticated tenant.
  • DELETE /v1/me/api-keys/{key_id} — Revoke an API key.
  • GET /v1/me/api-keys/{key_id} — Return a single API key for the authenticated tenant.
  • PATCH /v1/me/api-keys/{key_id} — Update metadata for an existing API key.
  • GET /v1/me/domains — List all active and inactive domain entries for the authenticated tenant.
  • POST /v1/me/domains — Add a domain for the authenticated tenant.
  • DELETE /v1/me/domains/{domain} — Remove a domain from the authenticated tenant.
  • GET /v1/me/domains/{domain} — Get one domain entry for the authenticated tenant.
  • PATCH /v1/me/domains/{domain} — Update the domain value, status, verification state, or metadata notes.
  • GET /v1/me/settings — Get tenant runtime settings and default operational behavior.
  • PATCH /v1/me/settings — Update tenant settings such as retention, default webhook URL, or secret.
  • GET /v1/me/usage — Return current tenant usage and quota summary.
  • DELETE /v1/me/webhook — Clear tenant webhook URL and signing secret.
  • GET /v1/me/webhook — Get masked tenant webhook integration state.
  • PATCH /v1/me/webhook — Update tenant webhook URL and signing secret.

Provider callback

  • POST /v1/inbound/providers/{provider}/{endpoint_id}/{delivery_token}

Onboarding

  • POST /v1/check-email-with-onboard

Platform admin

  • GET /v1/admin/api-keys — List all API keys across tenants with optional filtering.
  • GET /v1/admin/jobs — List jobs across all tenants with optional filters.
  • GET /v1/admin/jobs/{job_id} — Fetch a single job.
  • GET /v1/admin/jobs/{job_id}/events — Fetch events for a job.
  • GET /v1/admin/jobs/{job_id}/results — Fetch task results for a job.
  • GET /v1/admin/tenants — List tenants with optional status and pagination filters.
  • POST /v1/admin/tenants — Create a new tenant.
  • DELETE /v1/admin/tenants/{tenant_id} — Delete a tenant.
  • GET /v1/admin/tenants/{tenant_id} — Fetch tenant details by tenant ID.
  • PUT /v1/admin/tenants/{tenant_id} — Update tenant fields.
  • GET /v1/admin/tenants/{tenant_id}/api-keys — List API keys for a tenant.
  • POST /v1/admin/tenants/{tenant_id}/api-keys — Create a new API key for a tenant.
  • DELETE /v1/admin/tenants/{tenant_id}/api-keys/{key_id} — Revoke an API key.
  • GET /v1/admin/tenants/{tenant_id}/api-keys/{key_id} — Fetch one API key by tenant and key ID.
  • PATCH /v1/admin/tenants/{tenant_id}/api-keys/{key_id} — Update metadata for an API key.
  • POST /v1/admin/tenants/{tenant_id}/api-keys/{key_id}/reactivate — Reactivate a previously revoked API key.
  • GET /v1/admin/tenants/{tenant_id}/jobs — List jobs scoped to one tenant.
  • GET /v1/admin/tenants/{tenant_id}/quota — Fetch current tenant quota usage and remaining allowance.
  • PATCH /v1/admin/tenants/{tenant_id}/quota — Update tenant quota limit.
  • POST /v1/admin/tenants/{tenant_id}/quota/reset — Reset tenant quota usage counters.

Legacy v0

  • POST /v0/bulk — Creates a legacy bulk verification job and queues tasks synchronously via sqlxmq.
  • GET /v0/bulk/{job_id} — Returns current status and summary for a legacy bulk verification job.
  • GET /v0/bulk/{job_id}/results — Returns terminal result rows for a legacy bulk job.
  • POST /v0/check_email — Legacy email verification endpoint (deprecated, retained for compatibility).

System

  • GET /healthz — Returns a lightweight readiness signal with no upstream dependency checks.
  • GET /openapi.json
  • GET /readyz — Performs dependency checks for Postgres and RabbitMQ and returns readiness status.
  • GET /version — Returns the running server version.

Quickstart

Previous Page

POST /v1/check_email

Next Page