API Reference · Applications

Claim Application

Move a guest draft into the account

POST/v1/applications/{application_id}/claim

Account requiredScope:applications:writeMCP:claim_application

Send the account credential plus the guest credential (VI-Guest-Token). Atomic; when the account already has the domain the more advanced application is kept.

cURL example

cURL request

curl -X POST "https://api.verifiedinbox.ai/v1/applications/0192a5e0-1234-7000-8000-000000000001/claim" \
  -H "Authorization: Bearer vi_live_YOUR_API_KEY"

Parameters

Parameter	Type	Description
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.

Response

200 OKClaim result.

application/json

Field	Type	Description
applicationrequired	Application	The server-side state of one domain's journey. Nested fields (22) `background` (BackgroundWork[]): Active long-running work plus anything finished in the last 10 minutes. `brand_name` (string): Display-name guess (website title or domain label). `contact_email` (string) `created_at` (string (date-time)) `current_step` (string): Where to work now: the first step needing attention, else the first step the user hasn't completed. `domain` (string): Normalized ASCII (punycode) domain. `domain_display` (string): Unicode form of the domain. `domain_status` (string): Whether the domain is registered and can have its own logo (`unknown` while checking). `email_usage` (string): How email is used on the domain, as told by the customer (null until answered). `environment` (string) `id` (string (uuid)) `next_actions` (NextAction[]): What to do next (for people and agents). `organizational_domain` (string): Registrable domain (e.g. `acme.com` for `news.acme.com`). `outcomes` (Outcomes): Separate outcomes — never collapsed into one "verified" flag. `owner` (ApplicationOwner) `product` (string): Chosen product, else the recommended one. `product_selected` (string): Product explicitly chosen by the customer. `recommended_product` (string): From eligibility; null until assessed. `steps` (Step[]): The 11 wizard steps, in order. `updated_at` (string (date-time)) `version` (integer): Optimistic-concurrency version; send as `If-Match`. `web_url` (string): Deep link to the current step in the web app.
kept_application_idrequired	string (uuid)	—
resultrequired	string	— Allowed: `claimed`, `merged_into_existing`

Example 200 response (ClaimResult)

{
  "application": {
    "background": [],
    "brand_name": "string",
    "contact_email": "string",
    "created_at": "2026-10-31T12:00:00Z",
    "current_step": "domain",
    "domain": "acme.com",
    "domain_display": "string",
    "domain_status": "unknown",
    "email_usage": "none",
    "environment": "live",
    "id": "0192a5e0-1234-7000-8000-000000000001",
    "next_actions": [],
    "organizational_domain": "string",
    "outcomes": {
      "bimi": "not_published",
      "business": "not_started",
      "certificate": "not_ordered",
      "dmarc_rollout": "missing",
      "eligibility": "unknown",
      "inbox_display": "not_observed",
      "logo": "missing",
      "ownership": "pending",
      "payment": "unpaid",
      "trademark": "not_started"
    },
    "owner": {
      "type": "guest"
    },
    "product": "vmc",
    "product_selected": "vmc",
    "recommended_product": "vmc",
    "steps": [],
    "updated_at": "2026-10-31T12:00:00Z",
    "version": 1,
    "web_url": "https://verifiedinbox.ai/verify/0192a5e0-1234-7000-8000-000000000001/domain"
  },
  "kept_application_id": "0192a5e0-1234-7000-8000-000000000001",
  "result": "claimed"
}

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"
    }
  }
}

403 (insufficient_scope)`forbidden` / `insufficient_scope` — the credential lacks permission.

`forbidden` / `insufficient_scope` — the credential lacks permission.

Example 403 error response

{
  "error": {
    "code": "insufficient_scope",
    "message": "This API key does not have the required scope for this action."
  }
}

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?