Skip to main content
POST
Cancel an eID attempt

Authorizations

Authorization
string
header
required

API key, e.g. Authorization: Bearer sajn_svc_.... Not scope-limited: acts with its owner's workspace role.

Headers

Sajn-Version
enum<string>

API version for this request. Without it, the request uses the organization's default version; an organization without a default is pinned to the latest version by its first request.

Available options:
2026-09,
2026-10
Sajn-Workspace
string

ID of the workspace this request acts in, from GET /api/v1/workspaces. Without it, an API key acts in its default workspace. The token's user must be a member of the workspace; an OAuth token only accepts the workspace it was granted for. A workspace that doesn't exist or can't be reached returns 403 WORKSPACE_ACCESS_DENIED.

Idempotency-Key
string

Makes retries safe. A retry with the same key and the same request replays the stored response for 24 hours (header Idempotent-Replayed: true); the same key with a different request returns 400.

Maximum string length: 255

Path Parameters

id
string
required

The login session ID, from POST /api/v1/login/sessions.

Body

application/json

Body

The body is of type object.

Response

200

id
string
required

The login session.

status
enum<string>
required

The state of the current attempt.

Available options:
PENDING,
COMPLETED,
FAILED,
EXPIRED
hintCode
string | null
required

What the eID provider reports, such as outstandingTransaction, userSign or userCancel. Use it to tell the user what to do.

qrCode
string | null
required

The current QR code while status is PENDING; null otherwise.

attemptsRemaining
integer
required

How many more attempts this session can start.

Required range: -9007199254740991 <= x <= 9007199254740991