Skip to main content
GET
Get one visit

Authorizations

X-API-Key
string
header
required

Path Parameters

visit_id
string<uuid>
required

The visit's id.

Response

The visit.

One visit, with who its visitor is and what detection made of it.

visit_id
string<uuid>
required

The visit's id.

environment
enum<string>
required

The application's environment.

Available options:
sandbox,
production
state
enum<string>
required

Whether it goes on.

Available options:
active,
ended
presence
VisitPresence (v1) · object
required

The visitor's presence now.

decision_count
integer
required

Its decisions so far.

Required range: x >= 0
started_at
string<date-time>
required

Its first record.

last_seen_at
string<date-time>
required

Its latest record.

funnel_stage
enum<string>
required

The furthest stage it reached.

Available options:
arrived,
admitted,
browsed,
carted,
checked_out,
converted
identity_stage
enum<string>
required

How far its identity got, from its presence trust: credentialed once any decision verified a credential, verified_agent for a verified signature, declared for a corroborated claim, and anonymous otherwise.

Available options:
anonymous,
declared,
verified_agent,
credentialed
identity
VisitIdentity (v1) · object
required

Who the visitor is.

transport
enum<string> | null

How the visitor arrived: browser when it has only browser events; null when no record says.

Available options:
browser,
api,
mcp,
ucp
outcome
enum<string> | null

How it ended; null while active.

Available options:
converted,
abandoned,
blocked
first_step
enum<string> | null

The step of its first decision; null when it has none.

Available options:
browse,
search,
cart,
checkout,
payment,
account,
signup,
write
last_step
enum<string> | null

The step of its latest decision; null when it has none.

Available options:
browse,
search,
cart,
checkout,
payment,
account,
signup,
write
identity_level
enum<string> | null

The deepest identity any of its decisions had.

Available options:
L1,
L2,
L3
agent
VisitAgent (v1) · object | null

The agent behind it.

credential
VisitVerifiedCredential (v1) · object | null

The latest KYA credential the SDK verified on it; null when none.

ended_at
string<date-time> | null

When it ended; null while active.

recognized_by
enum<string> | null

What the visitor was recognized by; null when nothing recognized it.

Available options:
detection,
user_agent,
web_bot_auth,
credential
risk_score
integer | null

The risk its latest detection update scored, 0 to 100; null before one, or when the update carried no score.

Required range: 0 <= x <= 100
journey
VisitJourney (v1) · object | null

Its page views; null when it viewed no page.

detection_label
VisitDetectionLabel (v1) · object | null

The tool, product, provider or environment its latest detection update attributed it to with the highest confidence; null when none.

detection
VisitDetection (v1) · object | null

What detection made of it; null before a detection update.