Attributes reference

You use Freja to verify the end-user's identity and obtain relevant personal details about them. This page summarises the user information you can request and receive for the OIDC and the Authentication REST API protocols. We also support SAML 2.0, but this is not documented yet.

OIDC scopes and claims

You can use the following scopes to request user information from an end-user using Freja.

OIDC response example

This example shows the section with the user information attributes.

{
    "idp_id": "0A4724BF...",
    "name": "Sven Svensson",
    "family_name": "Svensson",
    "given_name": "Sven",
    "birthdate": "1990-02-17",
    "email": "test@example.com",
    "address": {
        "formatted": "AMINOGATAN 91, 10338, STOCKHOLM, SE",
        "street_address": "AMINOGATAN 91",
        "locality": "STOCKHOLM",
        "postal_code": "10338",
        "country": "SE"
    },
    "nin": "199002171234",
    "nin_type": "PERSON",
    "nin_issuing_country": "SE",
    "phone_number": "+46701740605",
    "freja_registration_level": "EXTENDED",
    "freja_relying_party_user_id": "0A4724B...",
    "freja_integrator_specific_user_id": "880A680...",
    "freja_all_phone_numbers": "[{\"phoneNumber\":\"+46701740605\"}]",
    "freja_age": "34",
    "freja_all_addresses": "[{\"country\":\"SE\",\"address\":\"ANEBYVÄGEN 61\",\"city\":\"STOCKHOLM\",\"postCode\":\"11148\",\"type\":\"RESIDENTIAL\"},{\"country\":\"SE\",\"address\":\"AMINOGATAN 91\",\"city\":\"STOCKHOLM\",\"postCode\":\"10338\",\"type\":\"POSTAL\"}]",
    "freja_all_email_addresses": "[{\"emailAddress\":\"test@example.com\"}]",
    "freja_document_data": "{\"country\":\"SE\",\"serialNumber\":\"258017186\",\"type\":\"PASS\",\"expirationDate\":\"2029-06-11\"}",
    "sub": "-DvPAh0WNbby3QSmSIQODS4gSpRFnKBbl0RvuKcG3uY=",
    "idp_issuer": "https://oidc-ct.test.frejaeid.com/oidc/"
}

Authentication REST API attributes

The Signicat Authentication REST API supports the following request and response attributes for Freja:

Authentication REST API response example

Here is a full response example. You can find the user information inside the subject object:

{
    "id": "d64e1b7c-960a-...",
    "accountId": "a-sdge-...",
    "authenticationUrl": "https://<YOUR_SIGNICAT_DOMAIN>/broker/sp/external-service/login?messageId=39ea...",
    "status": "SUCCESS",
    "provider": "freja",
    "subject": {
        "id": "-DvPAh0W...",
        "idpId": "0A4724BF...",
        "name": "Sven Svensson",
        "firstName": "Sven",
        "lastName": "Svensson",
        "dateOfBirth": "1990-02-17",
        "email": "test@example.com",
        "nin": {
            "value": "199002171234",
            "issuingCountry": "SE",
            "type": "PERSON"
        },
        "phoneNumber": "+46701740605",
        "frejaRegistrationLevel": "EXTENDED",
        "frejaRelyingPartyUserId": "0A4724B...",
        "frejaIntegratorSpecificUserId": "880A680...",
        "frejaAllPhoneNumbers": "[{\"phoneNumber\":\"+46701740605\"}]",
        "frejaAllAddresses": "[{\"country\":\"SE\",\"address\":\"ANEBYVÄGEN 61\",\"city\":\"STOCKHOLM\",\"postCode\":\"11148\",\"type\":\"RESIDENTIAL\"},{\"country\":\"SE\",\"address\":\"AMINOGATAN 91\",\"city\":\"STOCKHOLM\",\"postCode\":\"10338\",\"type\":\"POSTAL\"}]",
        "frejaAllEmailAddresses": "[{\"emailAddress\":\"test@example.com\"}]",
        "frejaAge": "34",
        "frejaDocumentData": "{\"country\":\"SE\",\"serialNumber\":\"258017186\",\"type\":\"PASS\",\"expirationDate\":\"2029-06-11\"}",
        "address": "AMINOGATAN 91, 10338, STOCKHOLM, SE",
        "addressFormatted": {
            "FullAddress": "AMINOGATAN 91, 10338, STOCKHOLM, SE",
            "Street": "AMINOGATAN 91",
            "City": "STOCKHOLM",
            "PostalCode": "10338",
            "Country": "SE"
        }
    },
    "callbackUrls": {
        "success": "http://example.com/success?sessionId=d64e1b7c-960a-...",
        "abort": "http://example.com/abort?sessionId=d64e16b7c-960a-...",
        "error": "http://example.com/error?sessionId=d64e1b7c-90a-..."
    },
    "environment": {
        "ipAddress": "192.0.2.0",
        "userAgent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/127.0.0.0 Safari/537.36"
    },
    "allowedProviders": [
        "freja"
    ],
    "flow": "redirect",
    "requestedAttributes": [
        "address",
        "email",
        "firstName",
        "frejaAge",
        "frejaAllAddresses",
        "frejaAllEmailAddresses",
        "frejaAllPhoneNumbers",
        "frejaDocumentData",
        "frejaIntegratorSpecificUserId",
        "frejaRegistrationLevel",
        "frejaRelyingPartyUserId",
        "fullName",
        "lastName",
        "name",
        "nin",
        "phoneNumber",
        "idpId"
    ],
    "sessionLifetime": 1200,
    "expiresAt": "2024-08-13T08:41:43.9625942+00:00"
}