> For the complete documentation index, see [llms.txt](https://docs.fortifiedid.se/access/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.fortifiedid.se/access/key-components/authenticators/credential-validators/bankid/on-mobile-device.md). # On mobile device Use for mobile devices. Either scan QR code or on the same device using app switch. No user input is expected. ## Configuration Based on the BankID documentation found here: {% hint style="info" %} **Authenticator type:** `BidOnMobileDevice` {% endhint %} Common Authenticator configuration can be found [here](/access/key-components/authenticators/common-configuration.md). {% tabs %} {% tab title="Properties" %}
NameDescriptionDefault valueMandatory
internal_http_destinationID of the internal http client used to talk with BankID backend."default"false
modeThree modes are possible: "production", "test" & "custom". Depending on the mode, the URL used to talk to BankID differs."production"false
custom_urlDefines a custom BankID backend URL. Only works if mode is set to "custom".N/Afalse
custom_identifierWhen logging events, the custom_identifier lets you tag the event.N/Afalse
requirementSpecifications on client requirements based on BankID relying-party documentation.N/Afalse
poll_frequencyHow often should client poll for status updates (in seconds).2false
allowed_polling_for_minutesHow many minutes is client allowed to keep polling.2false
webroot_dirSee common authenticator configurationweb/authenticator/bankid/omdfalse
{% endtab %} {% tab title="Example" %} ```json { "id": "bidomd", "type": "BidOnMobileDevice", "config": { "base_path": "/test/authn", "internal_http_destination": "bid", "webroot_dir": "web/authenticator/bankid/omd", "overlay_dir": "authenticator/bankid/bidomd/overlay" } } ``` {% endtab %} {% endtabs %} {% hint style="warning" %} Property *base\_path* should not contain the full path when used in conjunction with the [Selector](/access/key-components/authenticators/flow-control/selector.md), instead, the full URI will be handled by the selector. The full path will be *base\_path + / + id*. {% endhint %} ## Logging Apart from system logging, event logging is done when starting, completing, and failing a BankID transaction. Event ids are: * WEB\_100001, BankID authentication started * IDENTIFIER (user trace id) * SOURCE\_ADDRESS (ip address of device starting transaction) * CUSTOMER\_IDENTIFIER (if configured) * AUTHENTICATOR\_IDENTIFIER (id and display name) * WEB\_100002, BankID authentication completed * IDENTIFIER (user trace id) * SOURCE\_ADDRESS (ip address of the BankID device used) * SOURCE\_USER\_NAME (personal number) * CUSTOMER\_IDENTIFIER (if configured) * AUTHENTICATOR\_IDENTIFIER (id and display name) * GIVENNAME * SURNAME * WEB\_100003, BankID authentication failed * IDENTIFIER (user trace id) * SOURCE\_ADDRESS (ip address of the BankID device used) * MESSAGE (information) * AUTHENTICATOR\_IDENTIFIER (id and display name) * WEB\_100004, BankID authentication canceled or expired * IDENTIFIER (user trace id) * AUTHENTICATOR\_IDENTIFIER (id and display name) * SOURCE\_ADDRESS (ip address of the BankID device used) ## Data exposed to global state After a user completes a transaction, the authenticator is marked as done. Data from the BankID authentication response is then put into the global state: * givenName * surname * name * personalNumber * ipAddress * ocsp * signature Note that it is not guaranteed that all parameters hold value. ## API When communicating with the backend this describes the ### General requirements Backend communications are made using AJAX and the HTTP PUT method. Every request need a Content-Type with the value of `application/json`*.* ### Getting state Body must conform to the example below. ```json { "type": "state" } ``` ### Starting an authentication To start authentication send AJAX request. ```json { "type": "start", "data": { } } ``` ### Cancel a request A request can be canceled at any time. This is done by sending a cancel request. ```json { "type": "cancel" } ``` ### Response from server In general, you should expect a server response with http status code 200. Anything else is to be considered an error. Response body will be in the form of a JSON object. Typically the response looks like: ```json { "bidstatus": "PENDING", "qrData": "", "pollFrequency": 2, "autostartToken": "", "countdownSeconds": 300 } ``` The property `"bidstatus"` will contain status. Depending on state additional data may be included in the answer as shown above. ### Possible status messages One of the following status codes is returned based on the current state. * ABOUT\_TO\_START * PENDING * COMPLETE * BID\_ERROR * ERROR * OUTSTANDINGTRANSACTION, * NOCLIENT * STARTED * USERSIGN * EXPIREDTRANSACTION * STARTFAILED * CANCELLED * USERCANCEL * CERTIFICATEERR ## Translation keys Default translations provided: #### English, assets/locales/en.json ```json { "bankid.omd.open_bankid_app": "Open BankID app", "bankid.omd.bankid_app_opened": "BankID app opened", "bankid.omd.open_bankid_app_on_this_device": "Log in using BankID on this device", "bankid.omd.show_qr_code": "Show QR code for login", "bankid.omd.verify_authentication": "Verifify identification", "bankid.omd.authentication_verified": "Identification verified", "bankid.omd.redirecting": "Redirecting...", "bankid.omd.start_bankid_app": "Start your BankID app.", "bankid.omd.cancel": "Cancel", "bankid.omd.BID_ERROR": "Unknown error. Please try again.", "bankid.omd.ERROR": "Unknown error. Please try again.", "bankid.omd.NOCLIENT": "Starting the BankID application failed", "bankid.omd.EXPIREDTRANSACTION": "The BankID app is not responding. Please check that the program is started and that you have internet access. If you don’t have a valid BankID you can get one from your bank. Try again.", "bankid.omd.STARTFAILED": "Failed to scan the QR code. The QR code is no longer valid due to a timeout.\n Check that the BankID app is up to date. If you don't have the BankID app, you need to install it and order a BankID from your internet bank. Install the app from your app store or https://install.bankid.com.", "bankid.omd.CANCELLED": "Action cancelled. Please try again.", "bankid.omd.USERCANCEL": "Action cancelled. Please try again.", "bankid.omd.CERTIFICATEERR": "The BankID you are trying to use is revoked or too old. Please use another BankID or order a new one from your internet bank.", "bankid.omd.restart": "Start new authentication", "bankid.omd.qr_aria_label": "QR code for BankID, click for fullscreen", "bankid.omd.toggle_fullscreen_aria_label": "Toggle fullscreen", "bankid.omd.request.timeout": "Authentication timed out. Please try again.", "bankid.omd.extend_button": "Extend authentication", "allow-cookies-header": "Allow cookies", "allow-cookies-body": "To save your language settings on this device you need to allow cookies.", "allow-cookies-button": "Allow cookies", "allow-cookies-dismiss": "Dismiss", "authentication.help_text": "", "change_language": "Change language", "request.timeout": "Request timed out. Please try again.", "common.countdown.second": "{{seconds}} second", "common.countdown.seconds": "{{seconds}} seconds", "common.countdown.minute": "{{minutes}} minute", "common.countdown.minutes": "{{minutes}} minutes" } ``` #### Swedish, assets/locales/sv.json ```json { "bankid.omd.open_bankid_app": "Öppna BankID-appen", "bankid.omd.bankid_app_opened": "BankID-appen öppnad", "bankid.omd.open_bankid_app_on_this_device": "Logga in med BankID på den här enheten", "bankid.omd.show_qr_code": "Visa QR-kod för inloggning", "bankid.omd.verify_authentication": "Verifiera legitimering", "bankid.omd.authentication_verified": "Legitimeringen verifierad", "bankid.omd.redirecting": "Omdirigerar...", "bankid.omd.start_bankid_app": "Starta BankID-appen", "bankid.omd.cancel": "Avbryt", "bankid.omd.BID_ERROR": "Okänt fel. Försök igen.", "bankid.omd.ERROR": "Okänt fel. Försök igen.", "bankid.omd.NOCLIENT": "Start av BankID applikationen misslyckades", "bankid.omd.EXPIREDTRANSACTION": "BankID-appen svarar inte. Kontrollera att den är startad och att du har internetanslutning. Om du inte har något giltigt BankID kan du hämta ett hos din Bank. Försök sedan igen", "bankid.omd.STARTFAILED": "Misslyckades att läsa av QR koden. QR-koden är inte giltig längre pga timeout.\n Kontrollera att BankID-appen är uppdaterad. Om du inte har BankID-appen måste du installera den och hämta ett BankID hos din internetbank. Installera appen från din appbutik eller https://install.bankid.com. Påbörja sedan en ny inloggning.", "bankid.omd.CANCELLED": "Åtgärden avbruten. Försök igen", "bankid.omd.USERCANCEL": "Åtgärden avbruten. Försök igen", "bankid.omd.CERTIFICATEERR": "Det BankID du försöker använda är för gammalt eller spärrat. Använd ett annat BankID eller hämta ett nytt hos din internetbank.", "bankid.omd.restart": "Starta ny inloggning", "bankid.omd.qr_aria_label": "QR-kod för BankID, klicka för helskärm", "bankid.omd.toggle_fullscreen_aria_label": "Klicka för att gå till helskärm", "bankid.omd.request.timeout": "Det tog för lång tid att öppna BankID-appen. Försök igen.", "bankid.omd.extend_button": "Förläng inloggning", "allow-cookies-header": "Tillåt cookies", "allow-cookies-body": "Vill du spara dina språkinställningar på denna enhet behöver du tillåta cookies", "allow-cookies-button": "Tillåt cookies", "allow-cookies-dismiss": "Avfärda", "authentication.help_text": "", "change_language": "Byt språk", "request.timeout": "Tidsgränsen för förfrågan har överskridits. Försök igen.", "common.countdown.second": "{{seconds}} sekund", "common.countdown.seconds": "{{seconds}} sekunder", "common.countdown.minute": "{{minutes}} minut", "common.countdown.minutes": "{{minutes}} minuter" } ``` ## Exposed metric ### Gauges *ffidAuthnHttp\_pending.name.\\_collect* - indicates how many collect requests hans been sent out and is awaiting response *ffidAuthnHttp\_pending.name.\\_start* - indicates how many start requests hans been sent out and is awaiting response ### Meters *ffidAuthnHttp\_failure.name.\\_collect* - indicates number of failed status collects. *ffidAuthnHttp\_failure.name.\\_start* - indicates number of failed bank id start. *ffidAuthnHttp\_success.name.\\_start* - indicates number of successful bank id starts *ffidAuthnHttp\_success.name.\\_collect* - indicates number of successful bank id collects ### Timers *ffidAuthnHttp\_request.name.\\_collect -* Tracks the time of a collect round trip. *ffidAuthnHttp\_request.name.\\_start -* Tracks the time of a collect round trip. --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://docs.fortifiedid.se/access/key-components/authenticators/credential-validators/bankid/on-mobile-device.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.