Skip to main content

Authentication

The POST /freja/auth endpoint is used to start an authentication using Freja eID.

POST /v3/freja/auth
Authorization: Basic ${ base64(accountId + ':' + secretKey) }
{
"ssn": "YYYYMMDDXXXX",
"minRegistrationLevel": "EXTENDED",
"orgNumber": "559000-0948",
"callbackUrl": "https://...",
"refId": "12398698"
}
ParameterRequiredDescription
ssnYesThe Swedish personal identification number of the user to authenticate.
minRegistrationLevelNoCan be one of: 'EXTENDED' or 'PLUS'. The minimum Freja eID registration level that the end user needs to have to be able to authenticate the request. If excluded, the request will default to EXTENDED.
refIdNoReference ID which will be included in a Collect and in the callback.
callbackUrlNoSee Callback.
orgNumberNoOrganizational number, 11 digits. Used to perform checks for company signatory. To enable this feature, contact IDkollen.

IDkollen will respond with HTTP status 201 for successful request, or 4xx/5xx on errors. For more information about errors, please see the Errors section.

HTTP/2.0 201 Created
{
"id": "1668b9da-bff1-4dfc-ad48-60507b5a8d12",
"refId": "12398698",
"status": "PENDING"
}
PropertyDescription
idAuthentication id, used to cancel or get the status of this authentication request.
refIdThe refId given in the request, if any.