API Reference · Go live

Get Go Live

BIMI publication, test email, display, monitoring, renewal

GET/v1/applications/{application_id}/go-live

Free (guest token or account)

cURL example

cURL request

curl "https://api.verifiedinbox.ai/v1/applications/0192a5e0-1234-7000-8000-000000000001/go-live" \
  -H "VI-Guest-Token: vi_guest_YOUR_TOKEN"

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 OKStatus.

application/json

Field	Type	Description
bimirequired	object	— Nested fields (8) `assets_match` (boolean) `certificate_reachable` (boolean) `certificate_url` (string) `host` (string) `logo_reachable` (boolean) `logo_url` (string) `record` (string): The BIMI TXT value to publish. `status` (string)
inbox_displayrequired	object	— Nested fields (4) `expects_checkmark` (boolean) `mailbox` (string) `observed_at` (string (date-time)) `status` (string)
monitoringrequired	object	— Nested fields (2) `enabled` (boolean) `last_checked_at` (string (date-time))
renewalrequired	object	— Nested fields (3) `auto_renew` (boolean) `not_after` (string (date-time)) `renewal_starts_on` (string (date))
test_messagerequired	TestMessage \| null	— Nested fields (14) `address` (string): Send a real email from the domain to this address. `bimi_selector` (string) `created_at` (string (date-time)) `dkim` (object[]) `dmarc` (object) `expires_at` (string (date-time)) `findings` (Finding[]) `from` (string) `from_domain` (string) `id` (string (uuid)) `instructions` (string) `received_at` (string (date-time)) `spf` (object) `status` (string)

Example 200 response (GoLive)

{
  "bimi": {
    "assets_match": true,
    "certificate_reachable": true,
    "certificate_url": "https://verifiedinbox.ai/verify/0192a5e0-1234-7000-8000-000000000001/domain",
    "host": "string",
    "logo_reachable": true,
    "logo_url": "https://verifiedinbox.ai/verify/0192a5e0-1234-7000-8000-000000000001/domain",
    "record": "string",
    "status": "not_published"
  },
  "inbox_display": {
    "expects_checkmark": true,
    "mailbox": "string",
    "observed_at": "2026-10-31T12:00:00Z",
    "status": "not_observed"
  },
  "monitoring": {
    "enabled": true,
    "last_checked_at": "2026-10-31T12:00:00Z"
  },
  "renewal": {
    "auto_renew": true,
    "not_after": "2026-10-31T12:00:00Z",
    "renewal_starts_on": "2026-10-31"
  },
  "test_message": {
    "address": "string",
    "bimi_selector": "string",
    "created_at": "2026-10-31T12:00:00Z",
    "dkim": [],
    "dmarc": {
      "aligned_via": [],
      "result": "pass"
    },
    "expires_at": "2026-10-31T12:00:00Z",
    "findings": [],
    "from": "string",
    "from_domain": "acme.com",
    "id": "0192a5e0-1234-7000-8000-000000000001",
    "instructions": "string",
    "received_at": "2026-10-31T12:00:00Z",
    "spf": {
      "aligned": true,
      "domain": "acme.com",
      "result": "pass"
    },
    "status": "waiting"
  }
}

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

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?