Authentication

The POST /v3/bankid-no/auth endpoint is used to start an authentication using BankID (NO).

POST /v3/bankid-no/auth
Authorization: Basic ${ base64(accountId + ':' + secretKey) }

{
    "requestSsn": false,
    "refId": "12398698"
}

Parameter	Required	Description
requestSsn	No	If set, will request the SSN of the authenticated user. The functionality needs to be enabled for your company. Contact support to enable requestSsn.
refId	No	Reference ID which will be included in a Collect and in the redirect.

Response:

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",
  "url": "https://..."
}

Property	Description
id	Authentication id, used to cancel or get the status of this authentication request.
refId	The refId given in the request, if any.
url	The URL where the end user can identify themselves.

Code redirect:

Once the end user has authenticated, they will be redirected to the redirect URL provided to IDkollen by you, including the very same "id" as a request parameter that can be used in the Collect step. If the parameter "refId" was used in the request, it will also be included as a request parameter.

https://your.redirect.url/?id=1668b9da-bff1-4dfc-ad48-60507b5a8d12&refId=12398698