Freja ID

Freja eID is an electronic identity created by Verisec AB, a Swedish IT security company.Freja allows you to identify yourself to services smoothly and safely, both in physical and digital spaces.

Registration steps at Freja – Registration – Freja (frejaeid.com)

Testing Instructions for Freja – Freja eID Relying Party Documentation – Testing instructions

Content:

1. Identity Verification with Freja ID (SSN)

2. Identity Verification with Freja ID (QR)

3. Identity Verification with Freja ID (Phone)

4. Identity Verification with Freja ID (Email)

5. Get Results

1 . Identity Verification with Freja ID (SSN)

1.1 Start session

POST to Zignsec URL:

Test Env: https://test-gateway.zignsec.com/core/api/sessions/identity_verification/freja_id_ssn

Prod Env: https://gateway.zignsec.com/core/api/sessions/identity_verification/freja_id_ssn

Test Swagger link: Swagger UI (zignsec.com)

Prod Swagger link: Swagger UI (zignsec.com)

1.2 Request Body

{
{
    "locale": "En",
    "metadata": {
       "attributes_to_return": [
      "BASIC_USER_INFO",
      "EMAIL_ADDRESS"
    ],
        "min_registration_level": "BASIC",
        "user_info": {
            "country": "SE",
            "ssn": "195210131234"
        }
    },
     "redirect_failure": "https://www.espncricinfo.com/",
    "redirect_success": "https://zignsec.com/",
    "relay_state": "relaystate_V5",
    "webhook": "https://webhook.site/"
}
}

Parameter	Description	Required
`metadata`	See table below	Yes

Meta data parameters

`Parameter`	`Description`	`Required`
`locale`	Preferred Language to Use	No
`attributes_to_return`	[ BASIC_USER_INFO, EMAIL_ADDRESS, ALL_EMAIL_ADDRESSES, ALL_PHONE_NUMBERS, DATE_OF_BIRTH, AGE, PHOTO, ADDRESSES, SSN, REGISTRATION_LEVEL, RELYING_PARTY_USER_ID, INTEGRATOR_SPECIFIC_USER_ID, CUSTOM_IDENTIFIER ]
`min_registration_level`	[ BASIC, EXTENDED, PLUS ]	No
`country`	[ SE, NO, FI, DK ]	No
`ssn`	For country value “SE”, the “ssn” value must be the 12-digit format of the Swedish “personnummer” without spaces or hyphens, e.g. “195210131234”. For country value “NO”, the “ssn” value must be the 11-digit format of the Norwegian “personnummer” without spaces or hyphens, e.g. “13105212345”. For country value “FI”, the “ssn” value must be the 10-characters format of the Finnish “koodi”, with the hyphen before the last four control characters. The hyphen can be replaced with the letter A. e.g. “131052-308T” or “131052A308T”. For country value “DK”, the “ssn” value must be the 10-digit format of the Danish “personnummer” without spaces or hyphens, e.g. “1310521234”
`redirect_success`	URL to redirect the end-user to on success	No
`redirect_failure`	URL to redirect the end-user to on failure	No
`relay_state`	Optional Custom Parameter to be included in webhook calls
`webhook`	Webhook URL where your backend will receive session events	No

1.3 Response example

{
  "data": {
    "id": "2fb18009-5af5-44c7-90eb-eb1647465104",
    "result": {
      "authRef": "tzsRgNnyj27CidM2f22T7I1JXG12rNldQrywr6DY4N_ysjgt3vYhQ6oleCiI0Yb4"
    }
  }
}

1.4 Response Body Parameters

`id`	A unique session identifier.
`authRef`	authorization reference

2 .Identity Verification with Freja ID (QR)

2.1 Start session

POST to Zignsec URL:

Test Env: https://test-gateway.zignsec.com/core/api/sessions/identity_verification/freja_id_qr

Prod Env: https://gateway.zignsec.com/core/api/sessions/identity_verification/freja_id_qr

