Skip to main content
API docs by Redocly

dmss-authentication-service (1.1.7-5-g233c55d.dirty)

Download OpenAPI specification:Download

TrustLynx: info@trustlynx.com URL: https://trustlynx.com

web-eid-auth-controller

web-eid-auth-controller : authenticate

Web-Eid authentication status poll request

path Parameters
session
required
string
Example: 5fd1bd86-b6ca-46fa-8adf-c457c0dc7350

Authentication session code from authentication start request response

Request Body schema: application/json
required
algorithm
required
string

The algorithm used to produce the authentication signature

signature
required
string

web-eid plugin generated signature (The base64-encoded signature of the token)

unverifiedCertificate
required
string

The public key contained in this certificate should be used to verify the signature

format
string

The type identifier and version of the token format (current value: web-eid:1.0)

Responses

Request samples

Content type
application/json
{
  • "unverifiedCertificate": "string",
  • "signature": "string",
  • "algorithm": "string",
  • "format": "string"
}

Response samples

Content type
application/json
{
  • "errorMessage": "ok",
  • "firstName": "QUALIFIED OK1",
  • "lastName": "TESTNUMBER",
  • "personalCode": "30303039914",
  • "country": "EE",
  • "documentNumber": "PNOEE-30303039914-5QSV-Q",
  • "age": 118,
  • "dateOfBirth": "1903-03-03",
  • "phoneNumber": "12344321",
  • "email": "test@test.com",
  • "result": "AUTHENTICATION_STARTED"
}

web-eid-auth-controller : challenge

Web-Eid authentication start request

Responses

Response samples

Content type
application/json
{
  • "sessionCode": "8460",
  • "nonce": "string"
}

smart-id-auth-controller

smart-id-auth-controller : authenticate

Smart-ID authentication start request

Request Body schema: application/json
required
personalCode
required
string
Example: "30303039914"

Person personal code

country
string
Enum: "EE" "LT" "LV"

Person origin identity 2 character ISO 3166-1 alpha-2 country code (valid values: EE, LV, LT)

displayText
string
Example: "This is additional Text"

Display text shown on mobile application up to 60 characters

displayTextLong
string
Example: "This is additional Text LOOONG"

Display text shown on mobile application up to 200 characters, used by newer versions of Smart-ID mobile applications. If value not specified use "displayText" value

Responses

Request samples

Content type
application/json
{
  • "country": "EE",
  • "displayText": "This is additional Text",
  • "displayTextLong": "This is additional Text LOOONG",
  • "personalCode": "30303039914"
}

Response samples

Content type
application/json
{
  • "errorMessage": "ok",
  • "firstName": "null",
  • "lastName": "null",
  • "personalCode": "null",
  • "sessionCode": "5fd1bd86-b6ca-46fa-8adf-c457c0dc7350",
  • "verificationCode": "8460",
  • "phoneNumber": "null",
  • "result": "AUTHENTICATION_STARTED"
}

smart-id-auth-controller : getAuthenticationSessionStatus

Smart-ID authentication status poll request

path Parameters
session
required
string
Example: 5fd1bd86-b6ca-46fa-8adf-c457c0dc7350

Authentication session code from authentication start request response

Responses

Response samples

Content type
application/json
{
  • "errorMessage": "ok",
  • "firstName": "QUALIFIED OK1",
  • "lastName": "TESTNUMBER",
  • "personalCode": "30303039914",
  • "country": "EE",
  • "documentNumber": "PNOEE-30303039914-5QSV-Q",
  • "age": 118,
  • "dateOfBirth": "1903-03-03",
  • "phoneNumber": "12344321",
  • "email": "test@test.com",
  • "result": "AUTHENTICATION_STARTED"
}

mobile-id-auth-controller

mobile-id-auth-controller : authenticate

Mobile-ID authentication start request

Request Body schema: application/json
required
personalCode
required
string
Example: "30303039914"

Person personal code

phoneNumber
required
string
Example: "+37112344321"

Person mobile phone

language
string
Example: "EE"

Person origin identity

displayText
string
Example: "This is a Text"

Display text shown on mobile application up to 60 characters

Responses

Request samples

Content type
application/json
{
  • "phoneNumber": "+37112344321",
  • "personalCode": "30303039914",
  • "language": "EE",
  • "displayText": "This is a Text"
}

Response samples

Content type
application/json
{
  • "errorMessage": "ok",
  • "firstName": "null",
  • "lastName": "null",
  • "personalCode": "null",
  • "sessionCode": "5fd1bd86-b6ca-46fa-8adf-c457c0dc7350",
  • "verificationCode": "8460",
  • "phoneNumber": "null",
  • "result": "AUTHENTICATION_STARTED"
}

mobile-id-auth-controller : getAuthenticationSessionStatus

Mobile-ID authentication status poll request

