API Reference · Guest sessions

Create Guest Session

Create a guest credential

POST/v1/guest-sessions

Public (no credentials needed)

Also sets the vi_guest cookie. Usually unnecessary: createApplication creates one when needed.

cURL example

cURL request

curl -X POST "https://api.verifiedinbox.ai/v1/guest-sessions"

Response

201 OKGuest credential (shown once).

application/json

Field	Type	Description
expires_atrequired	string (date-time)	—
guest_tokenrequired	string	`vi_guest_…` — store it; shown once.
noterequired	string	—

Example 201 response (GuestSession)

{
  "expires_at": "2026-10-31T12:00:00Z",
  "guest_token": "string",
  "note": "string"
}

Other responses & possible errors

Expand a status code below to see the error code, description, and example error payload.

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?