Test Swagger Link: Swagger UI (zignsec.com)

Prod Swagger Link: Swagger UI (zignsec.com)

2.2 Request Body

{
  "locale": "En",
  "metadata": {
    "attributes_to_return": [
      "BASIC_USER_INFO",
      "EMAIL_ADDRESS"
    ],
    "min_registration_level": "EXTENDED",
    "user_info": {
            "country": "SE",
            "ssn": "195210131234"
        }
  },
  "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"
}

Parameter	Description	Required
`metadata`	See Metadata parameters in section 1.2	Yes

2.3 Response example

{
    "data": {
        "id": "cbb33e45-79c6-44ea-ae9a-bfb4ceb725b6",
        "result": {
            "authRef": "YuxYG0SmmycndtS7m5JTtKzaXYI87xGIgiJCgr7bgAwXdTANYL_PRy1AwhmrKcXK",
            "qr": "iVBORw0KGgoAAAANSUhEUgAAAMgAAADICAIAAAAiOjnJAAAVlUlEQVR4Xu2d64+d1XXG83e1kYOABpWoBZFGVSIQkZpEoKIWiUqtaCz6AQFSJWq5MTc1BVJwaB0oFsQQYqraUCguCUWxCSQKTRxFJngI8Q1bIdjd5dA12+v3nmfW2u95mZnj/ej5YD+Xtfc7WSLHcznziX"
        }
    }
}

2.4 Response Body Parameters

`id`	A unique session identifier.
`authRef`	authorization reference
`qr`	string ( base64-encoded PNG)

3. Identity Verification with Freja ID (Phone)

3.1 Start session

POST to Zignsec URL:

Test Env: https://test-gateway.zignsec.com/core/api/sessions/identity_verification/freja_id_phone

Prod Env: https://gateway.zignsec.com/core/api/sessions/identity_verification/freja_id_phone

Test Swagger Link: Swagger UI (zignsec.com)

Prod Swagger Link: Swagger UI (zignsec.com)

3.2 Request Body

{
  "locale": "En",
  "metadata": {
    "attributes_to_return": [
      "BASIC_USER_INFO",
      "EMAIL_ADDRESS",
      "ALL_PHONE_NUMBERS"
    ],
    "min_registration_level": "EXTENDED",
    "user_info": "+46123456789"
  },
  "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"
}

Parameter	Description	Required
`metadata`	See Metadata parameters in section 1.2	Yes

3.3 Response Body

{
    "data": {
        "id": "7f751451-07dc-4543-ae69-79bc81d14bca",
        "result": {
            "authRef": "V6KkQx2ZUXtvCZYpfZ_7uGkpGUcZEhxyEIFJbztq6Y__4wM-l3kvPL1V960Hi6Rk"
        }
    }
}

3.4 Response Body Parameters

`id`	A unique session identifier.
`authRef`	authorization reference

4. Identity Verification with Freja ID (Email)

4.1 Start session

POST to Zignsec URL:

Test Env: https://test-gateway.zignsec.com/core/api/sessions/identity_verification/freja_id_email

Prod Env: https://gateway.zignsec.com/core/api/sessions/identity_verification/freja_id_email

Test Swagger Link: Swagger UI (zignsec.com)

Prod Swagger Link: Swagger UI (zignsec.com)

4.2 Request Body

{
  "locale": "En",
  "metadata": {
    "attributes_to_return": [
      "BASIC_USER_INFO",
      "EMAIL_ADDRESS"
    ],
    "min_registration_level": "EXTENDED",
    "user_info": "[email protected]"
  },
  "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"
}

Meta data parameters

`Parameter`	`Description`	`Required`
`user_info`	email
`metadata`	see metadata parameters description in section 1.2

4.3 Response Body

{
    "data": {
        "id": "d346c5c9-35cd-418f-b833-a8455e02542c",
        "result": {
            "authRef": "5E2nhXPdl86QJa-Fb78GKr76Sy7FUOoJMUNjIZ0WECaAEAE3sXoSVngk-xc-pnYj"
        }
    }
}

