Cerrtify
BankID

Start a BankID authentication order

Starts a BankID authentication order and returns an `orderRef` plus autostart/QR tokens. After this call, either: - poll `GET /service/bankid/qr-code?orderRef=...` to render the rotating QR, and - poll `POST /service/bankid/collect` with the `orderRef` until the order completes. `userVisibleData` is plain text — the server base64-encodes it before forwarding to BankID.

POST
/service/bankid/auth

Authorization

ApiKeyAuth
X-API-Key<token>

API key in the form cert_<prefix>_<secret>.

In: header

Query Parameters

async?boolean

Run the call as a background job and return 202 Accepted with a job_id.

priority?string

Queue priority for async jobs.

Value in

  • "low"
  • "default"
  • "high"

Header Parameters

Idempotency-Key?string

Dedupe key so a retried async enqueue does not create a duplicate job.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/service/bankid/auth" \  -H "Content-Type: application/json" \  -d '{}'
{  "orderRef": "string",  "autoStartToken": "string",  "qrStartToken": "string",  "qrStartSecret": "string"}
{  "job_id": "string",  "status": "queued",  "poll": "/service/jobs/<id>"}
{  "error": "string",  "detail": "string"}
{  "error": "string",  "detail": "string"}
{  "error": "insufficient_credits",  "message": "Organisationen har slut på krediter. Fyll på för att fortsätta."}
{  "error": "string",  "detail": "string"}
{  "error": "string",  "detail": "string"}
{  "error": "upstream_unavailable",  "service": "bankid",  "message": "There is currently a problem with BankID. Please try again shortly."}
{  "error": "string",  "detail": "string"}

Search by name/address (parsed JSON) POST

As `/search/name-address`, but parsed into JSON. Always synchronous. > **Production uses your own SPAR agreement.** Upload the certificate and > Skatteverket's customer numbers in the Cerrtify dashboard; until then > production returns `403 spar_not_configured`. Sandbox uses the > platform's test certificate against Skatteverket's SPAR test > environment; you need none of your own.

Get the current rotating QR payload GET

Returns the current animated-QR payload for an open order started with `/service/bankid/auth`, `/service/bankid/sign` or `/service/bankid/payment`. Call it from your backend about once per second, draw `qrData` as a QR code, and stop when `/collect` returns `complete` or `failed` (or after 5 minutes). Free: only the BankID order is billed. `qrData` has the form `bankid.<qrStartToken>.<seconds>.<hmac>`. Orders started with `?async=true` have no QR session; compute the QR yourself from the start response. Guide: https://docs.cerrtify.com/en/docs/guides/bankid-qr-code