Cerrtify
BankID

Start a phone (RP-initiated) authentication

Initiates a phone-channel authentication. Forwarded verbatim to BankID's `/phone/auth`. No QR/autostart; poll `/collect` with the returned `orderRef`.

POST
/service/bankid/phone/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.

Forwarded verbatim to BankID /phone/*. See BankID's API for all fields.

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/phone/auth" \  -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"}

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=…`.

Start a phone (RP-initiated) signing order POST

Initiates a phone-channel signing order. Forwarded verbatim to BankID's `/phone/sign`. Poll `/collect` with the returned `orderRef`.