Skip to main content

Usage

Create a Freja transaction with provider: freja and method: auth to authenticate, or method: sign to sign.

Starting the user's app

To start, you can identify the user by email address, phone number in international format, or personal number. For authentication this is optional: leave it out and the user scans a QR code to start the flow in their app instead. For signing it's required.

Requesting identity information

You choose what you want back about the user, and the user sees the list in their app before they approve. By default a transaction returns the user's email address. You can request more, including their verified name, date of birth, address, personal number, assurance level and OrganisationID.

Some of these need a higher registration level. Name, date of birth, address and personal number require the user to have at least an Extended registration. If you request one of these and the user hasn't reached that level, they can't finish until they upgrade their Freja account, so only ask for what you need. To require the in-person-verified Freja eID+ level for a transaction, set the enforce-Plus flag on the request.

Signing

For signing, the text the user signs is required and is shown in the app. You can also set a title for the transaction list, customise the push notification title and text Freja sends to the user's device, and sign binary data. On completion you get back the same identity information as for authentication, plus the signature.