API Reference · Eligibility

Get Estimate

Itemized yearly price

GET/v1/applications/{application_id}/estimate

Free (guest token or account)MCP:get_estimate

Plan + pass-through issuer fee (estimated). Full refund if issuance is rejected.

cURL example

cURL request

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

Parameters

Parameter	Type	Description
application_idpathrequired	string (uuid)	Application id.
productquery	string	Default: the chosen/recommended product.
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 OKEstimate.

application/json

Field	Type	Description
currencyrequired	string	—
eligiblerequired	boolean	Whether this application currently qualifies for the product.
intervalrequired	string	—
issuer_fee_range_centsrequired	object	— Nested fields (2) `max` (integer) `min` (integer)
line_itemsrequired	object[]	— Nested fields (4) `amount_cents` (integer) `estimated` (boolean) `kind` (string) `label` (string)
productrequired	string	— Allowed: `vmc`, `cmc`
refund_policyrequired	string	—
renewalrequired	string	—
total_centsrequired	integer	—

Example 200 response (Estimate)

{
  "currency": "usd",
  "eligible": true,
  "interval": "string",
  "issuer_fee_range_cents": {
    "max": 1,
    "min": 1
  },
  "line_items": [
    {
      "amount_cents": 149900,
      "estimated": true,
      "kind": "plan",
      "label": "string"
    }
  ],
  "product": "vmc",
  "refund_policy": "string",
  "renewal": "string",
  "total_cents": 149900
}

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?