Download OpenAPI specification:Download
Web-Eid authentication status poll request
| session required | string Example: 5fd1bd86-b6ca-46fa-8adf-c457c0dc7350 Authentication session code from authentication start request response |
| 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) |
{- "unverifiedCertificate": "string",
- "signature": "string",
- "algorithm": "string",
- "format": "string"
}{- "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 authentication status poll request
| session required | string Example: 5fd1bd86-b6ca-46fa-8adf-c457c0dc7350 Authentication session code from authentication start request response |
| origin required | string |
| 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) |
{- "unverifiedCertificate": "string",
- "signature": "string",
- "algorithm": "string",
- "format": "string"
}{- "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"
}SMS Authentication request for sending SMS with code
| country required | string Example: "LV" ISO country code "+" |
| phoneNumber required | string Example: "37112345678" Phone number with country code without "+" |
{- "country": "LV",
- "phoneNumber": "37112345678"
}{- "errorMessage": "ok",
- "session": "string",
- "expiresIn": 0,
- "result": "string"
}Send OTP request for server-side verification
| otp required | string Example: "123456" Received OTP in SMS |
| sessionCode required | string Session code generated after sending SMS |
{- "otp": "123456",
- "sessionCode": "string"
}{- "errorMessage": "ok",
- "personalCode": "string",
- "country": "string",
- "result": "string"
}Smart-ID authentication start request
| personalCode required | string Example: "30303039914" Person personal code |
| country | string Enum: "EE" "LT" "LV" "EU" 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 |
| synch | boolean Example: "false" Use synchronous request to Smart-ID or not, default is asynchronous |
{- "country": "EE",
- "displayText": "This is additional Text",
- "displayTextLong": "This is additional Text LOOONG",
- "synch": false,
- "personalCode": "30303039914"
}{- "errorMessage": "ok",
- "firstName": "null",
- "lastName": "null",
- "personalCode": "null",
- "sessionCode": "5fd1bd86-b6ca-46fa-8adf-c457c0dc7350",
- "verificationCode": "8460",
- "phoneNumber": "null",
- "result": "AUTHENTICATION_STARTED"
}Smart-ID authentication status poll request
| session required | string Example: 5fd1bd86-b6ca-46fa-8adf-c457c0dc7350 Authentication session code from authentication start request response |
{- "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"
}| src | string |
| time | string |
| personCode | string |
| firstName | string |
| lastName | string |
| signature | string |
| type | string |
object | |
| algorithm | string |
{- "src": "string",
- "time": "string",
- "personCode": "string",
- "firstName": "string",
- "lastName": "string",
- "signature": "string",
- "type": "string",
- "publicKey": {
- "encoded": "string",
- "format": "string",
- "algorithm": "string"
}, - "algorithm": "string"
}| otpCode required | string Example: "00112200" |
| provider required | string Value: "EUROCERT" Example: "EUROCERT" |
| sessionCode required | string Example: "1a074cc1-13ac-476b-95a9-a81f8a64465f" |
{- "sessionCode": "1a074cc1-13ac-476b-95a9-a81f8a64465f",
- "otpCode": "00112200",
- "provider": "EUROCERT"
}{- "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"
}| login required | string Example: "trustlunx@eurocert.pl" |
| password required | string |
| provider required | string Value: "EUROCERT" Example: "EUROCERT" |
{- "login": "trustlunx@eurocert.pl",
- "password": "string",
- "provider": "EUROCERT"
}{- "errorMessage": "ok",
- "firstName": "null",
- "lastName": "null",
- "personalCode": "null",
- "sessionCode": "5fd1bd86-b6ca-46fa-8adf-c457c0dc7350",
- "verificationCode": "8460",
- "phoneNumber": "null",
- "result": "AUTHENTICATION_STARTED"
}Mobile-ID authentication start request
| 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 |
{- "phoneNumber": "+37112344321",
- "personalCode": "30303039914",
- "language": "EE",
- "displayText": "This is a Text"
}{- "errorMessage": "ok",
- "firstName": "null",
- "lastName": "null",
- "personalCode": "null",
- "sessionCode": "5fd1bd86-b6ca-46fa-8adf-c457c0dc7350",
- "verificationCode": "8460",
- "phoneNumber": "null",
- "result": "AUTHENTICATION_STARTED"
}Mobile-ID authentication status poll request
| session required | string Example: 5fd1bd86-b6ca-46fa-8adf-c457c0dc7350 Authentication session code from authentication start request response |
{- "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 Banking API authentication start request
| personalCode required | string Example: "390101-00001" Person personal code |
| displayText | string Example: "This is additional Text" Message displayed to the user to prompt them to authorize. Up to 300 characters of text. |
| forcePin | boolean Example: "false" Request to use PIN code, biometrics not allowed. |
{- "displayText": "This is additional Text",
- "forcePin": false,
- "personalCode": "390101-00001"
}{- "errorMessage": "ok",
- "firstName": "null",
- "lastName": "null",
- "personalCode": "null",
- "sessionCode": "5fd1bd86-b6ca-46fa-8adf-c457c0dc7350",
- "verificationCode": "8460",
- "phoneNumber": "null",
- "result": "AUTHENTICATION_STARTED"
}LvRtc Banking API authentication status poll request
| session required | string Example: 5fd1bd86-b6ca-46fa-8adf-c457c0dc7350 Authentication session code from authentication start request response |
{- "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"
}"string"{- "personalNumber": "string",
- "surname": "string",
- "givenNames": "string",
- "country": "string",
- "stateContext": {
- "code": "string",
- "execution": "string",
- "tabId": "string",
- "clientId": "string"
}, - "execution": "string",
- "tabId": "string",
- "clientId": "string",
- "valid": true,
- "errorDescription": "string"
}{- "personalNumber": "string",
- "surname": "string",
- "givenNames": "string",
- "country": "string",
- "stateContext": {
- "code": "string",
- "execution": "string",
- "tabId": "string",
- "clientId": "string"
}, - "execution": "string",
- "tabId": "string",
- "clientId": "string",
- "valid": true,
- "errorDescription": "string"
}| code | string |
| execution | string |
| tabId | string |
| clientId | string |
{- "documentId": "string",
- "sessionId": "string",
- "verifyBaseUrl": "string",
- "responseUrl": "string",
- "stateSessionId": "string",
- "redirectUrl": "string"
}Evro Trust authentication start request
| country | string Enum: "EE" "LT" "LV" "EU" Person origin identity 2 character ISO 3166-1 alpha-2 country code (valid values: EE, LV, LT) |
| identificationNumber | string Example: "30303039914" Person personal code |
string Example: "test@test.com" Person e-mail | |
| phone | string Example: "+37112344321" Person phone number |
{- "country": "EE",
- "identificationNumber": "30303039914",
- "email": "test@test.com",
- "phone": "+37112344321"
}{- "errorMessage": "ok",
- "firstName": "null",
- "lastName": "null",
- "personalCode": "null",
- "sessionCode": "5fd1bd86-b6ca-46fa-8adf-c457c0dc7350",
- "verificationCode": "8460",
- "phoneNumber": "null",
- "result": "AUTHENTICATION_STARTED"
}Evro Trust authentication status poll request
| session required | string Example: 5fd1bd86-b6ca-46fa-8adf-c457c0dc7350 Authentication session code from authentication start request response |
{- "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"
}| certInHex required | string x509 SSL certificate in the HEX format |
| country | string Enum: "EE" "LT" "LV" "EU" Person origin identity 2 character ISO 3166-1 alpha-2 country code (valid values: EE, LV, LT) |
{- "certInHex": "string",
- "country": "EE"
}{- "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"
}| vkService | string |
| vkVersion | string |
| vkUser | string |
| vkDateTime | string |
| vkSndId | string |
| vkRecId | string |
| vkUserName | string |
| vkUserId | string |
| vkCountry | string |
| vkOther | string |
| vkToken | string |
| vkRid | string |
| vkMac | string |
| vkEncoding | string |
| vkLang | string |
object | |
| algorithm | string |
{- "vkService": "string",
- "vkVersion": "string",
- "vkUser": "string",
- "vkDateTime": "string",
- "vkSndId": "string",
- "vkRecId": "string",
- "vkUserName": "string",
- "vkUserId": "string",
- "vkCountry": "string",
- "vkOther": "string",
- "vkToken": "string",
- "vkRid": "string",
- "vkMac": "string",
- "vkEncoding": "string",
- "vkLang": "string",
- "publicKey": {
- "encoded": "string",
- "format": "string",
- "algorithm": "string"
}, - "algorithm": "string"
}| provider required | string Oauth2 provider, current supported: zealid, lvrtc, asseco |
| redirect_uri | string Redirect URI to the Service provider's application. |
| state | string 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. |
| provider required | string |
| code required | string Example: code=a0daddc2e35c44cde87555c332d5918e39eca2f5262a121d053397bf140798d2 The authorization code received in the previous authorization response. |
{- "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"
}| 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. |
| 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. |
{- "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"
}