API Reference · Logo

Submit Logo

Submit the logo

PUT/v1/applications/{application_id}/logo

Free (guest token or account)MCP:submit_logo

SVG text, an https URL, or the logo discovered on the website. The original is preserved byte-for-byte; the SVG Tiny P/S derivative and a trademark search start in the background.

cURL example

cURL request

curl -X PUT "https://api.verifiedinbox.ai/v1/applications/0192a5e0-1234-7000-8000-000000000001/logo" \
  -H "VI-Guest-Token: vi_guest_YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "filename": "string",
    "svg": "string"
  }'

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.
If-Matchheader	string	The application `version` you last saw, e.g. `"7"`. Stale → 409 `version_conflict` with the current application.

Request body

application/json · required

Example request payload (LogoInput)

{
  "filename": "string",
  "svg": "string"
}

Response

201 OKReceived; processing.

application/json

Field	Type	Description
analysisrequired	LogoAnalysis \| null	— Nested fields (14) `base_profile` (string) `compliant` (boolean): No error-level issues against SVG Tiny P/S. `element_count` (integer) `has_raster` (boolean) `has_text` (boolean) `has_title` (boolean) `height` (number) `issues` (LogoIssue[]) `size_bytes` (integer) `square` (boolean) `title` (string) `version` (string) `view_box` (number[]) `width` (number)
approved_atrequired	string (date-time) \| null	—
changesrequired	LogoChange[]	— Nested fields (4) `code` (string) `lossy` (boolean): True when something visible may have changed. `message` (string): Plain English. `technical` (string)
convertedrequired	object \| null	— Nested fields (3) `sha256` (string) `size` (integer) `url` (string)
created_atrequired	string (date-time)	—
errorrequired	string \| null	—
idrequired	string (uuid)	—
originalrequired	object	— Nested fields (4) `filename` (string) `sha256` (string) `size` (integer) `url` (string)
previewsrequired	object	— Nested fields (2) `converted` (string) `original` (string)
requirementsrequired	LogoRequirement[]	Logo rules and whether the original / inbox-ready file meets each. Nested fields (6) `id` (string) `label` (string) `met_by_converted` (boolean): Null until the inbox-ready file exists. `met_by_original` (boolean) `required` (boolean) `source` (string)
reviewrequired	LogoReviewItem[]	Everything we noticed, what we changed (or why we left it), and which rule asks for it. Nested fields (8) `change` (string): What we changed (null when nothing changed). `code` (string) `lossy` (boolean): True when the change may alter how it looks. `noticed` (string): What we noticed in the original (null for routine rewrites). `outcome` (string) `source` (string) `technical` (string) `why` (string): Plain English.
sourcerequired	string	— Allowed: `upload`, `url`, `discovered`
source_urlrequired	string \| null	—
statusrequired	string	— Allowed: `processing`, `ready_for_review`, `approved`, `failed`
visual_diffrequired	VisualDiff \| null	— Nested fields (2) `score` (number): 0..1 share of the logo area that changed. `verdict` (string)

Example 201 response (Logo)

{
  "analysis": {
    "base_profile": "string",
    "compliant": true,
    "element_count": 1,
    "has_raster": true,
    "has_text": true,
    "has_title": true,
    "height": 1,
    "issues": [],
    "size_bytes": 1,
    "square": true,
    "title": "string",
    "version": "string",
    "view_box": [],
    "width": 1
  },
  "approved_at": "2026-10-31T12:00:00Z",
  "changes": [
    {
      "code": "string",
      "lossy": true,
      "message": "Everything checks out.",
      "technical": "string"
    }
  ],
  "converted": {
    "sha256": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855",
    "size": 1,
    "url": "https://verifiedinbox.ai/verify/0192a5e0-1234-7000-8000-000000000001/domain"
  },
  "created_at": "2026-10-31T12:00:00Z",
  "error": "string",
  "id": "0192a5e0-1234-7000-8000-000000000001",
  "original": {
    "filename": "string",
    "sha256": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855",
    "size": 1,
    "url": "https://verifiedinbox.ai/verify/0192a5e0-1234-7000-8000-000000000001/domain"
  },
  "previews": {
    "converted": "string",
    "original": "string"
  },
  "requirements": [
    {
      "id": "0192a5e0-1234-7000-8000-000000000001",
      "label": "string",
      "met_by_converted": true,
      "met_by_original": true,
      "required": true,
      "source": "gmail"
    }
  ],
  "review": [
    {
      "change": "string",
      "code": "string",
      "lossy": true,
      "noticed": "string",
      "outcome": "changed",
      "source": "gmail",
      "technical": "string",
      "why": "string"
    }
  ],
  "source": "upload",
  "source_url": "https://verifiedinbox.ai/verify/0192a5e0-1234-7000-8000-000000000001/domain",
  "status": "processing",
  "visual_diff": {
    "score": 1,
    "verdict": "identical"
  }
}

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

409 (version_conflict)`conflict` / `version_conflict` (current state in `details.application`) / Idempotency-Key reuse.

`conflict` / `version_conflict` (current state in `details.application`) / Idempotency-Key reuse.

Example 409 error response

{
  "error": {
    "code": "version_conflict",
    "message": "This application was updated elsewhere. Refresh and try again."
  }
}

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?