The Common Identity API helps authenticate against 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)
If succeeds, returns authenticationId as a GUID in the location header. (Step 3)
Payload property 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 as shown in step 8.. (Step 8) AuthenticationId value will be appended as a query string parameter with |
| An optional |
2. [GET] /bankid/{partnerId}/{authenticationId}/authenticate (GetBankIdAuthenticationUrlAsync
...
)
End user should be opening this page upon a new authentication is created and authenticationId is claimed. (Step 4)
...
)
| Info |
|---|
Upon opening this page, end user will be redirected to the corresponding service provider’s authentication page. (Step 5) |
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 your business to call this endpoint would be the place where you verify whether the user authentication is complete or not. You can easily understand it by checking the success response property value. true means the authentication workflow is completed successfully. (Step 9) (Step 9)
Route parameter name | Description |
|---|---|
| Location header value claimed after succesful [POST] /api/authentications request |
| Desired NEXT PartnerId |
2. Signing
...
Workflow Diagram
...
API Endpoints
1. [POST] /api/signing (PostSigningAsync)
Creates a new signing. (Step 2)
If succeeds, returns signingId as a GUID in the location header. (Step 3)
Payload parameter name | Description |
|---|---|
| Desired NEXT PartnerId |
| Signing method to use:
|
|
|
|
|
| National Id for user allowed to sign (social security number). Leave empty if any user can sign. |
| Phone number for user allowed to sign. Leave empty if any user can sign. |
| Your url that user will be redirected back to. (Step 8) SigningId value will be appended as a query string parameter with |
2. [GET] /bankid/{partnerId}/{signingId}/sign (GetBankIdSigningUrlAsync)
End user should be opening this page upon a new signing is created and signingId is claimed. (Step 4)
| Info |
|---|
Upon opening this page, end user will be redirected to the corresponding service provider’s signing page. (Step 5) |
3. [GET] /api/signing/{partnerId}/{signingId} (GetSigningAsync)
It could be called anytime once a signing is created. The best case for your business to call this endpoint would be the place where you verify whether the user signing is complete or not. You can easily understand it by checking the success response property value. true means the signing worflow is completed successfully. (Step 9)
4. [GET] /api/signing/{partnerId}/document/{documentId} (GetDocumentAsync)
Optionally you may want to see the content for the document as Base64 encoded string. The documentId route parameter can be found in the response of [GET] /api/signing/{partnerId}/{signingId} method.
Swagger Documentations
Below you will find ready-to-use Swagger collection files for those 7 endpoints above grouped by workflow.
| View file | ||
|---|---|---|
|
| View file | ||
|---|---|---|
|
| Note |
|---|
Callbacks are executed from Identity API servers towards your URLs provided in [POST] /api/authentications or [POST] /api/signing request payloads. If the server behind your 23.97.163.47, 23.97.163.156, 23.97.163.227, 23.97.163.3, 40.115.63.9, 40.115.63.88, 13.93.43.47, 40.115.63.31, 40.115.63.94, 20.238.219.90, 20.238.220.168, 20.238.221.115, 20.238.221.130, 20.238.222.82, 20.238.222.87, 13.69.68.26 |