The Common Identity API helps authenticate private resources or sign documents digitally.
| Table of Contents |
|---|
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.
...
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.
...
| Code Block |
|---|
Authorization: Basic ZGVtbzpwQDU1dzByZA== |
Supported workflows
1. Authentication
Workflow Diagram
...
API Endpoints
1. [POST] /api/authentications (PostAuthenticationAsync)
Creates a new authentication. (Step 2)
...
Payload parameter name | Description |
|---|---|
| Desired NEXT PartnerId |
| Authentication method to use:
|
| Identity (personal number / social security number) to verify against |
| Your url that user will be redirected back to. (Step 8) AuthenticationId value will be appended as a query string parameter with |
| An optional |
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)
...
Route parameter name | Description |
|---|---|
| Location header value claimed after succesful [POST] /api/authentications request |
| 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 |
|---|---|
| Location header value claimed after succesful [POST] /api/authentications request |
| Desired NEXT PartnerId |
Swagger Documentation
Below you will find a ready-to-use Swagger collection file for those 3 endpoints above.
| View file | ||
|---|---|---|
|
2. Signing
todo:add api endpoints along with explanations
...