Introduction
This guide is for helping Relying Parties (RP, Förlitande Part in Swedish) when using BankID in their own services.
Version history
| Version (date) |
|---|
| 3.7 (2021-12-15) |
userVisibleData, userNonVisibleData, userVisibleDataFormat introduced for auth. |
| 3.6 (2021-10-22) |
Static QR deprecated. |
| 3.5 (2020-10-26) |
Possible to apply simple formatting of the text presented with the user by using parameter userVisibleDataFormat in method sign. |
| 3.4 (2020-06-08) |
|
| 3.2.3 (2020-05-07) |
Launch Android: preferred url, do not set package. |
| 3.2.2 (2019-04-04) |
Clarification about Apple’s review process and minor editorial changes. |
| 3.2.1 (2018-09-04) |
Minor editorial change. |
| 3.2 (2018-09-03) |
|
| 3.1 (2018-06-13) |
|
| 3.0 (2018-02-16) |
|
| 2.x Historical versions |
Please contact us via email to teknikinfo@bankid.com if you need this information. |
Version (date)
userVisibleData, userNonVisibleData, userVisibleDataFormat introduced for auth.
Static QR deprecated.
Editorial.
Possible to apply simple formatting of the text presented with the user by using parameter userVisibleDataFormat in method sign.
- Support for animated QR.
- Removed historical paragraphs related to change of root CA.
- Editorial changes.
Launch Android: preferred url, do not set package.
Clarification about Apple’s review process and minor editorial changes.
Minor editorial change.
- Support for QR codes.
- A clarification related to the default behaviour for the autoStartTokenRequired requirement.
- New IP addresses for the production environment.
- A unique recommended user message for the alreadyInProgress error added.
- Changed the recommended user messages:
- "Login" replaced with "identification".
- Editorial and minor improvements.
- Version 5 of the service introduced.
- JSON replaces XML/SOAP.
- Cancel method introduced.
- Recommendation to start the iOS app using universal links.
- New IP addresses for the test environment.
- Description of how breaking changes are managed in the API.
- Editorial and minor improvements.
Please contact us via email to teknikinfo@bankid.com if you need this information.
| Terms | Definition |
|---|---|
BankID Security Application and BankID app |
The client software that needs to be installed in the end user’s mobile device or personal computer (PC). The same term is used for PCs and mobile platforms. BankID app is the short form used in this guide. In Swedish the client software installed on PCs is called “BankID säkerhetsprogram”, ”BankID-programmet” or ”BankID-appen”. In Swedish the client software installed on mobile platforms is called “BankID säkerhetsapp” or “BankID-appen”. |
RP |
Relying Party that uses the BankID web service to provide authentication and signing functionality to the end user. |
Terms
BankID Security Application and BankID app
Definition
The client software that needs to be installed in the end user’s mobile device or personal computer (PC). The same term is used for PCs and mobile platforms. BankID app is the short form used in this guide. In Swedish the client software installed on PCs is called “BankID säkerhetsprogram”, ”BankID-programmet” or ”BankID-appen”. In Swedish the client software installed on mobile platforms is called “BankID säkerhetsapp” or “BankID-appen”.
Terms
RP
Definition
Relying Party that uses the BankID web service to provide authentication and signing functionality to the end user.
How it works
To be able to use BankID’s identification and signature features users must install the BankID app in a mobile device or PC. They also need to order a BankID from their bank. An RP uses the BankID identification or signature services via a web service API described in this document. The web service API can only be accessed by a RP that has a valid SSL client certificate. The RP certificate is obtained from the bank that the RP has purchased the BankID service from.
If the BankID app is installed on the same device as the RP service executes in, the BankID app can be launched automatically by the RP service. In this case, the users do not need to enter their personal number in the RP service. If, on the other hand, the RP service is used in a web browser on a PC and the users want to use a Mobile BankID the users will have to manually launch the BankID app on their mobile device. In this case, the users need to provide their personal number in the RP service or the RP needs to use a QR code which the user scans in the BankID app.
Client platforms
BankID is available for Windows, macOS, Android and iOS platforms. Smartcards are supported for Windows and macOS only. Detailed information on platform support can be found at support.bankid.com.