Initiate Authentication Session Creates an authentication session using the selected authentication provider.

This endpoint is obsolete when using provider type BankIdSwedenAuthenticationProvider where Initiate Authentication Session Secure Start endpoint should be used instead to support the mandatory secure start for BankID.

POST /authentication/person/{countryCode}/{governmentId}

Request Parameters

PropertyTypeDescription
countrycode
required
string(2)The two-letter country code in ISO 3166 format.

Examples: "SE"
governmentId
required
string(12)For Sweden: The customer's 12 digit government ID, without a dash.

Examples: "198901157993"
providerType
required
stringThe name of the provider to use for authenticating. For a list of available providers see the "GET" /authentication/providers endpoint.

Examples: "BankIdSwedenAuthenticationProvider"
authenticationMethods
required
array of stringA list of allowed authentication methods for this authentication session.

Examples:

["MobileBankId"]
clientIPAddress
required
stringThis enables BankID to "reconnect" a customer to an active session if the connection to the session is lost.

Examples: "10.123.123.123"

Response Parameters

PropertyTypeDescription
authenticationSessionId
conditional
guidUnique identifier for the created authentication session.

Conditions:

> This parameter is not returned in error situations.

Examples: "eb85023a-ff9d-4537-95d0-f9d045b3e872"
status
required
statusAPI Operation status.
Language