VerifiedInbox

API Reference · Eligibility

Watch Eligibility

Email me when this domain qualifies

POST/v1/applications/{application_id}/eligibility/watch
Free (guest token or account)MCP:watch_eligibility

cURL example

cURL request
curl -X POST "https://api.verifiedinbox.ai/v1/applications/0192a5e0-1234-7000-8000-000000000001/eligibility/watch" \
  -H "VI-Guest-Token: vi_guest_YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "email": "alex@acme.com"
  }'

Parameters

ParameterTypeDescription
application_idpathrequired
string (uuid)Application id.
VI-Environmentheader
string`live` (default) or `test`. Used for anonymous callers and OAuth access tokens; API keys and web sessions carry their own environment.

Request body

application/json · required
FieldTypeDescription
emailrequired
string (email)

Where to send the email when the domain qualifies.

Example request payload (WatchEligibilityRequest)
{
  "email": "alex@acme.com"
}

Response

201 OKWatching.
application/json
FieldTypeDescription
emailrequired
string—
messagerequired
string—
watchingrequired
boolean—
Example 201 response (WatchEligibility)
{
  "email": "alex@acme.com",
  "message": "Everything checks out.",
  "watching": true
}

Other responses & possible errors

Expand a status code below to see the error code, description, and example error payload.

400 (invalid_request)`invalid_request` — the request is malformed.

`invalid_request` — the request is malformed.

Example 400 error response
{
  "error": {
    "code": "invalid_request",
    "message": "Please provide a valid domain name."
  }
}
401 (unauthenticated)`unauthenticated` — sign in / send a valid credential. `next_action.kind = sign_in`.

`unauthenticated` — sign in / send a valid credential. `next_action.kind = sign_in`.

Example 401 error response
{
  "error": {
    "code": "unauthenticated",
    "message": "Sign in or provide an API key to continue.",
    "next_action": {
      "kind": "sign_in",
      "title": "Sign in or create an account",
      "url": "/login"
    }
  }
}
404 (not_found)`not_found` — doesn't exist or isn't accessible to you (never 403).

`not_found` — doesn't exist or isn't accessible to you (never 403).

Example 404 error response
{
  "error": {
    "code": "not_found",
    "message": "We couldn't find that resource."
  }
}
422 (unprocessable)`unprocessable` / `blocked_provider` — understood but can't be done (plain-English reason).

`unprocessable` / `blocked_provider` — understood but can't be done (plain-English reason).

Example 422 error response
{
  "error": {
    "code": "unprocessable",
    "message": "Shared mailbox providers like gmail.com cannot be verified."
  }
}
429 (rate_limited)`rate_limited` — retry after `Retry-After` seconds (`details.retry_after_seconds`). `limit_reached` — a quota is used up; `details.limit` names it and `next_action` offers support.

`rate_limited` — retry after `Retry-After` seconds (`details.retry_after_seconds`). `limit_reached` — a quota is used up; `details.limit` names it and `next_action` offers support.

Example 429 error response
{
  "error": {
    "code": "rate_limited",
    "message": "Too many requests. Please wait a moment and try again."
  }
}
Was it helpful?