## 🇾đŸ‡Ș Sweden ### BankID BankID is a trusted electronic identification system in Sweden, built on a Public Key Infrastructure (PKI). It provides secure authentication and non-repudiation for online transactions. The system employs two-factor authentication (2FA), combining a personal certificate tied to an individual's social security number with a PIN or password. End-to-end encryption ensures data security. As of September 2021, it was a fundamental part of Sweden's digital infrastructure with over 8 million active users, regulated by the Swedish Financial Supervisory Authority. ### Secure start mandatory > [!NOTE] In order to protect both users and e-services, the secure start of BankID becomes mandatory for all authorities, companies and organizations that use BankID in their e-services. To meet the requirements for secure start you need to implement the changes listed below. By updating to the latest version of ZignSec implementation you will meet all requirements. 1. Use autostart for BankID on the same device 2. Use animated QR code for BankID on another device 3. Remove start with personal identity numbers ## Ways of integration BankID ZignSec provides two ways for implementing Swedish BankID: - **Browser Flow** - The workflow is executed within a ZignSec-controlled browser session. - **API Flow** - A backend without a user interface, suitable for server, mobile, desktop app, or custom scenarios. This flow also includes the Phone Flow - An authentication process when the user is engaged in a telephone conversation. ### Use cases Swedish BankID can be implemented in different ways, depending on the device initiating the flow. The use cases are: - The user aims to authenticate using an app on the **same device** where the BankID app is installed. - The user aims to authenticate using a web browser running on **other device** than the one the BankID app is installed on. For this use case, QR code is the recommended way to trigger an authenitcation. There are three main flows: - [Mobile device](https://www.figma.com/proto/YES4GCyEZsTmygIAl6but5/Mobile?node-id=1%3A164&viewport=1851%2C894%2C0.43621134757995605&scaling=scale-down) - **same device** flow where the app is installed and triggered from the mobile. - [Desktop to mobile device](https://www.figma.com/proto/0PTgHzE4MNujgK8JQiVgzD/Desktop-Mobile?node-id=1%3A998&viewport=676%2C405%2C0.1647709310054779&scaling=scale-down) - **other device** flow where the app is triggered on the desktop to the mobile by QR-code. - [Desktop same device](https://www.figma.com/proto/vbwZ2vAZWoP4KKmoL6flm3/Desktop?node-id=1%3A998&viewport=832%2C405%2C0.15971411764621735&scaling=scale-down) - **same device** flow when the app is installed on the desktop and triggered there. This flow is the least common since most user has the BankID installed on their mobile. > [!NOTE] More than 80% of BankID users are only using the BankID mobile app. ### Autentication or Sign Authenitcation is aimed for identification and sign to be used for digital signatures. But both methods except the same parameters this is a change from previous versions when there was limitations to adding text in the BankID app. ## **Browser Flow** _Execution Sequence_ The initial call triggers the end user's operation - either authenticate or sign. This call instantly activates the authenticate or sign process, and the BankID app is immediately notified to display either authenticate or sign. To avoid continuous polling, consider configuring a webhook for “completed/error”. 1. Request Creation: Set up the POST-request for the product. Use the redirect_url returned in the response to start the browser workflow, identified by sessionid. 2. Running the Login Process: Simply navigate to the redirect_url in a web browser. The workflow may involve specific user interactions and an external device, such as the Swedish mobile BankID, may be necessary. 3. Retrieving Status/Results: Collect status and individual data using the unique workflow sessionid code. Make this call during or after the workflow is completed. The workflow can indicate pending, completed, or error status (exception, user abort, timeout) via a browser redirect to the redirect_success URL and/or through a webhook. Find below the sequence diagram for Browser flow on the same device. ![[BrowserOnSame.jpg]] And here is the sequence diagram for Browser flow on other device. ![[BrowserOnOtherDevice.png.jpg]] #### Swagger for Browser flow - Test BankId SE - Browser Flow: [Swagger UI (zignsec.com)](https://test-gateway.zignsec.com/#/BankId%20SE%20-%20Browser%20Flow) - Production BankId SE - Browser Flow: [Swagger UI (zignsec.com)](https://gateway.zignsec.com/#/BankId%20SE%20-%20Browser%20Flow) #### API Endpoint - Base URL for Test: https://test-gateway.zignsec.com/core/api/sessions/ - Base URL for Production: [https://gateway.zignsec.com/core/api/sessions/](https://gateway.zignsec.com/core/api/sessions/) **Important Note:** For customers using Two-Way SSL certificates, they need to call different endpoints base URL like mentioned below Only available in Production: [https://api-prod.zignsec.com](https://api-prod.zignsec.com "https://api-prod.zignsec.com/") ##### **Authenticate** Used for electronic identifying a person **POST** - BankID SE Auth - Browser Flow Same Device **Endpoint:** /bankidse/browser/same-device/auth **GET** - Get Session Data (BankID SE Auth - Browser Flow Same Device) **Endpoint:** /bankidse/browser/same-device/auth/id **POST** - BankID SE Auth - Browser Flow Other Device **Endpoint:** /bankidse/browser/auth **GET** - Get Session Data (BankID SE Auth - Browser Flow Other Device) **Endpoint:** /bankidse/browser/auth/id ##### **Sign** Used for electronic signatures **POST** - BankID SE Sign - Browser Flow Same Device **Endpoint:** /bankidse/browser/same-device/sign **GET** - Get Session Data (BankID SE Sign - Browser Flow Same Device) **Endpoint:** /bankidse/browser/same-device/sign/id **POST** - BankID SE Sign - Browser Flow Other Device **Endpoint:** /bankidse/browser/sign **GET** - Get Session Data (BankID SE Sign - Browser Flow Other Device) **Endpoint:** /browser/sign/id ### Sample of BankID SE Auth - Browser Flow Other Device ```bash curl -X 'POST' \ 'https://test-gateway.zignsec.com/core/api/sessions/bankidse/browser/auth' \ -H 'accept: application/json' \ -H 'authorization: Your-Subscription-Key' \ -H 'Content-Type: application/json' \ -d '{ "locale": "En", "metadata": { "language": "en", "requirement": { "certificate_policies": [ "1.2.752.78.1.5", "1.2.752.60.1.6" ], "mrtd": false, "personal_number": "194911201111", "pin_code": false } }, "redirect_failure": "https://my_failure_url.com", "redirect_success": "https://my_success_url.com", "relay_state": "my-unique-customer-id", "webhook": "https://my_webhook_url.com" }' ``` ### Request Parameters |Parameter|Type|Description|Required| |---|---|---|---| |locale|string|Preferred Language to Use. Example: En|no| |**metadata**|list|Sign request|yes| |language|string|Decides web form user interface language. The default language is taken from the merchants setting ‘DefaultLanguage’ or EN = English if none is set there. Language can be changed both on a request level here, or on setting level.|no| |requirement|list|RP may use the requirement parameter to describe how a signature must be created and verified. A typical use case is to require Mobile BankID or a certain card reader.|no| |card_reader|Enum: [ Class1, Class2 ]|Class1 - Default. The transaction must be performed using a card reader where the PIN code is entered on the computers keyboard, or a card reader of higher class., Class2 - The transaction must be performed using a card reader where the PIN code is entered on the reader, or a reader of higher class|no| |certificate_policies|string|The oid in certificate policies in the user certificate. List of String. One wildcard "" is allowed from position 5 and forward ie. 1.2.752.78. <br>The values for production BankIDs are: <br>"1.2.752.78.1.1" - BankID on file <br>"1.2.752.78.1.2" - BankID on smart card <br>"1.2.752.78.1.5" - Mobile BankID <br>"1.2.752.71.1.3" - Nordea e-id on file and on smart card. <br>The values for test BankIDs are: <br>"1.2.3.4.5" - BankID on file <br>"1.2.3.4.10" - BankID on smart card <br>"1.2.3.4.25" - Mobile BankID <br>"1.2.752.71.1.3" - Nordea e-id on file and on smart card. <br>"1.2.752.60.1.6" - Test BankID for some BankID Banks <br>If no certificate policies is set the following are default in the production system: <br>1.2.752.78.1.1, 1.2.752.78.1.2, 1.2.752.78.1.5, 1.2.752.71.1.3 <br>The following are default in the test system: <br>1.2.3.4.5, 1.2.3.4.10, 1.2.3.4.25, 1.2.752.60.1.6, 1.2.752.71.1.3 <br>If one certificate policy is set all the default policies are dismissed.|no| |mrtd|boolean|If present, and set to true, the client needs to provide MRTD (Machine readable travel document) information.|no| |personal_number|string|A personal number to be used to complete the transaction. If a BankID with another personal number attempts to sign the transaction, it fails.|no| |pin_code|boolean|Users are required to sign the transaction with their PIN code, even if they have biometrics activated.|no| |theme|Enum Default, Light, Dark|Default - Default theme, Light - Light theme, Dark - Dark theme|no| |user_non_visible_data|string|Data not displayed to the user. base-64 string. 1-200,000 characters after base 64-encoding|no| |user_non_visible_text|string|The text to be displayed and signed. string. 1--40,000 characters after base 64 encoding|no| |user_visible_data|string|The text to be displayed and signed. base-64 string. The text can be formatted using CR, LF and CRLF for new lines. The text must be encoded as UTF-8 and then base 64 encoded. 1--40 000 characters after base 64 encoding|no| |user_visible_data_format|string|If present, and set to simpleMarkdownV1, this parameter indicates that userVisibleData holds formatting characters which, will potentially make the text displayed to the user nicer to look at. For further information of formatting options, please see the [guidelines for formatting text.](https://www.bankid.com/en/utvecklare/guider/formatera-text)|no| |user_visible_text|string|The text to be displayed and signed. string. Converted to UserVisibleData. If both UserVisibleData and UserVisibleText sent, the UserVisibleData will be used. 1--40 000 characters after base 64 encoding|no| |redirect_failure|string|URL to redirect the end-user to on failure. Example: https://my_failure_url.com|no| |redirect_success|string|URL to redirect the end-user to on success. Example: https://my_success_url.com|no| |relay_state|string|Optional Custom Parameter to be included in webhook calls. Example: my-unique-customer-id|no| |webhook|string|Webhook URL where your backend will receive session events. Example: https://my_webhook_url.com|no| #### Sample Response ```json { "data": { "errors": [], "id": "8bd5f1bf-3239-4f17-8ed6-fc620b05884c", "redirect_url": "https://test-gateway.zignsec.com/ui/bankidse/8bd5f1bf-3239-4f17-8ed6-fc620b05884c/?otp=Z_6-zcEsoUane_-Wjcf-DQ&language=en&theme=Light", "status": "GeneratedLink" } } ``` #### Response parameters | Parameter | Description | | ------------ | ---------------------------------------------------------------------------------------- | | id | A unique session identifier generated for each workflow instance | | errors | A JSON array of error conditions | | redirect_url | The URL that the user needs to be redirected to complete the data via the web interface. | #### Sample Response after completing workflow ```json { "errors": [], "id": "ca1d0bcd-94e3-483d-a4dc-f207eb248a29", "result": { "bankIDSE": { "ocspResponse": "MIIHdgoBAKCCB28wggdrBgkrBgEFBQcwAQEEggdcMIIHWDCCASyhgYgwgYUxCzAJBgNVBAYTAlNFMR0wGwYDVQQKDBRUZXN0YmFuayBBIEFCIChwdWJsKTEVMBMGA1UEBRMMMTExMTExMTExMTExMUAwPgYDVQQDDDdUZXN0YmFuayBBIEN1c3RvbWVyIENBMSB2MSBmb3IgQmFua0lEIFRlc3QgT0NTUCBTaWduaW5nGA8yMDIzMTAyNDA3MzkzN1owWDBWMEEwCQYFKw4DAhoFAAQUE/uuq2h5GvMJynJC0kp8aFk812kEFGB6fadZg4yfpLEX6g1DQ5VD5pn9AghD30sQicWMMYAAGA8yMDIzMTAyNDA3MzkzN1qhNDAyMDAGCSsGAQUFBzABAgEB/wQgRzwRx1cIY2BPWzQZ/kiv+DXGfot0XsVSIF3J0J3oYPkwDQYJKoZIhvcNAQELBQADggEBAHtdd7wqtA3w23PHRd6eQptfc33wfGMLAkN2iWypgh3RA5o+q10JstOWZmmOvxP6DQTTE8qfcPFtO/rwHiwsLmOMgIlhgJNQ2OwyuwkJwTBRf3zq89KQt0CkX0DOevIH3ry8wW0bkRqK6wXr3/9mJqmlr4Iuava2d7Ytb3gP8/VD+cb6ikfsDLx6PSlB1LaJw1LJ4divARisXJjC8OP4JY1d18dK8BljyAr/0uxyzH6lK+/nimKBPajnOIuoSzOVl1eTvm6wktcEFSXwjeKZ8BR4dG4BCQjZlEQjsu1lg6PcrBSPxkqrAxHW6U5J0F36eCH0L7zJA40iZwoY8VTpXzqgggUQMIIFDDCCBQgwggLwoAMCAQICCH2kKVKexVcGMA0GCSqGSIb3DQEBCwUAMHgxCzAJBgNVBAYTAlNFMR0wGwYDVQQKDBRUZXN0YmFuayBBIEFCIChwdWJsKTEVMBMGA1UEBRMMMTExMTExMTExMTExMTMwMQYDVQQDDCpUZXN0YmFuayBBIEN1c3RvbWVyIENBMSB2MSBmb3IgQmFua0lEIFRlc3QwHhcNMjMwODE3MDkyMDQ3WhcNMjQwMjEzMDkyMDQ2WjCBhTELMAkGA1UEBhMCU0UxHTAbBgNVBAoMFFRlc3RiYW5rIEEgQUIgKHB1YmwpMRUwEwYDVQQFEwwxMTExMTExMTExMTExQDA+BgNVBAMMN1Rlc3RiYW5rIEEgQ3VzdG9tZXIgQ0ExIHYxIGZvciBCYW5rSUQgVGVzdCBPQ1NQIFNpZ25pbmcwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQD1Pg3ipAsB7G0gSz+y99UjEIbhR3OPLlV9qFxc/jbrcu8wgSEWDU2dQB038ENmBsoIWwDnz3az2CSRx+y0ztMt76GzswUhLY2ZXPfOC3mltYCzpBv/eiNDGgxXb3khg5mRdgJp6XoM+ASrEcqxUTa0sr560KtnnpLOkrAfHhrPOo2Ti7RB32ZxKctDIXLrEu5fohZ72AoOPSprJ9iqwasJjglSMCP/JQmPlA/KwUUyPEwQjzQpZnhdoEp2c7UtWQpreYqcvoH0YLpy9OZOGT/m6dYPaU39xJBeblyiczaAZehAo1fsVJhRoOC/5xxEqRblySyxjiCuL5+UFA0G/tYNAgMBAAGjgYcwgYQwDAYDVR0TAQH/BAIwADAfBgNVHSMEGDAWgBRgen2nWYOMn6SxF+oNQ0OVQ+aZ/TAPBgkrBgEFBQcwAQUEAgUAMBMGA1UdJQQMMAoGCCsGAQUFBwMJMB0GA1UdDgQWBBRr06JenjKsoBkXrvyl42eNA40Q7jAOBgNVHQ8BAf8EBAMCBsAwDQYJKoZIhvcNAQELBQADggIBAHg+860ynoK2q2wpei4XZw/yjw7B7Ju7g6mCIn8N0SdydhIegCQF22lVoYmYKVH3PYcKn4UByhy78JdF9ppNVkFl3X0ZZEpiLq0AcwZqIsOhhDljape6W7YwrvD9fI0PDJAV7wPvGlXKubYlXWivp7M3rnMofljCZHioh40qaPq6/D7oR8F3kMneyKKJ8Qbzu4aXbnHx6FzdKHyYbjM8Wumh0qJYwMfKbkXFa//4QK1YXwc1W2yNbFFyNeCHTOq0fc9/MrEfavxJ/b0oF1e1LLTYVeu/3jTkOZWvC0IbXScC50l6GpMoMs9Xahre5RfthbaOaO/orlMaT/cBrUkgq+a97f2iRPwSHfeXy0OI/ls0a097z1osim4zLE37+UxRAfzUlwQ16nrkkSjuC0gGSo8OYTcunlPWc9puxP4Z4CxSAvW+kOBjlFICx82G+BzK/8/L3VvK8Koi3CjYFXKT8LQuxj/jWlFWKl/rUhkiSn2KJJcM8rCgYWevteFnJGWLTsTSml8vmyOtp+wiWb9F0fN8wu8Q8AlttO+f2lSwxcZD/VFFUW6zvo3zdWFNvCpMKOqP3CTD2Ts+8O7H0A3K8bVH1cCbI0ELIzO6PfyIEeKuQDm6CEBrc8QSZrvL45tAcApm5/JpDjEpQSFcqFCScyFXw/FYzZLp1JQ4N/A+RoS4", "orderRef": "458727f9-82f6-45ba-be86-5ca692ff851f", "signature": "<?xml version="1.0" encoding="UTF-8" standalone="no"?><Signature xmlns="http://www.w3.org/2000/09/xmldsig#"><SignedInfo xmlns="http://www.w3.org/2000/09/xmldsig#"><CanonicalizationMethod Algorithm="http://www.w3.org/TR/2001/REC-xml-c14n-20010315"></CanonicalizationMethod><SignatureMethod Algorithm="http://www.w3.org/2001/04/xmldsig-more#rsa-sha256"></SignatureMethod><Reference Type="http://www.bankid.com/signature/v1.0.0/types" URI="#bidSignedData"><Transforms><Transform Algorithm="http://www.w3.org/TR/2001/REC-xml-c14n-20010315"></Transform></Transforms><DigestMethod Algorithm="http://www.w3.org/2001/04/xmlenc#sha256"></DigestMethod><DigestValue>ql/a1tFl23XggGJvu9bSNo0LBG6+K+9Kk2dzLKOLovc=</DigestValue></Reference><Reference URI="#bidKeyInfo"><Transforms><Transform Algorithm="http://www.w3.org/TR/2001/REC-xml-c14n-20010315"></Transform></Transforms><DigestMethod Algorithm="http://www.w3.org/2001/04/xmlenc#sha256"></DigestMethod><DigestValue>7zpBgrQ7cMiilT9FhFFZ97jSbiuda6XmvJUUmRbvuuc=</DigestValue></Reference></SignedInfo><SignatureValue>ESyfpNFVOf9AYWwZNY9oe2xV/PTVVTjm1a7Xckg6QVn1+8ElFkvKob1Nzt4ByhSF/P+u4Z5L3GPzGpeJr86p2r0qEwUplDijV6kbjhC/yzzO8hVyy+9e0BK4HZsrpK9prtsvAuYqpSFC0ArD6QQhawzAueKDO9dSpf41crVSmOoOMbKU8tTUKGvplfxjTQAZhKBCLqo6xMHD4eUnA/P4kE/6G9OEfsldbONY6RAEhmGevT+J5tRAMiRnGFpKqwpFtWjtL9PuIUw4cZqAxY/6HOUYSlHOGM3jgDQWQ1thx+mWDKuTX73vdXJ1QP+9lnZ3lN0J17moVt5naFcSur4fww==</SignatureValue><KeyInfo xmlns="http://www.w3.org/2000/09/xmldsig#" Id="bidKeyInfo"><X509Data><X509Certificate>MIIFbDCCA1SgAwIBAgIIQ99LEInFjDEwDQYJKoZIhvcNAQELBQAweDELMAkGA1UEBhMCU0UxHTAbBgNVBAoMFFRlc3RiYW5rIEEgQUIgKHB1YmwpMRUwEwYDVQQFEwwxMTExMTExMTExMTExMzAxBgNVBAMMKlRlc3RiYW5rIEEgQ3VzdG9tZXIgQ0ExIHYxIGZvciBCYW5rSUQgVGVzdDAeFw0yMzEwMjMyMjAwMDBaFw0yNDEwMjMyMTU5NTlaMIHNMQswCQYDVQQGEwJTRTEdMBsGA1UECgwUVGVzdGJhbmsgQSBBQiAocHVibCkxETAPBgNVBAQMCEVyaWtzc29uMRUwEwYDVQQqDAxFcmlrIExlbm5hcnQxFTATBgNVBAUTDDE5NDkxMTIwMTExMTE+MDwGA1UEKQw1KDIzMTAyNCAwOS4xNSkgRXJpayBMZW5uYXJ0IEVyaWtzc29uIC0gQmFua0lEIHDDpSBmaWwxHjAcBgNVBAMMFUVyaWsgTGVubmFydCBFcmlrc3NvbjCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAMReSpLn7t1iFN2pSyC2bFrga9OLVINPpaCAuF6CLJgzO2vP/glF6feM7lgPjvwtMDIVjv0ckxbTjrxxblvhtPaewn/yFG5Lpfy/u1oA/CeqxH4RLHUZv+Y/gApH3ZmnSvLaCqaPNZlfzD/gykOCdLFFZoFO+mPYDJ/jYzS2eZKVJwm8EGNRMBgYCg7iRCwGCLqZrrAIv0VFRUbobkP1cQiPdoN+O1wbqZ2UivaY9zw1kdE1uUjMzEtHkGkaznAbLJh0zoD61a0hMrmeRkHNC66u/EF0gfXd8KLh8Cz/BZL8PMEIQCT3EGqOrKHyzN1i3bpr2wcZhUeTKS3XiQuYNK0CAwEAAaOBozCBoDA7BggrBgEFBQcBAQQvMC0wKwYIKwYBBQUHMAGGH2h0dHA6Ly90ZXN0LnJldm9jYXRpb25zdGF0dXMuc2UwEQYDVR0gBAowCDAGBgQqAwQFMA4GA1UdDwEB/wQEAwIHgDAfBgNVHSMEGDAWgBRgen2nWYOMn6SxF+oNQ0OVQ+aZ/TAdBgNVHQ4EFgQULWM19mtNizZQM6CZ5sEertkhIzgwDQYJKoZIhvcNAQELBQADggIBACb9ets2tijqBHP98/IQV+tVqaz3qqKMv8WyqrjSqbxAubv1cEbHbV0luRK9pHzTRZoitxX0n9Qxgl2fJEzV5Il8ywrjVWcINgzhrUgfslw+vgxQpRzoIPUiV/QNb9q2gWGZK9dc4Dvvty9spLdT4feoQlGOtw/WN07SfJhiJcKCbxIv2RfhDehrdrYGyEAFpunD+gfirlLk6xYODD3dlwitBN3fw8tZ31vO6ENk+QpWRhcQwDFnTaNpo+LTFW/+KEsGzd4LCjUn6Ws/uC0mMe/UrzdkNumWPofdOWKsYwX8v64BZX4PwAgBlX1VedfkuG3JHEomcv9dY2nMSKFaj7KKB0Uq10QBy0bLBHLiGpxRICya1Wtzocpg8DQ+NccyvUk0UN3gz9gnn1fBzglkuz51S1+QaJhdfcvpodVKW2G9z+9Pid0yRlyqZO1C4Zl7Fsc0/HhaYPUZ0IgJrFrGUkYHppzRx2ooz1kv/tDABMVUTS5z8DSTW3GsT4lqUpL7oVJClj71P92Kmk1UxThvRScY5UEeTYe71ezpPE2BTeGoF43glMe4VQ1FWnmYXYX8OGR5q1ShxWbuM3G23ELLRyeZTgP8wXbenP3Wyk0qs0SPE3XH9WHZKQ0DSQ/m+UwqSPm80D6uvmPp3+u+ifio1Nb1jniaS6v1XYcSNzBeZB3X</X509Certificate><X509Certificate>MIIF3jCCA8agAwIBAgIIFnZVyehmXYwwDQYJKoZIhvcNAQENBQAwbjELMAkGA1UEBhMCU0UxHTAbBgNVBAoMFFRlc3RiYW5rIEEgQUIgKHB1YmwpMRUwEwYDVQQFEwwxMTExMTExMTExMTExKTAnBgNVBAMMIFRlc3RiYW5rIEEgQ0EgdjEgZm9yIEJhbmtJRCBUZXN0MB4XDTExMDkyMjE0MjExNFoXDTM0MTIwMTE0MjExNFoweDELMAkGA1UEBhMCU0UxHTAbBgNVBAoMFFRlc3RiYW5rIEEgQUIgKHB1YmwpMRUwEwYDVQQFEwwxMTExMTExMTExMTExMzAxBgNVBAMMKlRlc3RiYW5rIEEgQ3VzdG9tZXIgQ0ExIHYxIGZvciBCYW5rSUQgVGVzdDCCAiIwDQYJKoZIhvcNAQEBBQADggIPADCCAgoCggIBAIW0DPopLEhtawVRwNrE431GVsh/HnWVsXdgOjzUsD7QD30/tfOHROQi9nLuDWkY1fEUxZ06Yq5LtROoFpkTQ6SRi2RgiUkuCNqMEwsj2eia7KhYRIk/XJkkFp1BvE62I63vtUzZzS69HAsMNPlfdLU2pIZ2And2QJ2dC0ximmFjY5k5/z7/Nk3JGBbaxLH/X6zhcNqOpr2Srv9G+lk+Gvy7hQLImNLRV+4G3malHj6QM+wDcRKvT4V+iRdvzP9o803/g+GL5qiufW6RdT+2lwGifP2d3suL79uGW1HO8qbii/i4HTxDftKdXFslFrXfR++QUU4B+v6Qyb4rF3qhDfeakgfL8uzftMtTMRlowxIb08jxCehCSaY0CMBHQTS0LtX1C/VjM6UbbpSa280zSL+xXlS7S727sJB722fzWR3/NSp3MZTbE0QAqMTENY4pfwc/lXwVn8TvANw1FIxE7ikwIBMFSo6eX2UDDz9ai6dzRrYftI44EtLTv3KV5UDWcIbsRBvlgBQqquphcuRVv1a6Xo9xeH2+o+Bsr+soumiC6zIFuUuBxB4uqsSqeVQFkIaepinwhX5CJBZLcORaMZF6I1kGvEDZOVYXOEt9PWg/SsScGM+sf2510Gz0f2omQjOL5BezdYYKNAwziz9U1Ir1VpvzkJF4SA3W05cmjjKZAgMBAAGjdjB0MB0GA1UdDgQWBBRgen2nWYOMn6SxF+oNQ0OVQ+aZ/TAPBgNVHRMBAf8EBTADAQH/MB8GA1UdIwQYMBaAFKPyeHkdK0WKyeHKlQnlnm/Oy07FMBEGA1UdIAQKMAgwBgYEKgMEBTAOBgNVHQ8BAf8EBAMCAQYwDQYJKoZIhvcNAQENBQADggIBADxhyzWSzokyG+hUCp3Ug7QZxbMLK+6IYp+8acRuTSFfr5maH3Mryd87/B2y9K3fW+FXQLpdhVHovKJOAQyv/t3CA62ZGrzhAXGqCcR9Sn44ecKRJPE9ZJbzalo4wtKRUv04W2ZgFunYTN55TsNn3bGzcIiAddMq9TMKwIjl6p5i6oIjAmt9/75Qf7qQ/1x20EUdsv+8QPIp1vlB8vAzAto+8bZFCRsdMVLRRk96CoS53v4aDYYAMxmsTbgvLqVU5/CNfVEgVeSpFVSz6flbFMBZd5LOPgli/lRJ7FWewQvrZaKgfJgdmUUvCpi0eD+/KBnsEJLbhdnK/B+iTo4A6BwoR+9XhOQyNMTB/SDtSYczJ35vFhZfKJ5/0psqXSJH/25wA4pe/34ERzQ1mgladt6JOhnWf92Jw5jdw7BFptg7lmIkDyYDU+6RyEsArCibI+28yF5/fCZCuUdwDw9iHpoodf1h8t1gfPnnmkcwGTfPg/duUgkFwKY97SzfZgR02hd7xxo5pK79czimMF2GTFw9SWSnlZK71foY25FzSUHNmuGHhFzG98AFIt0VLwiTj8tJeSjTi41if237vDNvsept+8/tt80/f45KzPNfWUB06/FGr0wfoYgZp4Pi9RRTXzDafwj7qLduaepRrLcEUpXWCGruSUylxxChdBTwVzZn</X509Certificate><X509Certificate>MIIF0zCCA7ugAwIBAgIIUYmfdtqty80wDQYJKoZIhvcNAQENBQAwbTEkMCIGA1UECgwbRmluYW5zaWVsbCBJRC1UZWtuaWsgQklEIEFCMR8wHQYDVQQLDBZCYW5rSUQgTWVtYmVyIEJhbmtzIENBMSQwIgYDVQQDDBtUZXN0IEJhbmtJRCBSb290IENBIHYxIFRlc3QwHhcNMTEwOTIyMTQxNTAzWhcNMzQxMjMxMTQwMTMzWjBuMQswCQYDVQQGEwJTRTEdMBsGA1UECgwUVGVzdGJhbmsgQSBBQiAocHVibCkxFTATBgNVBAUTDDExMTExMTExMTExMTEpMCcGA1UEAwwgVGVzdGJhbmsgQSBDQSB2MSBmb3IgQmFua0lEIFRlc3QwggIiMA0GCSqGSIb3DQEBAQUAA4ICDwAwggIKAoICAQCTqU7uxk5QzbXS6ArXIGTWNeZXz65bzdgoxb79LvYh/p7kcK25mA2tzGpO3QS1eKJJu84G9UNzm4mMl6cngnXcjxETYiEqtijrA5mfz865/X6UgOpX7DkouQ8d5eDyhJ49UrDqlrgoVMx322kM0SZ4heVeX83e1ISFiyxqZBKxh25yKYEZA4EzIrDj2ti8CRrWPHCTWaIFpcd5TyMhpUTPn4DzwPhPGWMRNxgOAeP4BSDB7R6az4rox7TPkd2sWG1ODj/0IRPhJS1dQ1B7QiNHY58RjnNThEQKwdWWMPMKPthSd+GEjL9GDafYxOsIrKFYwlYNBW3C5mbe3T+3j+Axj6W2HbgmJXPGItLucxY1kPwT9L7u5nIxaROmh1uTwYqr9puGq6soJnggES3K4PIhM6kamvnCCPXoqWCCruSEPVgyEZEi0shy+81Qseb1gc9rYgVrEnLBOIyMqaTtExaFprYbv1f/AwWtjFUi2XiSdN8aMp+kqbi+1tKJUUPLC+Crdu9fFo/8lslSdew+SnPVFeVz5COKbt6GTE4xcJeRzW5wQ0w7b+rGLWhJvwRJsS5GXvqa3Lg8EyWiLJswuTFaEwPUDvZBvyFZEZertKgZbRYvezo9/grwyB+morVrLryu9chYEYwE550uzyKtzXUzygV8FpXe9DpmpOSfGMAURQIDAQABo3YwdDAdBgNVHQ4EFgQUo/J4eR0rRYrJ4cqVCeWeb87LTsUwDwYDVR0TAQH/BAUwAwEB/zAfBgNVHSMEGDAWgBRK96NqCNoIOBcZUyjI2qbWNNhaujARBgNVHSAECjAIMAYGBCoDBAUwDgYDVR0PAQH/BAQDAgEGMA0GCSqGSIb3DQEBDQUAA4ICAQDP1DoxjEjeyG27xeai+mpxxJoqB1RDVTEY86RdNyluUKQOIbfKJMmX+DX4vTuUQS3539xzHKwpj6gk+iZVjF1UoJtGp+qurjjarOh44s++s0yWKiKrJBEloJn8o+YXFT8C7e1WtqJVoaFdDBCvohJyK20PKS7/nUG5b7J6iq3517Yvjb4D94Lt0dHNSgD2BIIHmNkpSYWgyi1seavhN5AjtfJr4p101u2SsNcLAr42A5fran9vL29HjaM2MTU8L0OxoIX8lgcpUy9wci7lHQKOiwaOcIKfCC1qM7lO5z0c4P+o0zT6183xJV3rmw22GGYd40EBqW97oqBK0Ij+Kl5suycZ4J2qK1aVciYBZsBNlbtmz/k8HuBxy9WbEePsY/61I50fBLSAkVk/Tea4j+NNHJ1imp7Bo18aLo8plb9e2iZeIDzH1u66o0RFYbHdnJD8CnPeBLVgSvEqmBS11fgHr81/tk5lJxcKejdsEftzGQxwuHw/pjkjobIkxrroXpa6iXokVyH4be16+f/dDaEkh9Rf8Lh1UEQPxxpCyISMifH5pL78DKhGnh8Vfi7EesUV1k6Y3eVCFw2CCKWcvXsJb9QqLFsDqIlWPh6bBgM4aXfpe0arDrgYRbbx8L6ouhyxAHwjtz9i0lXezWMX5f7QYREMTC5yBPNTTP2fCNsozQ==</X509Certificate></X509Data></KeyInfo><Object><bankIdSignedData xmlns="http://www.bankid.com/signature/v1.0.0/types" Id="bidSignedData"><srvInfo><name>Y249RlAgVGVzdGNlcnQgNCxuYW1lPVRlc3QgYXYgQmFua0lELHNlcmlhbE51bWJlcj01NTY2MzA0OTI4LG89VGVzdGJhbmsgQSBBQiAocHVibCksYz1TRQ==</name><nonce>NCDg2IQjMsEAnXvJZa41Jg9LlD0=</nonce><displayName>VGVzdCBhdiBCYW5rSUQ=</displayName></srvInfo><clientInfo><funcId>Identification</funcId><version>UGVyc29uYWw9Ny4xNC4wLjE2JkJhbmtJRF9leGU9Ny4xNC4wLjE2JkJJU1A9Ny4xNC4wLjE2JnBsYXRmb3JtPXdpbjY0Jm9zX3ZlcnNpb249d2luMTEmZGlzcGxheV92ZXJzaW9uPTIySDImdWhpPWczM2toNlJ6eWNnZGdKTVVvamFZT0hyWS9YYnAmbGVnYWN5dWhpPWdnZ3JvczVrUE1VMlpWeU51OFpMd0UrbHhpTlQmYmVzdF9iZWZvcmU9MTcwMDcyMzU0MCZTbWFydENhcmRfUmVhZGVyPU1pY3Jvc29mdCBJRkQgMCZTbWFydENhcmRfUmVhZGVyPVdpbmRvd3MgSGVsbG8gZm9yIEJ1c2luZXNzIDEm</version><env><ai><type>V0lORE9XUw==</type><deviceInfo>d2luMTE=</deviceInfo><uhi>g33kh6RzycgdgJMUojaYOHrY/Xbp</uhi><fsib>1</fsib><utb>cs1</utb><requirement><condition><type>CertificatePolicies</type><value>1.2.3.4.5</value></condition></requirement><uauth>pw</uauth></ai></env></clientInfo></bankIdSignedData></Object></Signature>", "userInfo": { "givenName": "Erik Lennart", "ipAddress": "109.228.185.130", "name": "Erik Lennart Eriksson", "personalNumber": "194911201111", "surname": "Eriksson" } }, "method": "Auth", "userMessage": "NoMessage" }, "status": "Finished" } ``` ### Sample of Error response ```json { "errors": [ { "code": "CANCELLED_BY_USER", "description": "Action cancelled by user" } ], "id": "2cab790d-d0d6-4aa5-9d94-c08caab5dfba", "result": { "method": "Auth", "userMessage": "RFA6" }, "status": "Cancelled" } ``` #### Response Parameters |Parameter|Type|Description| |---|---|---| |errors|list|list of errors see separate table| |id|string|UUID for the session used to fetch the status and result of a session| |result|list|Contains the result of the session more details below.| |ocspResponse|String|The OCSP response. Base64-encoded. The OCSP response is signed by a certificate that has the same issuer as the certificate being verified. The OSCP response has an extension for Nonce. The nonce is calculated as:<br><br>- SHA-1 hash over the base 64 XML signature encoded as UTF-8.<br>- 12 random bytes is added after the hash.<br>- The nonce is 32 bytes (20 + 12).| |orderRef|string|Idprovider UUID for the session, used when conmmunicating issuses with specfic session with provider| |signature|String|The signature as described in the BankID Signature Profile specification. Base64-encoded. XML signature.| |userInfo|Object|Information related to the user:<br><br>- personalNumber: The personal identity number.<br>- name: The given name and surname of the user.<br>- givenName: The given name of the user.<br>- surname: The surname of the user.<br>- ipAddress: The IP address of the user agent as the BankID server discovers it.| |method|String|The method used: "Auth" for Authentication and "Sign" for signature.| |userMessage|String|NoMessage, RFA1, RFA2, RFA3, RFA4, RFA5, RFA6, RFA8, RFA9, RFA13, RFA14, RFA14A, RFA14B, RFA15, RFA15A, RFA15B, RFA16, RFA17, RFA17A, RFA17B, RFA18, RFA19, RFA20, RFA21, RFA22, RFA23| |status|String|Created, GeneratedLink, Pending, Finished, Failed, Cancelled, TimeOut.| #### Errors |Parameter|Type|Description| |---|---|---| |code|string|Error code. Can be used for automatic error processing.| |description|string|Error description. Human readable text.| |details|string|Error details. Might contain technical information.| --- ## API Flow ##### Execution Sequence The opening call initiates the desired end user operation - Authenticate or Sign. 1. This initial call triggers the authenticate or sign process on the BankID backend instantly, alerting the BankID app to display the authenticate or sign page. It's advisable to have a web hook set up for “completion/error” to bypass frequent checks. Establish a login session and launch BankID backend and app for the designated operation - Authenticate or Sign. This will result in a new BankID session token. 2. Commence the login procedure in a BankID app, you find details in the Launching paragraph below. 3. To retrieve the Final Results, ProgressStatus, or Errors, call the API in any of the following ways: -Automate the posting of results to the client's webhooks for success and error, previously registered with ZignSec. -Continually monitor the progress status, errors, and ultimately collect the results. 4. Cancel request terminates an ongoing sign, auth or phone order. This is generally utilized when the user discontinues the order within your service or application Here is the sequence diagrams related to the API flow ![[ApiOnSame.jpg]] ![[ApiOnOther.jpg]] **API Endpoints** - BaseUrl for Test: https://test-gateway.zignsec.com/core/api/sessions/ - BaseUrl for Production: https://gateway.zignsec.com/core/api/sessions/ ##### Authenticate **POST**- BankID SE (Create Authentication Session) **Endpoint:** /bankidse/auth **GET** - Get Session Data (BankID SE (Create Authentication Session)) **Endpoint:** /bankidse/auth/id ##### Sign **POST** - BankID SE (Create Signing Session) **Endpoint:** /bankidse/sign **GET** - Get Session Data (BankID SE (Create Signing Session)) **Endpoint:** bankidse/sign/id #### Sample of a BankID SE Auth Request ```bash curl -X 'POST' \ 'https://test-gateway.zignsec.com/core/api/sessions/bankidse/auth' \ -H 'accept: application/json' \ -H 'authorization: Your-Subscription-Key' \ -H 'Content-Type: application/json' \ -d '{ "locale": "En", "metadata": { "end_user_ip": "127.0.0.1", "requirement": { "certificate_policies": [ "1.2.3.4.5", "1.2.3.4.10", "1.2.3.4.25", "1.2.752.60.1.6", "1.2.752.78.1.1", "1.2.752.78.1.2", "1.2.752.78.1.5", "1.2.752.71.1.3" ], "mrtd": false, "pin_code": false }, "user_non_visible_text": "The text you'\''ll never see", "user_visible_text": "Please authorize the TEST" }, "redirect_failure": "https://my_failure_url.com", "redirect_success": "https://my_success_url.com", "relay_state": "my-unique-customer-id", "webhook": "https://my_webhook_url.com" }' ``` [**Request parameters**](https://developers.zignsec.com/products/bankid-se#request-parameters) **Additional request parameter** |Parameter|Type|Description|Required| |---|---|---|---| |end_user_ip|string|The user IP address as seen by RP. String. IPv4 and IPv6 is allowed. Note the importance of using the correct IP address. It must be the IP address representing the user agent (the end user device) as seen by the RP. If there is a proxy for inbound traffic, special considerations may need to be taken to get the correct address. In some use cases the IP address is not available, for instance for voice based services. In this case, the internal representation of those systems IP address is ok to use.|yes| ### Sample Response for BankID API auth This response has a onboarding setting turned. This setting gives you ready examples to add to your code depending on the device. Read more about launching the app in the following part. ```json { "data": { "errors": [], "id": "00e3bbf4-a6b5-48e8-b5bb-2b4417be17f7", "result": { "autoStartToken": "43181c31-a299-4af7-964f-9e84909efb39", "devExamples": { "autoStartUrls": { "android": "https://app.bankid.com/?autostarttoken=43181c31-a299-4af7-964f-9e84909efb39&redirect=null", "ios": "https://app.bankid.com/?autostarttoken=43181c31-a299-4af7-964f-9e84909efb39&redirect=https://translate.google.com/?sl=auto&tl=sv&text=All%20right!&op=translate", "pc": "bankid:///?autostarttoken=43181c31-a299-4af7-964f-9e84909efb39&redirect=null", "pcWithReturn": "bankid:///?autostarttoken=43181c31-a299-4af7-964f-9e84909efb39&redirect=https://translate.google.com/?sl=auto&tl=sv&text=All%20right!&op=translate" } }, "orderRef": "e719a549-dc96-448a-a3fd-77769afd7df3", "qrCodeLink": "https://test-gateway.zignsec.com/ui/bankidseweb/00e3bbf4-a6b5-48e8-b5bb-2b4417be17f7/qr?otp=KpIDtL2pbUCu0pqIkylCSg", "qrStartToken": "88a0a376-8809-42e0-9b90-117252ed3b31" }, "status": "Pending" } } ``` ### Sample response with onboarding setting turned off Same response as above with onboarding setting set to false. Just reach out to us and we will set the setting per your request. ```bash { "data": { "errors": [], "id": "df0bc372-a5c7-482c-8289-be73ad34ffde", "result": { "autoStartToken": "99890334-5ace-451d-8449-00e0a34ef94a", "orderRef": "572941e9-020a-431e-b161-f34589e4770b", "qrCodeLink": "https://test-gateway.zignsec.com/ui/bankidseweb/df0bc372-a5c7-482c-8289-be73ad34ffde/qr?otp=f71NR5LX9EatG4IyGV9HTQ", "qrStartToken": "01c0a40f-5e38-4757-b314-f772430ca264" }, "status": "Pending" } } ``` **Cancel** post BankID SE Cancel Endpoint: /bankidse/cancel ### Sample of cancel request ```bash curl --location 'https://test-gateway.zignsec.com/core/api/sessions/bankidse/cancel' \ --header 'accept: application/json' \ --header 'Authorization: your subscription key' \ --header 'Content-Type: application/json' \ --data '{ "metadata": { "session_id": "18511c63-5849-469b-bfec-6f1229a5997b" } }' ``` ### Sample of response ```json { "errors": [ { "code": "CANCELLED_BY_USER", "description": "Action cancelled by user" } ], "id": "a5a6357d-fc09-46fe-b267-ea6b2980d0ed", "result": { "method": "Auth", "userMessage": "NoMessage" }, "status": "Cancelled" } ``` ### Launching the BankID app Launching from native app on mobile device #### **Android** ```java Intent intent = new Intent(); intent.setAction(Intent.ACTION_VIEW); intent.setData(Uri.parse("https://app.bankid.com/?autostarttoken=&lt;INSERT AUTOSTARTTOKEN HERE&gt;&amp;redirect=null")); intent.setFlags(Intent.FLAG_ACTIVITY_NEW_TASK); startActivity(intent); ``` There is no guarantee that a valid result will be returned from the BankID app to the application's activity. The application should rely on the collect call to obtain the authentication or signature result. If the BankID app is not installed on the device, an android.content.ActivityNotFoundException is thrown. The application must inform the user and use Message RFA2. On Android 5, the URI should use the "bankid" scheme instead of the "https" scheme. #### **iOS** ```swift let url = URL(string: "https://app.bankid.com/?autostarttoken=<INSERT AUTOSTARTTOKEN HERE>&redirect=<INSERT YOUR LINK HERE>") UIApplication.shared.open(url!, options: [.universalLinksOnly:true]) { (success) in // handle success/failure } ``` If the BankID app is not installed on the device, "false" is returned. The application must inform the user and use Message RFA2. The application must register a universal link or a custom URL scheme to allow the BankID app to relaunch the application. During the Apple App Store review process, the app requires login information to a demo account. This demo account should either not require BankID for login or provide a way to configure the app to use the BankID test environment. #### **Launching the BankID app from a browser** The "redirect" parameter should be placed last in the parameter list. The "autostarttoken" and "rpref" parameters are optional. Parameter names should be in lowercase. If the BankID app is launched without any matching web service calls for authentication or signature, an error message will be displayed in the app. **App links and universal links on Android and iOS** The syntax for the URL is as follows: ```html https://app.bankid.com/?autostarttoken=[TOKEN]&redirect=[RETURNURL] ``` The URL works on Chrome (Android) and Safari (iOS). **Desktop and other mobile browsers** The syntax for the URL is as follows: ```html bankid:///?autostarttoken=[TOKEN]&redirect=[RETURNURL] ``` The URL works on PCs with all commonly used browsers. There may be variations on different platforms. ### QR code The typical use case for QR codes is when the user uses “Mobile BankID on other device” (see [Use cases](https://developers.zignsec.com/products/bankid-se#use-case)), and there is a security concern that the user does not control both devices. #### **QR code generation** The QR image needs to be updated once every 1-2 sec. (we use 2 sec. on our UI) 1. When our [Browser flow](https://developers.zignsec.com/products/bankid-se#browser-flow) is used, it is handled by ZignSec. 2. When the [Api flow](https://developers.zignsec.com/products/bankid-se#api-flow) is used, your will get a "qrCodeLink" in a response. Customers should display the image "qrCodeLink" and re-render it every 1-2 sec Note: if you navigate to "qrCodeLink" and hit refresh the page you will see new QR each time ### Sample QR html and javascript code Here an example on the htlm and javascript needed to make the QR code animated: #### **html** ```html ... <img id="qr-image" src="..." /> ... ``` #### **javascript** ```javascript const qrCodeLink = '...'; // from bankidse/auth request const imageElement = document.getElementById('qr-image'); const intervalInMilliseconds = 2000; // re-render QR every 2 seconds let t = 0; setInterval(function () { imageElement.setAttribute('src', qrCodeLink + "?t=" + t) t++; }, intervalInMilliseconds) ``` ### Phone Flow The process for initiating an authentication order over the phone and querying its status involves: 1. **Start**: A user converses over the phone, typically with customer service. 2. **Initiation**: Authentication is initiated during the call as needed. 3. **User Action**: The user is instructed to perform a task for authentication, such as entering a one-time password. 4. **Monitoring**: The 'collect' function periodically checks the status of the authentication process. 5. **Confirmation**: Upon successful authentication, the system updates the status, and the user is notified. 6. **Completion**: The call proceeds with the user now authenticated, enabling secure interactions. **POST** - BankID SE (Create Authentication Session over the Phone) **Endpoint:** /bankidse/phone/auth **GET** - Get Session Data (BankID SE (Create Authentication Session over the Phone)) **Endpoint:** /bankidse/phone/auth/id Sample of Phone auth request ```bash curl -X 'POST' \ 'https://test-gateway.zignsec.com/core/api/sessions/bankidse/phone/auth' \ -H 'accept: application/json' \ -H 'authorization: Your-Subscription-key' \ -H 'Content-Type: application/json' \ -d '{ "locale": "En", "metadata": { "call_initiator": "user", "personal_number": "194610241111", "user_non_visible_text": "The text you'\''ll never see", "user_visible_text": "Please authorize yourself for the TEST call" }, "redirect_failure": "https://my_failure_url.com", "redirect_success": "https://my_success_url.com", "relay_state": "my-unique-customer-id", "webhook": "https://my_webhook_url.com" }' ``` **Additional request parameters** |Parameter|Type|Description|Required| |---|---|---|---| |call_initiator|string|Indicate if the user or the RP initiated the phone call.|yes| |personal_number|string|The personal number of the user. 12 digits|yes| ### User Messages When processing an order, the BankID service sends status updates through the Collect API. It's advisable to present this order status , ensuring users stay informed and are notified of any possible errors. ### Recommended user messages | Short name | Swedish | English | Event, status, hintCode or errorCode | | ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------- | | RFA1 | Starta BankID-appen. | Start your BankID app. | status=pending <br>hintCode=outstandingTransaction <br>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 <br>errorCode=maintenance (repeatedly) <br>errorCode=internalError | | RFA6 | ÅtgĂ€rden avbruten. | Action cancelled. | status=failed <br>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 <br>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 <br>hintCode=userSign | | RFA13 | Försöker starta BankID-appen. | Trying to start your BankID app. | status=pending <br>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 <br>hintCode=started <br>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 <br>hintCode=started <br>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 <br>hintCode=started <br>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 <br>hintCode=started <br>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 <br>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 <br>hintCode=startFailed <br>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 <br>hintCode=startFailed <br>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? | Would you like to identify yourself or sign with a BankID on this device, or with a BankID on another device? | 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 <br>The hintCode is unknown. | | RFA22 | OkĂ€nt fel. Försök igen. | Unknown error. Please try again. | status=failed <br>The hintCode is unknown. <br>An error occured. The errorCode is unknown. | | RFA23 | Fotografera och lĂ€s av din ID-handling med BankID-appen. | Process your machine-readable travel document using the BankID app. | status=pending <br>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|SĂ€kerhetskod (för Mobilt BankID) <br>Lösenord (för BankID pĂ„ fil) <br>PIN (för BankID pĂ„ kort)|Security code (for Mobile BankID) <br>Password (for BankID on file) <br>PIN (for BankID on card)| |Sign|Skriva under|Sign| |Signature|Underskrift|Signature| |Identify|Identifiera|Identify| |Identification/authentication|Identifiering|Identification| ## Test BankID SE To get started, 1- Download the BankID app to your phone, or the program BankID Security Application to your computer. 2- Note that a [reconfiguration](https://www.bankid.com/en/utvecklare/test/skaffa-testbankid/testbankid-konfiguration) of the Bankid app is required 3- Move ahead in this [test guide](https://www.bankid.com/en/utvecklare/test/skaffa-testbankid) and follow the instructions to get a BankID for test. All details are mentioned in the [BankID Test website](https://www.bankid.com/en/utvecklare/test); Here you find a [demo](https://demo.bankid.com/) and more information on how to [integrate](https://www.bankid.com/en/utvecklare/guider/teknisk-integrationsguide) the Swedish BankID. You can use one of these [test users list](https://skatteverket.entryscape.net/store/9/resource/162) ***Note that you can not use the test BankID app and real BankID app at the same device.