path Parameters
session
required
string
Example: 5fd1bd86-b6ca-46fa-8adf-c457c0dc7350

Authentication session code from authentication start request response

Responses

Response samples

Content type
application/json
{
  • "errorMessage": "ok",
  • "firstName": "QUALIFIED OK1",
  • "lastName": "TESTNUMBER",
  • "personalCode": "30303039914",
  • "country": "EE",
  • "documentNumber": "PNOEE-30303039914-5QSV-Q",
  • "age": 118,
  • "dateOfBirth": "1903-03-03",
  • "phoneNumber": "12344321",
  • "email": "test@test.com",
  • "result": "AUTHENTICATION_STARTED"
}

evro-trust-controller

evro-trust-controller : authenticate

Evro Trust authentication start request

Request Body schema: application/json
required
country
string
Enum: "EE" "LT" "LV"

Person origin identity 2 character ISO 3166-1 alpha-2 country code (valid values: EE, LV, LT)

identificationNumber
string
Example: "30303039914"

Person personal code

email
string
Example: "test@test.com"

Person e-mail

phone
string
Example: "+37112344321"

Person phone number

Responses

Request samples

Content type
application/json
{
  • "country": "EE",
  • "identificationNumber": "30303039914",
  • "email": "test@test.com",
  • "phone": "+37112344321"
}

Response samples

Content type
application/json
{
  • "errorMessage": "ok",
  • "firstName": "null",
  • "lastName": "null",
  • "personalCode": "null",
  • "sessionCode": "5fd1bd86-b6ca-46fa-8adf-c457c0dc7350",
  • "verificationCode": "8460",
  • "phoneNumber": "null",
  • "result": "AUTHENTICATION_STARTED"
}

evro-trust-controller : getAuthenticationSessionStatus

Evro Trust authentication status poll request

path Parameters
session
required
string
Example: 5fd1bd86-b6ca-46fa-8adf-c457c0dc7350

Authentication session code from authentication start request response

Responses

Response samples

Content type
application/json
{
  • "errorMessage": "ok",
  • "firstName": "QUALIFIED OK1",
  • "lastName": "TESTNUMBER",
  • "personalCode": "30303039914",
  • "country": "EE",
  • "documentNumber": "PNOEE-30303039914-5QSV-Q",
  • "age": 118,
  • "dateOfBirth": "1903-03-03",
  • "phoneNumber": "12344321",
  • "email": "test@test.com",
  • "result": "AUTHENTICATION_STARTED"
}

certificate-controller

certificate-controller : authenticate

Request Body schema: application/json
required
certInHex
required
string

x509 SSL certificate in the HEX format

country
string
Enum: "EE" "LT" "LV"

Person origin identity 2 character ISO 3166-1 alpha-2 country code (valid values: EE, LV, LT)

Responses

Request samples

Content type
application/json
{
  • "certInHex": "string",
  • "country": "EE"
}

Response samples

Content type
application/json
{
  • "errorMessage": "ok",
  • "firstName": "QUALIFIED OK1",
  • "lastName": "TESTNUMBER",
  • "personalCode": "30303039914",
  • "country": "EE",
  • "documentNumber": "PNOEE-30303039914-5QSV-Q",
  • "age": 118,
  • "dateOfBirth": "1903-03-03",
  • "phoneNumber": "12344321",
  • "email": "test@test.com",
  • "result": "AUTHENTICATION_STARTED"
}

lvrtc-auth-controller

lvrtc-auth-controller : startAuthentication

query Parameters
return_url
string
Default: ""

Redirect URI to the Service provider's application.

locale
string
Default: ""
Example: locale=lv

Specifies a list of languages ordered by preference

acr_values
string
Default: ""
Example: acr_values=urn:eparaksts:authentication:flow:mobileid

Defines conditions for authenticating the end-user (minimum levels or specific flows) who must authorize the access.

state
string
Default: ""

We recommend using this parameter to safeguard against CSRF attacks. To do this, the Service provider’s application must include a random value in this parameter, store it in the HTTP session and verify it when the Authorization Response message is received.

Responses

getAuthenticationResult

query Parameters
code
required
string
Example: code=a0daddc2e35c44cde87555c332d5918e39eca2f5262a121d053397bf140798d2

The authorization code received in the previous authorization response.

return_url
string
Default: ""

Redirect URI to the Service provider's application.

Responses

Response samples

Content type
application/json
{
  • "errorMessage": "ok",
  • "firstName": "QUALIFIED OK1",
  • "lastName": "TESTNUMBER",
  • "personalCode": "30303039914",
  • "country": "EE",
  • "documentNumber": "PNOEE-30303039914-5QSV-Q",
  • "age": 118,
  • "dateOfBirth": "1903-03-03",
  • "phoneNumber": "12344321",
  • "email": "test@test.com",
  • "result": "AUTHENTICATION_STARTED"
}