Autentisering API

Starta och hantera autentiseringssessioner med BankID, Freja eID och andra leverantörer.

Starta autentisering

Skapar en ny autentiseringssession med vald identitetsleverantör.

POST /api/v1/auth/{provider}/start

Path Parameters

Parameter Typ Beskrivning
provider Required string Identitetsleverantör: bankid, freja

Request Body

Parameter Typ Beskrivning
endUserIp Required string Slutanvändarens IP-adress (krävs av BankID)
personalNumber Optional string Personnummer (12 siffror) för att begränsa till specifik person
callbackUrl Optional string URL för redirect efter slutförd autentisering
state Optional string Valfri state-parameter för CSRF-skydd
enrichment Optional object Berikningsinställningar (se Berikning API)

Request Headers

Header Värde
X-Api-Key YOUR_API_KEY
Content-Type application/json
curl -X POST https://id.tic.io/api/v1/auth/bankid/start \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "endUserIp": "192.168.1.1"
  }'

Response

200 OK
{
  "sessionId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "status": "pending",
  "provider": "bankid",
  "qrCodeData": "bankid.67df3090...",
  "autoStartToken": "7c40b5c9-a3de-4e...",
  "expiresAt": "2024-01-15T14:35:00Z"
}

Hämta status

Pollar status för en pågående autentiseringssession.

GET /api/v1/auth/{sessionId}/collect

Path Parameters

Parameter Typ Beskrivning
sessionId Required guid Sessions-ID från start-anropet

Response - Pågående

200 OK
{
  "sessionId": "a1b2c3d4-...",
  "status": "pending",
  "hintCode": "userSign",
  "qrCodeData": "bankid.67df3090..."
}

Response - Slutförd

200 OK
{
  "sessionId": "a1b2c3d4-...",
  "status": "complete",
  "personalNumber": "199001011234",
  "givenName": "Test",
  "surname": "Testsson",
  "completedAt": "2024-01-15T14:33:45Z"
}

Statusvärden

Sessionen kan ha följande statusvärden:

Status Beskrivning Åtgärd
pending Väntar på användarens åtgärd Fortsätt polla var 2:a sekund
complete Autentisering lyckades Hämta användardata från svaret
failed Autentisering misslyckades Visa felmeddelande, erbjud nytt försök
expired Sessionen har gått ut Starta en ny session

Hint-koder

Under pending-status kan hintCode ge mer information:

Hint Code Beskrivning Visa för användaren
outstandingTransaction Väntar på att användaren ska starta BankID "Starta BankID-appen"
userSign Användaren identifierar sig i appen "Skriv in din säkerhetskod i BankID"
noClient BankID-appen hittades inte "Kunde inte starta BankID"