Cerrtify
BankID

Poll a BankID order status

Polls the status of a pending order. Forwarded verbatim to BankID's `/collect`. Returns `pending` / `failed` / `complete`; on `complete` the `completionData` object holds the user identity and signature. Poll until the status is terminal.

POST
/service/bankid/collect

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/collect" \  -H "Content-Type: application/json" \  -d '{    "orderRef": "string"  }'
{  "orderRef": "string",  "status": "pending",  "hintCode": "string",  "completionData": {}}
{  "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"}

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

Cancel a BankID order POST

Aborts a pending order. Forwarded verbatim to BankID's `/cancel`.