Dokumentasjon

Authentication service

The authentication service give access to the Signant ID portal for identification by means of the underlying trusted service providers supported by Signant. This API documentation describes the authentication web services functions in order to successfully create and validate authentication requests.

Web service endpoint

Web service description endpoint in the testing environment T3: https://test3.signant.no/Auth/AuthService.svc?wsdl

The service operates in two layers; the WS layer for initializing and validating the authentication requests, and a web layer where the user interacts with the service.

The integrator communicates with the «Signant authentication service» by a secure WS connection. The integrator must make sure the integrator credentials (DistributorID, AccessCode, TrackingID) are kept safe and measures should be made to avoid disclosing this data to any other parties.

The authentication sequence work flow

The following sequence diagram illustrates the work flow of an authentication request.

Authentication steps

  1. User initiates an authentication request.
  2. Integrator initializes new Authentication.
  3. URL to authentication is returned.
  4. User is redirected to authentication page.
  5. After successful authentication the user is redirected back to Integrator web.
  6. The redirect back (step 5.) should trigger a call to the «authentication status check» function call from the Integrator system.
  7. Signant WS returns authentication status.
  8. If authentication was successful the user is logged in to the Integrator web.

Code sample for InitAuth

Web service functions

NameDescription
InitAuthFor creating a new authentication session.
GetAuthStatusReturns the status for the authentication session.

InitAuth

Used to create a new authentication session. Sample request.

InitAuth parameters

NameTypeDescriptionRequired
DistributorIDStringFor authentication (Provided by Signant)Yes
AccessCodeStringFor authentication (Provided by Signant)Yes
AuthOptionsAuthOptionsOptions for the Auth sessionYes

InitAuth AuthOptions

NameTypeDescriptionRequired
AuthTypesAuthType[]Array of authentication types to be made available to the user (1)Yes
NextUrlStringRedirect Url after successful authentication (2)Yes
CancelUrlStringRedirect Url after cancelled or failed authenticationYes
ReturnSSNBoolReturn SSN after authentication (3)Yes

1) See AuthOptions-AuthTypes for a list of available authentication types.
2) RequestId will be added to the querystring before redirect: https://abc/auth will become https://abc/auth?requestid=xyz.
3) Access to norwegian ssn require legal basis.

InitAuth output: InitAuthResponse

NameTypeDescription
StatusIDIntStatus code of the authentication session (1)
StatusTextStringStatus of the authentication session
AuthenticationUrlStringUnique Url to the authentication
RequestIDStringRequest Id for this authentication session
TrackingIDStringTracking Id for this authentication session

1) See Authentication Status codes for a possible values.

GetAuthStatus

Call this function to receive authentication session status. See sample request.

GetAuthStatus parameters

NameTypeDescriptionRequired
DistributorIDStringProvided by SignantYes
AccessCodeStringProvided by SignantYes
RequestIDStringRequestID from InitAuthYes
TrackingIDStringTrackingID from InitAuthYes

GetAuthStatus output – GetAuthStatusResponse

NameTypeDescription
StatusIDIntStatus code of the authentication session (1)
StatusTextStringStatus of the authentication session
StateStringState of the authentication session (2)
TrackingIDStringEcho of incoming parameter: TrackingID
UserUniqueIDStringUnique id for this person
UserFullNameStringFull name of authenticated person
UserFirstNameStringFirst name of authenticated person
UserLastNameStringLast name for authenticated person
UserDOBStringDate of birth of authenticated person DD.MM.YYYY
UserSSNStringSocial security number of user (3)

1. See Authentication – Status codes values
2. See Authentication – Session states for values.
3. Account requires proof of permission from The Norwegian Data Protection Authority (Datatilsynet)

AuthOptions – AuthTypes

AuthTypes values:

AuthTypeDescription
NO_BankIDNorwegian BankID
NO_BankID_MobileNorwegian BankID, deprecated
NO_BuyPassNorwegian Buypass, read more at www.buypass.no

Authentication Status codes

Authentication status code can have the following values:

StatusIDDescription
0OK
2001Wrong DistributorID and/or AccessCode
2002Invalid value(s) in options object – see status StatusText for details
4000General error – see StatusText for details
4001Invalid or expired RequestID
4002Wrong RequestID or TrackingID
4003Session expired

Authentication Session state

Authentication session can have the following states

StateDescription
N/ASession does not exists
NOT_STARTEDSession create but not started
STARTEDAuthentication prossess started
INITIALIZEDAuthentication provider handshake initialized
PROCESSINGAuthentication in process
CANCELEDAuthentication canceled by user (1)
FAILEDAuthentication failed, see StatusText value for more details
EXPIREDSession expired
COMPLETEDAuthentication completed successfully

1. Cancelled sessions cannot be reused, new session must be requested using InitAuth.

Sample requests

The sample requests and responses have been shortened down for readability and will therefore not work «as is», you will have to replace all required fields with correct data before trying to send a request to the service.

InitAuth sample request – Kopier fra Visual til Code

The request above will return the following result – Kopier fra Visual til Code

GetAuthStatus sample request – Kopier fra Visual til Code

The request above will return the following result – Kopier fra Visual til Code