Cancel a BankID order
Aborts a pending order. Forwarded verbatim to BankID's `/cancel`.
Authorization
ApiKeyAuth API key in the form cert_<prefix>_<secret>.
In: header
Query Parameters
Run the call as a background job and return 202 Accepted with a job_id.
Queue priority for async jobs.
Value in
- "low"
- "default"
- "high"
Header Parameters
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/cancel" \ -H "Content-Type: application/json" \ -d '{ "orderRef": "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"}Poll a BankID order status POST
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.
Start a BankID signing order POST
Starts a signing order. The body is forwarded verbatim to BankID's `/sign` (unlike `/auth`, the server does not transform fields), so encode `userVisibleData` as base64 yourself. Returns an `orderRef` plus QR/autostart tokens; show the animated QR with `GET /service/bankid/qr-code?orderRef=…`.