Skip to main content
POST
Start an eID attempt in your own UI

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

endUserIp
required

The IP address of the person authenticating, as your server sees it. Never your server's own address.

Pattern: ^(?:(?:25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9][0-9]|[0-9])\.){3}(?:25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9][0-9]|[0-9])$
method
enum<string>

The eID to authenticate with, such as SE_BANKID. Leave it out when the client allows one method.

Available options:
SE_BANKID
userAgent
string

The user agent of the person's browser. It improves the eID provider's risk check and lets autoStartUrl return to the right browser.

Maximum string length: 1024
returnUrl
string

Where the eID app sends a user on the same device when they are done. Must be registered on the client. Leave it out and the user switches back by hand.

Response

200

id
string
required

The login session.

method
enum<string>
required
Available options:
SE_BANKID
qrCode
string | null
required

Render this as a QR code for a user on another device. It changes every second, so show the qrCode from each poll.

autoStartToken
string | null
required

Opens the eID app on this device if you build the link yourself. Null when the call resumed an attempt that was already running.

autoStartUrl
string | null
required

Open this on the user's device, from a tap, to launch the eID app. Null when the call resumed an attempt that was already running.

expiresAt
string<date-time>
required

When the user must have finished this attempt by.