BankID Page 1(24) BankID Relying Party Guidelines Version: 2.16 2017-11-14 BankID Relying Party Guidelines Version: 2.16 2017-11-14 BankID Page 2(24) BankID Relying Party Guidelines Version: 2.16 1 Introduction .................................................................................................................................. 4 1.1 Versions ............................................................................................................................................... 4 1.2 Terms and definition .......................................................................................................................... 4 1.3 How it Works...................................................................................................................................... 5 1.4 Client Platforms ................................................................................................................................. 5 2 Use Cases ...................................................................................................................................... 5 2.1 Basic Use cases.................................................................................................................................... 5 2.2 Flow of events ..................................................................................................................................... 6 2.3 Exceptions ........................................................................................................................................... 6 3 Launching ..................................................................................................................................... 6 3.1 Launching the BankID app from a browser ................................................................................... 6 Behaviour in Different Browsers ........................................................................................................................ 7 3.1.1 ............................................................................................................................................................................ 7 3.1.2 Parameters in the start URL ........................................................................................................................ 7 3.2 Launching the BankID app from Native App on Mobile Device ................................................... 8 3.2.1 Android ....................................................................................................................................................... 8 3.2.2 iOS .............................................................................................................................................................. 8 3.2.3 Windows 10 Mobile ................................................................................................................................... 8 4 Technical Requirements ............................................................................................................... 9 5 Recommended User Messages ..................................................................................................... 9 6 Production Environment ............................................................................................................ 12 7 Test Environment ....................................................................................................................... 13 8 Information regarding the Web Service API ............................................................................ 14 8.1 SSL certificates ................................................................................................................................. 14 8.2 appapi and appapi2.......................................................................................................................... 14 8.3 Versions ............................................................................................................................................. 14 8.4 Test Environment ............................................................................................................................. 15 8.5 No soapAction................................................................................................................................... 15 8.6 HTTP/1.1 .......................................................................................................................................... 15 8.7 TLS Versions .................................................................................................................................... 15 9 Support ........................................................................................................................................ 15 10 Recommended Terminology ................................................................................................... 15 11 File Signing ............................................................................................................................. 15 12 Verifying Signatures ............................................................................................................... 16 13 RP Interface Description ........................................................................................................ 17 13.1 Method Auth ................................................................................................................................. 17 13.1.1 In parameters ............................................................................................................................................ 17 13.1.2 Return value .............................................................................................................................................. 17 13.2 Method Sign .................................................................................................................................. 17 13.2.1 In Parameters ............................................................................................................................................ 17 13.2.2 Return value .............................................................................................................................................. 17 BankID Page 3(24) BankID Relying Party Guidelines Version: 2.16 13.3 Method FileSign - Deprecated ..................................................................................................... 17 13.4 PersonalNumberType .................................................................................................................. 17 13.5 EndUserInfoType ......................................................................................................................... 18 13.6 RequirementAlternativesType .................................................................................................... 18 13.6.1 OrderResponseType ................................................................................................................................. 19 13.7 Error codes for Auth/Sign ........................................................................................................... 20 13.8 Method Collect .............................................................................................................................. 20 13.8.1 In Parameters ............................................................................................................................................ 20 13.8.2 Return Value ............................................................................................................................................. 20 13.8.3 ProgressStatusType .................................................................................................................................. 21 13.8.4 UserInfoType ............................................................................................................................................ 21 13.8.5 Error codes Collect ................................................................................................................................... 22 13.9 More information about requirement alternatives ................................................................... 23 13.9.1 Syntax ....................................................................................................................................................... 23 13.9.2 Examples .................................................................................................................................................. 23 BankID Page 4(24) BankID Relying Party Guidelines Version: 2.16 1 Introduction This document contains guidelines for Relying Parties (RP, Förlitande Part in Swedish) when using BankID in their own services. Please check https://www.bankid.com/bankid-i-dina-tjanster/rp-info and verify that you have the latest version of this document. Note: To manage a generation shift of the root certificate protecting the service we have introduced a new end point for the service; appapi2.bankid.com. This new end point is protected using a new root CA. RP must use the new end point. RP must trust the new root CA. The old end point will not work after June 2019. 1.1 Versions Version Date Change 1.x Historical versions < 2.10 Historical versions. Please contact [email protected] if you need this information. 2.10 2016-02-23 Recommended User Messages: The term “BankID app” may be used