4.4 Response Body Parameters

`id`	A unique session identifier.
`authRef`	authorization reference

5. Get Results

You can get response in a GET request or in webhook.

GET to:

Test Env: https://test-gateway.zignsec.com/core/api/sessions/sessionid

Prod Env: https://gateway.zignsec.com/core/api/sessions/sessionid

Test Swagger Link: Swagger UI (zignsec.com)

Prod Swagger Link: Swagger UI (zignsec.com)

5.1 Get Results example

{
    "data": {
        "authRef": "FzikjR5DJh6KMq3Gfz-zfNPjS7vQnOv6B3nx9cSgCHtGpTR12i84Jdvma9Bk5Zmn",
        "requestedAttributes": {
            "basicUserInfo": {
                "name": "Nils",
                "surname": "Öberg"
            },
            "emailAddress": "[email protected]"
        },
        "signedIdentity": "eyJ4NXQiOiIyTFFJcklOT3p3V0FWRGhvWXlicVVjWFhtVnMiLCJhbGciOiJSUzI1NiJ9m
    }
}

5.2 Webhook Response

{
  "data": {
    "authRef": "FzikjR5DJh6KMq3Gfz-zfNPjS7vQnOv6B3nx9cSgCHtGpTR12i84Jdvma9Bk5Zmn",
    "requestedAttributes": {
      "basicUserInfo": {
        "name": "Nils",
        "surname": "Öberg"
      },
      "emailAddress": "[email protected]"
    },
    "signedIdentity": "eyJ4NXQiOiJhUnc5T0xuMkJoTTdoeG9jNDU4Y0lYSGZlenciLCJhbGciOiJSUzI1NiJ9.eyJzdGF0dXMiOiJBUFBST1ZFRCIsInVzZXJJbmZvVHlwZSI6IlNTTiIsInVzZXJJbmZvIjoie1wic3NuXCI6XCIxOTk0MTIyNjkyMDJcIixcImNvdW50cnlcIjpcIlNFXCJ9IiwidGltZXN0YW1wIjoxNjY1NTYyMzk4NzAwLCJtaW5SZWdpc3RyYXRpb25MZXZlbCI6IkJBU0lDIiwicmVxdWVzdGVkQXR0cmlidXRlcyI6eyJiYXNpY1VzZXJJbmZvIjp7Im5hbWUiOiJHYXJpbWEiLCJzdXJuYW1lIjoiVmVybWEifSwiZW1haWxBZGRyZXNzIjoiZ2FyaW1hdmVybWE0NTZAZ21haWwuY29tIn0sImF1dGhSZWYiOiJQTmNYRlBQVFVEQkpVVUV6TTRqUTM3YllBUUVQWUdzd3FGRlhxTEZIVUVDLWxfMnF6RlZ0REp3MHhEUjZMMkRuIn0.JgDvw6dQBMhdt280jS4dg-,
    "status": "APPROVED"
  },
  "event": "session_updated",
  "id": "44b8bd08-91ae-4abf-ab0a-56ca503c258d",
  "integration_id": "freja_eid",
  "relay_state": "relaystate_V5"
}

Our APIs

1 . Identity Verification with Freja ID (SSN)

1.1 Start session

1.2 Request Body

1.3 Response example

1.4 Response Body Parameters

2 .Identity Verification with Freja ID (QR)

2.1 Start session

2.2 Request Body

2.3 Response example

2.4 Response Body Parameters

3. Identity Verification with Freja ID (Phone)

3.1 Start session

3.2 Request Body

3.3 Response Body

3.4 Response Body Parameters

4. Identity Verification with Freja ID (Email)

4. Identity Verification with Freja ID (Email)

4.1 Start session

4.2 Request Body

4.3 Response Body

4.4 Response Body Parameters

5. Get Results

5. Get Results

5.1 Get Results example

5.2 Webhook Response