API Reference · Eligibility

Get Eligibility

VMC / CMC / not-yet-eligible with evidence

GET/v1/applications/{application_id}/eligibility

Free (guest token or account)MCP:get_eligibility

cURL example

cURL request

curl "https://api.verifiedinbox.ai/v1/applications/0192a5e0-1234-7000-8000-000000000001/eligibility" \
  -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 OKAssessment.

application/json

Field	Type	Description
assessed_atrequired	string (date-time)	—
estimated_eligible_onrequired	string (date) \| null	—
next_stepsrequired	object[]	— Nested fields (3) `description` (string) `kind` (string) `title` (string)
overriderequired	string \| null	Staff override, if any. Allowed: `vmc_eligible`, `cmc_eligible`, `not_currently_eligible`
recommended_productrequired	string \| null	— Allowed: `vmc`, `cmc`
routesrequired	object	— Nested fields (2) `cmc` (EligibilityRoute) `vmc` (EligibilityRoute)
statusrequired	string	— Allowed: `unknown`, `assessing`, `vmc_eligible`, `cmc_eligible`, `not_currently_eligible`

Example 200 response (Eligibility)

{
  "assessed_at": "2026-10-31T12:00:00Z",
  "estimated_eligible_on": "2026-10-31",
  "next_steps": [
    {
      "description": "string",
      "kind": "string",
      "title": "string"
    }
  ],
  "override": "vmc_eligible",
  "recommended_product": "vmc",
  "routes": {
    "cmc": {
      "checkmark": true,
      "eligible": true,
      "requirements": []
    },
    "vmc": {
      "checkmark": true,
      "eligible": true,
      "requirements": []
    }
  },
  "status": "unknown"
}

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?