post https://example.com/authentication/person//
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
| Property | Type | Description |
|---|---|---|
countrycoderequired | string(2) | The two-letter country code in ISO 3166 format. Examples: "SE" |
governmentIdrequired | string(12) | For Sweden: The customer's 12 digit government ID, without a dash. Examples: "198901157993" |
providerTyperequired | string | The name of the provider to use for authenticating. For a list of available providers see the "GET" /authentication/providers endpoint. Examples: "BankIdSwedenAuthenticationProvider" |
authenticationMethodsrequired | array of string | A list of allowed authentication methods for this authentication session. Examples: ["MobileBankId"] |
clientIPAddressrequired | string | This 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
| Property | Type | Description |
|---|---|---|
authenticationSessionIdconditional | guid | Unique identifier for the created authentication session. Conditions: > This parameter is not returned in error situations. Examples: "eb85023a-ff9d-4537-95d0-f9d045b3e872" |
statusrequired | status | API Operation status. |