Use cases
There are several use cases that can be implemented using the BankID solution. The most common use cases are:
The user wants to authenticate in at the RPs app on the same device that the BankID app is running.
The user wants to authenticate in for example with a web browser running on another device than the BankID app is running on.
Authenticate on the same device
A. The user selects identify with BankID in the RP app.
The RP calls its own backend to indicate the user wants to authenticate.
The RP backend calls the BankID service to create an order.
The BankID service returns an orderRef and autoStartToken.
The RP backend passes the autoStartToken to their client.
The RP client starts the BankID app using the autoStartToken.
B. The BankID app starts on the user’s device. User authenticates in the BankID app.
C. The BankID app closes and the user is returned to the RP client.
D. In the background the RP backend uses the Collect method in the BankID service to check order status.
Once the order is completed the RP backend gets information including the personalNumber used.
The RP cannot see who logged in using personalNumber.
Check that the ipAddress you get back from the /collect match the IP adress you observe to ensure session fixation.
E. User is logged in on the RP app.
Authenticate on another device
A. The user selects identify with BankID on the RP website.
The RP calls its own backend to indicate the user wants to authenticate.
The RP backend calls the BankID service to create an order.
The BankID service returns an orderRef, qrStartToken and qrStartSecret.
The RP uses the qrStartToken and qrStartSecret to create a QR code.
The RP client displays the QR code.
B. The user opens their BankID app, scans the QR code and completes the authentication in the BankID app,
C. In the background, the RP backend uses the Collect method in the BankID service to check the order status,
Once the order is completed the RP backend gets the information including the personalNumber used.
The RP cannot see who logged in using personalNumber.
D. User is logged in on the RP app.
Fallback
There are instances where it can be hard to detect if the RP app is running on the same device as the BankID app or not. Therefore, it is recommended to have a fallback in the interface:
When BankID is used on the same device, implementing the option for users to “Open BankID on another device” and presenting a QR code is recommended.
When the RP application and BankID are on different devices and the QR code is shown, an option to “Open on this device” is recommended.
User messages
During an order, the BankID service will return status updates when you call to the Collect API. It is recommended to display the order status in the RP client so users know the status and are informed of potential errors.
Recommended user messages
Short name | Swedish | English | Event, status, hintCode or errorCode |
---|---|---|---|
RFA1 |
Starta BankID-appen. |
Start your BankID app. |
status=pending |
RFA2 |
Du har inte BankID-appen installerad. Kontakta din bank. |
The BankID app is not installed. Please contact your bank. |
The BankID app is not installed in the mobile device. |
RFA3 |
Åtgärden avbruten. Försök igen |
Action cancelled. Please try again. |
errorCode=cancelled |
RFA4 |
En identifiering eller underskrift för det här personnumret är redan påbörjad. Försök igen. |
An identification or signing for this personal number is already started. Please try again. |
errorCode=alreadyInProgress |
RFA5 |
Internt tekniskt fel. Försök igen. |
Internal error. Please try again. |
errorCode=requestTimeout |
RFA6 |
Åtgärden avbruten. |
Action cancelled. |
status=failed |
RFA8 |
BankID-appen svarar inte. Kontrollera att den är startad och att du har internetanslutning. Om du inte har något giltigt BankID kan du skaffa ett hos din bank. Försök sedan igen. |
The BankID app is not responding. Please check that it’s started and that you have internet access. If you don’t have a valid BankID you can get one from your bank. Try again. |
status=failed |
RFA9 |
Skriv in din säkerhetskod i BankID-appen och välj Identifiera eller Skriv under. |
Enter your security code in the BankID app and select Identify or Sign. |
status=pending |
RFA13 |
Försöker starta BankID-appen. |
Trying to start your BankID app. |
status=pending |
RFA14 (A) |
Söker efter BankID, det kan ta en liten stund … |
Searching for BankID, it may take a little while … |
status=pending The user accesses the service using a personal computer. |
RFA14 (B) |
Söker efter BankID, det kan ta en liten stund … |
Searching for BankID, it may take a little while … |
status=pending The user accesses the service using a mobile device. |
RFA15 (A) |
Söker efter BankID, det kan ta en liten stund … |
Searching for BankID:s, it may take a little while … |
status=pending The user accesses the service using a personal computer. |
RFA15 (B) |
Söker efter BankID, det kan ta en liten stund … |
Searching for BankID, it may take a little while … |
status=pending The user accesses the service using a mobile device. |
RFA16 |
Det BankID du försöker använda är för gammalt eller spärrat. Använd ett annat BankID eller skaffa ett nytt hos din bank. |
The BankID you are trying to use is blocked or too old. Please use another BankID or get a new one from your bank. |
status=failed |
RFA17 (A) |
BankID-appen verkar inte finnas i din dator eller mobil. Installera den och skaffa ett BankID hos din bank. Installera appen från din appbutik eller https://install.bankid.com |
The BankID app couldn’t be found on your computer or mobile device. Please install it and get a BankID from your bank. Install the app from your app store or https://install.bankid.com. |
status=failed RP does not use QR code. |
RPA17 (B) |
Misslyckades att läsa av QR-koden. Starta BankID-appen och läs av QR-koden. Kontrollera att BankID-appen är uppdaterad. Om du inte har BankID-appen måste du installera den och skaffa ett BankID hos din bank. Installera appen från din appbutik eller https://install.bankid.com. |
Failed to scan the QR code. Start the BankID app and scan the QR code. Check that the BankID app is up to date. If you don't have the BankID app, you need to install it and get a BankID from your bank. Install the app from your app store or https://install.bankid.com |
status=failed RP uses QR code |
RFA18 |
Starta BankID-appen. |
Start the BankID app. |
The name of the link or button used to start the BankID app. |
RFA19 |
Vill du identifiera dig eller skriva under med BankID på den här datorn eller med ett Mobilt BankID? |
Would you like to identify yourself or sign with a BankID on this computer, or with a Mobile BankID? |
The user accesses the service using a browser on a personal computer. |
RFA20 |
Vill du identifiera dig eller skriva under med ett BankID på den här enheten eller med ett BankID på en annan enhet? |
Vill du identifiera dig eller skriva under med ett BankID på den här enheten eller med ett BankID på en annan enhet? |
The user accesses the service using a browser on a mobile device. |
RFA21 |
Identifiering eller underskrift pågår. |
Identification or signing in progress. |
status=pending |
RFA22 |
Okänt fel. Försök igen. |
Unknown error. Please try again. |
status=failed An error occured. The errorCode is unknown to RP. |
RFA23 |
Fotografera och läs av din ID-handling med BankID-appen. |
Process your machine-readable travel document using the BankID app. |
status=pending |
RFA1
Starta BankID-appen.
Start your BankID app.
status=pending
hintCode=outstandingTransaction
hintCode=noClient
RFA2
Du har inte BankID-appen installerad. Kontakta din bank.
The BankID app is not installed. Please contact your bank.
The BankID app is not installed in the mobile device.
RFA3
Åtgärden avbruten. Försök igen
Action cancelled. Please try again.
errorCode=cancelled
RFA4
En identifiering eller underskrift för det här personnumret är redan påbörjad. Försök igen.
An identification or signing for this personal number is already started. Please try again.
errorCode=alreadyInProgress
RFA5
Internt tekniskt fel. Försök igen.
Internal error. Please try again.
errorCode=requestTimeout
errorCode=maintenance (repeatedly)
errorCode=internalError
RFA6
Åtgärden avbruten.
Action cancelled.
status=failed
hintCode=userCancel
RFA8
BankID-appen svarar inte. Kontrollera att den är startad och att du har internetanslutning. Om du inte har något giltigt BankID kan du skaffa ett hos din bank. Försök sedan igen.
The BankID app is not responding. Please check that it’s started and that you have internet access. If you don’t have a valid BankID you can get one from your bank. Try again.
status=failed
hintCode=expiredTransaction
RFA9
Skriv in din säkerhetskod i BankID-appen och välj Identifiera eller Skriv under.
Enter your security code in the BankID app and select Identify or Sign.
status=pending
hintCode=userSign
RFA13
Försöker starta BankID-appen.
Trying to start your BankID app.
status=pending
hintCode=outstandingTransaction
RFA14 (A)
Söker efter BankID, det kan ta en liten stund …
Om det har gått några sekunder och inget BankID har hittats har du sannolikt inget BankID som går att använda för den aktuella identifieringen/underskriften i den här datorn. Om du har ett BankID-kort, sätt in det i kortläsaren. Om du inte har något BankID kan du skaffa ett hos din bank. Om du har ett BankID på en annan enhet kan du starta din BankID-app där.
Searching for BankID, it may take a little while …
If a few seconds have passed and still no BankID has been found, you probably don’t have a BankID which can be used for this identification/signing on this computer. If you have a BankID card, please insert it into your card reader. If you don’t have a BankID you can get one from your bank. If you have a BankID on another device you can start the BankID app on that device.
status=pending
hintCode=started
The user accesses the service using a personal computer.
RFA14 (B)
Söker efter BankID, det kan ta en liten stund …
Om det har gått några sekunder och inget BankID har hittats har du sannolikt inget BankID som går att använda för den aktuella identifieringen/underskriften i den här enheten. Om du inte har något BankID kan du skaffa ett hos din bank. Om du har ett BankID på en annan enhet kan du starta din BankID-app där.
Searching for BankID, it may take a little while …
If a few seconds have passed and still no BankID has been found, you probably don’t have a BankID which can be used for this identification/signing on this device. If you don’t have a BankID you can get one from your bank. If you have a BankID on another device you can start the BankID app on that device.
status=pending
hintCode=started
The user accesses the service using a mobile device.
RFA15 (A)
Söker efter BankID, det kan ta en liten stund …
Om det har gått några sekunder och inget BankID har hittats har du sannolikt inget BankID som går att använda för den aktuella identifieringen/underskriften i den här datorn. Om du har ett BankID-kort, sätt in det i kortläsaren. Om du inte har något BankID kan du skaffa ett hos din bank.
Searching for BankID:s, it may take a little while …
If a few seconds have passed and still no BankID has been found, you probably don’t have a BankID which can be used for this identification/signing on this computer. If you have a BankID card, please insert it into your card reader. If you don’t have a BankID you can get one from your bank.
status=pending
hintCode=started
The user accesses the service using a personal computer.
RFA15 (B)
Söker efter BankID, det kan ta en liten stund …
Om det har gått några sekunder och inget BankID har hittats har du sannolikt inget BankID som går att använda för den aktuella identifieringen/underskriften i den här enheten. Om du inte har något BankID kan du skaffa ett hos din bank.
Searching for BankID, it may take a little while …
If a few seconds have passed and still no BankID has been found, you probably don’t have a BankID which can be used for this identification/signing on this device. If you don’t have a BankID you can get one from your bank.
status=pending
hintCode=started
The user accesses the service using a mobile device.
RFA16
Det BankID du försöker använda är för gammalt eller spärrat. Använd ett annat BankID eller skaffa ett nytt hos din bank.
The BankID you are trying to use is blocked or too old. Please use another BankID or get a new one from your bank.
status=failed
hintCode=certificateErr
RFA17 (A)
BankID-appen verkar inte finnas i din dator eller mobil. Installera den och skaffa ett BankID hos din bank. Installera appen från din appbutik eller https://install.bankid.com
The BankID app couldn’t be found on your computer or mobile device. Please install it and get a BankID from your bank. Install the app from your app store or https://install.bankid.com.
status=failed
hintCode=startFailed
RP does not use QR code.
RPA17 (B)
Misslyckades att läsa av QR-koden. Starta BankID-appen och läs av QR-koden. Kontrollera att BankID-appen är uppdaterad. Om du inte har BankID-appen måste du installera den och skaffa ett BankID hos din bank. Installera appen från din appbutik eller https://install.bankid.com.
Failed to scan the QR code. Start the BankID app and scan the QR code. Check that the BankID app is up to date. If you don't have the BankID app, you need to install it and get a BankID from your bank. Install the app from your app store or https://install.bankid.com
status=failed
hintCode=startFailed
RP uses QR code
RFA18
Starta BankID-appen.
Start the BankID app.
The name of the link or button used to start the BankID app.
RFA19
Vill du identifiera dig eller skriva under med BankID på den här datorn eller med ett Mobilt BankID?
Would you like to identify yourself or sign with a BankID on this computer, or with a Mobile BankID?
The user accesses the service using a browser on a personal computer.
RFA20
Vill du identifiera dig eller skriva under med ett BankID på den här enheten eller med ett BankID på en annan enhet?
Vill du identifiera dig eller skriva under med ett BankID på den här enheten eller med ett BankID på en annan enhet?
The user accesses the service using a browser on a mobile device.
RFA21
Identifiering eller underskrift pågår.
Identification or signing in progress.
status=pending
The hintCode is unknown to RP.
RFA22
Okänt fel. Försök igen.
Unknown error. Please try again.
status=failed
The hintCode is unknown to RP.
An error occured. The errorCode is unknown to RP.
RFA23
Fotografera och läs av din ID-handling med BankID-appen.
Process your machine-readable travel document using the BankID app.
status=pending
hintCode=userMrtd
Recommended terminology
Description | Swedish | English |
---|---|---|
Mobile BankID |
Mobilt BankID |
Mobile BankID |
BankID Security Application for mobile devices |
BankID-appen |
The BankID app |
BankID Security Application for PCs |
BankID-appen eller BankID-programmet |
The BankID app |
Security code, password, PIN |
|
|
Sign |
Skriva under |
Sign |
Signature |
Underskrift |
Underskrift |
Identify |
Identifiera |
Identify |
Identification/authentication |
Identifiering |
Identification |
Mobile BankID
Mobilt BankID
Mobile BankID
BankID Security Application for mobile devices
BankID-appen
The BankID app
BankID Security Application for PCs
BankID-appen eller BankID-programmet
The BankID app
Security code, password, PIN
Säkerhetskod (för Mobilt BankID)
Lösenord (för BankID på fil)
PIN (för BankID på kort)
Security code (for Mobile BankID)
Password (for BankID on file)
PIN (for BankID on card)
Sign
Skriva under
Sign
Signature
Underskrift
Underskrift
Identify
Identifiera
Identify
Identification/authentication
Identifiering
Identification