BankID Provider Client
API Contract
REST
/api/v1/bankid
5 endpoints
GET
/api/v1/bankid/api/v1/bankid/sessions
List BankID provider sessions
Public
Response Example
{
"data": [
{
"session_id": "bids_3e9c1f2a",
"org_id": "org_helseapp",
"status": "completed",
"created_at": "2026-03-26T09:00:00Z"
}
],
"pagination": {
"page": 1,
"limit": 20,
"total": 1
}
}
POST
/api/v1/bankid/api/v1/bankid/sessions
Create a new BankID provider session
Public
Request Example
{
"org_id": "org_helseapp"
}
Response Example
{
"session_id": "bids_3e9c1f2a",
"org_id": "org_helseapp",
"status": "initiated",
"expires_at": "2026-03-26T10:20:00Z",
"created_at": "2026-03-26T10:10:00Z"
}
GET
/api/v1/bankid/api/v1/bankid/sessions/:session_id/redirect-url
Get the BankID authentication redirect URL for a session
Public
Response Example
{
"session_id": "bids_3e9c1f2a",
"redirect_url": "https://bankid.no/auth?session=bids_3e9c1f2a&nonce=qWxYz123&client_id=bid-client-def456"
}
POST
/api/v1/bankid/api/v1/bankid/sessions/:session_id/validate
Validate assertion token against BankID provider
Public
Request Example
{
"assertion_token": "eyJhbGciOiJSUzI1NiJ9.eyJzdWIiOiIxNTA3NjUwMDU2NSJ9..."
}
Response Example
{
"valid": true,
"nin": "15076500565",
"name": "Kari Nordmann",
"assurance_level": "substantial",
"validated_at": "2026-03-26T10:12:45Z"
}
DELETE
/api/v1/bankid/api/v1/bankid/sessions/:session_id
Cancel a BankID provider session
Public
Response Example
{
"session_id": "bids_3e9c1f2a",
"status": "cancelled",
"cancelled_at": "2026-03-26T10:11:00Z"
}