pasbydocs
Concepts

Core concepts

Flows, device modes, actions, claims, and webhooks explained for integrators.

These concepts apply across the public API v2. OIDC integrations share the same ideas for claims, actions, and credentials, but use a three-call OAuth-style sequence—see OIDC.

Concept map

TopicSummary
TerminologyIdentity, consumer, app, scope, payload
FlowsStateful journeys from create → ping → done
Device patternsSame-device, different-device, wildcard
ClaimsConsent-bound user attributes

Standard response envelope

Most API endpoints return:

{
  "status": "successful",
  "reason": "Human-readable summary",
  "cost": 0.5,
  "version": "v2",
  "data": {}
}

Check HTTP status first, then status / reason, then endpoint-specific fields under data.

On this page