Freja eID Client - Developers' Guide
About Freja eID
Freja eID is an electronic identification (eID) solution that citizens and organisations can use for authentication and signing. The essential part of Freja eID service is a smartphone application used for login and signing to all the services that are connected to the user's eID. The second part is a web portal – My Pages – where the user can control how their eID is to be used and has a full record of user history.
About this Document
This document describes the client library - Freja eID Client - that simplifies coding against the Freja ID Relying Party API when it comes to using Freja eID Services. Using this library will also make your code more robust, as the library provides error handling, parameter validation and other helpful features.
About the Client Library
Our client library is written in Java programming language. The intended reader of this document is a Java developer aiming to utilise the Freja eID Client for integrating the Relying Party's back-end system with Freja eID’s mobile service. We, therefore, assume a degree of proficiency in object-oriented programming, as well as developing applications using web services and microservices.
You can find the Java source code of our library on GitHub.
Table of Contents
This client library provides a set of classes, interfaces and utility methods designed for implementing the following:
initiation of an authentication request
fetching a single authentication result based on authentication reference
fetching multiple authentication results
cancelling authentication requests
initiation of a signature request
fetching a single signature result based on signature reference
fetching multiple signature results
cancelling signature requests
adding an organisation identifier for a user
deleting an organisation identifier for a user
fetching the result of adding an organisation identifier for a user
cancelling adding the organisation identifier for a user
updating additional attributes for an issued organisation ID
Fetch user custodianship status
setting a custom identifier for a user
deleting a custom identifier
Additional Information for Integrators/Integrated Relying Parties
Changelog
Client Library Version | Date | Notes |
|---|---|---|
2.34.1 | 2026-08-27 | Updated dependencies to address current CVEs. |
2.34.0 | 2026-02-27 | Added support for setting optional text displayed to the user when initiating an Organisation ID transaction. |
2.33.1 | 2026-02-03 | Added default request creators using UPI for Authentication, Signature and Organisation ID transactions. |
2.33.0 | 2026-02-02 | Added UPI as a supported user information type when initiating transactions and managing custom identifiers. |
2.32.0 | 2026-01-14 | Extended DOCUMENT_INFO_WITH_PDF with SSN, basic user information, date of birth, gender, document photo and NFC ID photo. |
2.31.1 | 2026-01-14 | Maintenance release containing no client-facing functional changes. |
2.31.0 | 2025-11-27 | Added GENDER and NFC_ID_PHOTO as requested attributes. Added support for supplying an explicit truststore and improved default truststore initialisation. |
2.30.0 | 2025-09-23 | Added dynamic QR code support for Authentication and Signature transactions and exposed the QR code secret in initiation responses. |
2.29.1 | 2025-09-05 | Updated the Maven Central publishing configuration. No client-facing API changes. |
2.29.0 | 2025-09-04 | Added uniquePersonalIdentifier to OrganisationIdUserInfo and introduced getAllUsersV2 for retrieving Organisation ID users in all registration states, including BASIC. |
2.28.0 | 2025-03-25 | Added newDeviceWarningStartDate to OriginDeviceDetails. |
2.27.3 | 2025-03-25 | Maintenance release containing no client-facing functional changes. |
2.27.2 | 2025-03-20 | Fixed QR code generation. |
2.27.1 | 2025-02-24 | Added UNIQUE_PERSONAL_IDENTIFIER and LOA_LEVEL as attributeToReturn and requestedAttributes parameter in Authentication and Signature Service client. |
2.24.0 | 2024-06-26 | Added support for INFERRED min registration level |
2.21.0 | 2024-02-19 | Added DOCUMENT_PHOTO as attributeToReturn and requestedAttributes parameter in Authentication and Signature Service Client. |
2.20.1 | 2023-12-15 | Added a new method allowing you to update additional attributes for users who have been assigned an Organisation ID. |
2.19.0 | 2023-12-05 | Supported userConfirmationMethod. |
2.18.0 | 2023-05-10 | Added Custodianship Client and new method to retrieve user custodianship status. |
2.17.0 | 2023-02-06 | Added support for generating authentication QR Codes to the Authentication Client. |
2.16.0 | 2022-10-27 | Supported XML_MINAMEDDELANDEN advanced signature type. |
2.15.0 | 2022-10-10 | Supported INFERRED user info type for SIGN transactions. |
2.14.0 | 2022-09-15 | Supported identifierDisplayTypes and additionalAttributes to initiateAddOrganisationId request and additionalAttributes as a part of ORGANISATION_ID attribute. |
2.13.1 | 2022-04-29 | Added ORGANISATION_ID as attributeToReturn and requestedAttributes parameter in Authentication and Signature Service Client. |
2.12 | 2021-12-20 | Added DOCUMENT as attributeToReturn and requestAttributes parameter in Authentication and Signature Service Client. |
2.11 | 2021-10-21 | Added PHOTO as attributeToReturn and requestAttributes parameter in Authentication and Signature Service Client. |
2.10.0 | 2021-08-31 | Supported ANY parameter for orgIdIssuer. |
2.9.3 | 2021-06-04 | Added COVID_CERTIFICATES as attributeToReturn and requestAttributes parameter in Authentication and Signature Service Client. |
2.8 | 2021-02-12 | Added AGE as attributeToReturn and requestAttributes parameter in Authentication and Signature Service Client. |
2.7 | 2020-12-21 | Added REGISTRATION_LEVEL as attributeToReturn and requestAttributes parameter in Authentication and Signature Service Client. |
2.6 | 2020-10-27 | Added ALL_PHONE_NUMBERS as attributeToReturn and requestAttributes parameter in Authentication and Signature Service Client. |
2.5 | 2020-08-04 | Increased default polling timeout for Signature and Organisation ID client to 1min. |
2.4 | 2020-07-20 | Added a new method allowing you to fetch all users who have been assigned an Organisation ID. |
2.3 | 2020-06-24 | Provided logger with slf4j library/fasade. |
2.2 | 2020-05-07 | Added ALL_EMAIL_ADDRESSES as attributeToReturn and requestedAttributes parameter in Authentication and Signature Service Client. |
2.1 | 2020-04-02 | Added ADDRESSES as attributesToReturn and requestedAttributes parameter in Authentication and Signature Service Client. |
2.0 | 2020-01-22 | Added Initialising Freja eID Client. |
1.0 | 2019-12-27 | This document is a preliminary version. The content of this document is still under review and subject to change. |