Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 17 Next »

The Common Identity API helps authenticate private resources or sign documents digitally.

Base URL

https://prod-common-identity-api.azurewebsites.net/

Connect thru .NET SDK (optional)

If you have a .NET application for your business, you can leverage the SDK experience using the nuget command below. SDK will handle the Identity API Authentication part out of the box.

Install-Package LinkMobility.IdentityApi.Client -version 1.0.4 -Source https://www.myget.org/F/linknorway/api/v3/index.json

This feed is not public, hence you would need to configure your nuget.config page as described here.

Identity API Authentication

In order to authenticate against Identity API you will need Basic Authentication.

The credentials you will need are the same as you have to provide for Next Portal.

Basic authentication is a very simple authentication scheme that is built into the HTTP protocol. The client sends HTTP requests with the Authorization header that contains the Basic word followed by a space and a base64-encoded username:password string. For example, a header containing the demo / p@55w0rd credentials would be encoded as:

Authorization: Basic ZGVtbzpwQDU1dzByZA==

Supported workflows

1. Authentication

Workflow Diagram

API Endpoints

1. [POST] /api/authentications (PostAuthenticationAsync)

Creates a new authentication. (Step 2)

If succeeds, returns authenticationId as a GUID in the location header. (Step 3)

Payload parameter name

Description

partnerId

Desired NEXT PartnerId

method

Authentication method to use:

nbid, nbid-mobil Norwegian BankID / Mobile

sbid, sbid-mobil Swedish BankID / Mobile

identity

Identity (personal number / social security number) to verify against

callbackUrl

Your url that user will be redirected back to. (Step 8)

AuthenticationId value will be appended as a query string parameter with id name when Identity API calls you back.

customProperties

An optional <string, string> Dictionary that your custom properties are stored on the authentication.

2. [GET] /bankid/{partnerId}/{authenticationId}/authenticate (GetBankIdAuthenticationUrlAsync [Redirects user to the corresponding service provider])

End user should be opening this page upon a new authentication is created and authenticationId is claimed. (Step 4)

Upon opening this page, end user will be redirected to the corresponding service provider’s authentication page. (Step 5)

Route parameter name

Description

authenticationId

Location header value claimed after succesful [POST] /api/authentications request

partnerId

Desired NEXT PartnerId

3. [GET] /api/authentications/{partnerId}/{authenticationId} (GetAuthenticationAsync])

It could be called anytime once an authentication is created. The best case for you business to call this endpoint would be the place where you check whether the user authentication is complete or not. (Step 9)

Route parameter name

Description

authenticationId

Location header value claimed after succesful [POST] /api/authentications request

partnerId

Desired NEXT PartnerId

Swagger Documentation

Below you will find a ready-to-use Swagger collection file for those 3 endpoints above.

2. Signing

todo:add api endpoints along with explanations

  • No labels