eID: Smart-ID

Smart-ID – The smart way to identify yourself

Smart-ID is currently being used in three countries: Estonia, Latvia and Lithuania. If you live here or have business here and would like to register a Smart-ID account to get easy access to e-services, here are your options.

If you are not a resident of Baltic countries and do not have a local national ID-number, then:

In Lithuania, non-residents (people without a Lithuanian national ID-number) can apply for Smart-ID Basic. They should visit a Medicinos Bankas bank office with their passport or ID-card.
In Estonia and Latvia, currently Smart-ID is currently limited to people with Estonian or Latvian national ID-number.

If you are a resident, you’ll have your residence permit card which enables you to register your Smart-ID account just as you would if you were a citizen. Just follow the instructions meant for ID-card use! This also applies to Estonian e-residents.

API Calls

Start: POST to https://env.zignsec.com/v3/eid/smartid/auth

Result: GET from https://env.zignsec.com/v3/eid/smartid/sessionid

where env is api or test sessionid is the session identifier retrieved from the setup call, named id in the response.

Parameter	Description	Required
`countryCode`	Country code	Yes
`identifierType`	Used to set type of `identifier`. Options are: PersonalNumber, PassportNumber, NationalIdentityCardNumber	Yes
`identifier`	Person identifier. Type determined by `identifierType`	Yes
`webhook`	A URL where success/error results will automatically be POST:ed. During test you try https://webhook.site/ for free web hook URLs.	No

1.2 Request example

{
	"countryCode": "EE",
	"identifierType": "PersonalNumber",
	"identifier": "28611217522",
	"webhook": "https://webhook.site/0190cc7d-024b-41e9-bed8-2bf0989111a7"
}

1.3 Response example

{
    "id": "882cf870-d83e-4734-84c6-8e3263c422cd",
    "errors": []
}

1.4 Response parameters

Parameter	Description
`id`	Session ID. Can be used to retrieve session result.
`errors`	A JSON array of error conditions, see error handling.

2. Get session result

GET https://env.zignsec.com/v3/eid/smartid/sessionid

2.1 Response parameters

Parameter Description

id Session ID

state Session state. Can be: Pending, Finished, Error

errors A JSON array of error conditions, see error handling.

identity

This is a verified identity of the customer. The following parameters can be found in this object.

CountryCode	Represents the ID providers country belonging. And consequentially the identified persons nationality.
FirstName	First name
LastName	Last name
PersonalNumber	Persons identified by their ETSI Natural Person Sematics Identifier specified in ETSI319412-1. Semantics identifier contain information using the following structure in the presented order: 3 character natural identity type reference, that shall have one of the following defined values: “PAS” for identification based on passport number. “IDC” for identification based on national identity card number. “PNO” for identification based on (national) personal number (national civic registration number). 2 character ISO 3166-1 alpha-2 country code (for example EE, LT, LV, KZ) hyphen-minus “-” (0x2D (ASCII), U+002D (UTF-8)) identifier (according to country and identity type reference) Example values may be: `PASKZ-987654321012` `PNOEE-48010010101` `IDCCZ-1234567890`
IdProviderName	ZignSec’s name for the Identity provider, for example BankIDSE, BankIDNO, NemID or BankingAPI.
IdentificationDate	The time the identification was performed.
IdProviderRequestID	Not always set. The identity provider’s unique id for the identification request. For easier tracking.

smartIdDetails Provider data

2.2 Response example

{
    "id": "882cf870-d83e-4734-84c6-8e3263c494cd",
    "state": "Finished",
    "errors": [],
    "identity": {
        "countryCode": "EE",
        "firstName": "TOMAS",
        "lastName": "ANDERSON",
        "fullName": "TOMAS ANDERSON",
        "personalNumber": "PNOEE-28611217522",
        "gender": "",
        "phone": "",
        "email": "",
        "addressInfoRaw": "",
        "resultReportPdf": "",
        "idProviderName": "BankIDEE",
        "identificationDate": "2020-10-02T08:39:24.5711223Z",
        "idProviderRequestId": "637bf224-5ef3-4506-94c2-ba0077e10537",
        "idProviderPersonId": "",
        "customerPersonId": "",
        "idProviderAuthenticityScore": "noT_SET"
    },
    "smartIdDetails": {
        "state": "COMPLETE",
        "result": {
            "endResult": "OK",
            "documentNumber": "PNOEE-28611217522-6VPP-NQ"
        },
        "signature": {
            "value": "WwuZ/9oAc79ZI+yF5dRNNmyDcZyLfD1lD05yQj5Bc1JYYe1kyMIZ9GY5vFGfAjAYgLM7SPa451mJglHkkMVyXUSPZ23/Ib4FYNBfkpnVEUkbcnFbBteteCPHzoEuhec1eAYpX3WIZ0cDreZetO/czWmbvf8Vy/1/b4b/5QomWu/XRC5fanOAIdwAZ8pom3Hs/iiVxjCuTwGc4kUVoIxk0TwRDNVB1VF/tZ0j3w1aJhZqi79eWCOSq89A0VNEAyHqX00jxI0RGCfmi0PSqbbmIPsqoctLu1E2ya4X2Msn9XvRT7afO+iywX/jbo/Vs3jFe9tHrF3YAlK07Wmw/VQh80agqf1nxSTicQ1oggztQQaIruK1IV/6SHPNidYOeQuySxNfbaGKsJepq0lMKd/VYD7MlGEkE+Ny936zgAUQesPyx+VNkiz2lPWi5eMCjULjjZaaB3lByI/2WQVMrnMXBFdVRJX90p/AkzTouPVVWj5y2wi9plzeCaNx/FlTGDMc1zB94J88STvEQ0CjFVuPqBzwUobspUs5EKgnzuzR/fqo7Xrcl43ZxtfXMLj2kbAgoRsi0co+WolgEssmsEmJMnK4cHAcj8bGs0SArWRmvLineS9+TSfp/WJSqi0C9uyOAqcFkdtFXVPfoDTtvH0ebrOFD/Pib+Y66FlgFNMeCFuIxWRZLJeUhmGE+5Sv85eSB1MJ8PrNfS0gY1eQT9523w0Gtp6pzVI/NPIFsvf7vTwnPiaB6pDFBf/9SckoskkONKBulaigFeAhcl55dJel1C7GwruqBZg6AGKwiPKRgqedNLhn9+6hMQSnjO+/rUYMzo5CqYHplLX1Kx++okftE5qAFBixsNnuyBixOv0J3+qqBcirdaT0fdhkyUu3rxoNEd/Vty6G1Crz54+wWyUPxbFq2JehcfugI8r8WRfpWuv6gA+Sl02gFKxMWahnpCyDPxoRPM9f9YBaby1w3Ze9cMTRWZ/TOESpKd4ja3D9D4i0St+jt3Zp98+8DlWv3P+c",
            "algorithm": "sha512WithRSAEncryption"
        },
        "cert": {
            "value": "MIIH5TCCBc2gAwIBAgIQYKuInkS5HzBfTQJLKN7GvzANBgkqhkiG9w0BAQsFADBnMQswCQYDVQQGEwJFRTEiMCAGA1UECgwZQVMgU2VydGlmaXRzZWVyaW1pc2tlc2t1czEXMBUGA1UEYQwOTlRSRUUtMTA3NDcwMTMxGzAZBgNVBAMMElRFU1Qgb2YgTlEtU0sgMjAxNjAeFw0yMDA4MzExMzU5MzlaFw0yMDEwMzExNDU5MzlaMH0xCzAJBgNVBAYTAkVFMSwwKgYDVQQDDCNHQVZSSUxFTktPLEVVR0VORSxQTk9FRS0yODYxMTIxNzUyMjETMBEGA1UEBAwKR0FWUklMRU5LTzEPMA0GA1UEKgwGRVVHRU5FMRowGAYDVQQFExFQTk9FRS0yODYxMTIxNzUyMjCCAyEwDQYJKoZIhvcNAQEBBQADggMOADCCAwkCggMAW66AnVjed/ErLli7FqtZ8xPvdEmUa5egOIVkOohcOlnax0Y7vWedCA+DwUK/wpU7X5iTmeRZEfX4UvlMdOY/duZnHua4Wo1Bf3n5ORbhEg8pJKrXzp3LUrRSAFzbSOI91Qxk+XQTZyCIJAw8H1xvGvgx1KCbB2YWl9CbLg+C03dBTBF6HndLtKKoajaz8faEh8zjOzNFzHL/2tSVb4+vB925h5bFDP1dG1Vro/q/SlUk9qknYS1hd7xb+n+qMERzfatEUEHGktgBpMNeYu11SefvWUqFOS+BP0hcZP+mtBTfvW3JPQ5GYDMzDWSSFxlLVlxc0aXg41aQyG46IQPi48SnLsamF64gikozH8+Ah0FnhqCkhZ73RaI/gaMJtjqUyMtP7r925XO5gGj1CxjwUOABOeXe59oJg2sVqQ6RGCnYf+SBz5Efeiq6mXhNkdNP7+vJGWrbUgMr2EaZu0i+VJXw0fPY1Kp4dZ078m5EmIsFIXHNrJvftxpezoG0Q+FpXfePSm0bIAvVnqIWTlDEldpIkjGS+VP+D4lzFLNK4/r+1f1JHHCRPyRhTL+kcYRJSsMTgvoBoycbFnYYmI4SKya+huC4FpsPDzLINS9244NPaj4dKAbudVi9EJShO0yEiisZOAM5/LhTHVSyRLMIGL3Ajek3ZIL7QAZFJVdeqsicSLiFiSvnApiJOP9WSbde9BVERZVnxJQFxc8qjaDMvcWRivS5Hz56ikKO2xUIqG1qoL13/Fqaagg/YT6xbRX9YUIP8Wzr6q2rpA9tX0l9Kg6kMPuMBET71b6rC21Spb551UO/TW6J5i5GnPrvqXp5r4n7agKZ7mYpIUnsaBHrIFAWmqxuDQQYJyeFFXnHQMKsP/jjdyhbqbbWbkh8ONVZ4rK+xW6sSqIHmqK7V0Og1zQw8BvG7xNVak6lqHRnaZMwe+Dqz8hy94w4N63zYqXEOqkUVuLCdtnBKG6b1+XsfzHO8cC79HoTK6N42cWYhXvpP0qgBFJZD/MloX2bpK5XAgMBAAGjggF2MIIBcjAJBgNVHRMEAjAAMA4GA1UdDwEB/wQEAwIEsDBRBgNVHSAESjBIMDwGCisGAQQBzh8DEQEwLjAsBggrBgEFBQcCARYgaHR0cHM6Ly9zay5lZS9lbi9yZXBvc2l0b3J5L0NQUy8wCAYGBACPegEBMB0GA1UdDgQWBBRKflDJygO0bH8xdqoWrlDaA5KYeDAfBgNVHSMEGDAWgBSsw050xt/OPR3E74FhBbZv3UkdPTATBgNVHSUEDDAKBggrBgEFBQcDAjB6BggrBgEFBQcBAQRuMGwwKAYIKwYBBQUHMAGGHGh0dHA6Ly9haWEuZGVtby5zay5lZS9ucTIwMTYwQAYIKwYBBQUHMAKGNGh0dHA6Ly9zay5lZS91cGxvYWQvZmlsZXMvVEVTVF9vZl9OUS1TS18yMDE2LmRlci5jcnQwMQYDVR0RBCowKKQmMCQxIjAgBgNVBAMMGVBOT0VFLTI4NjExMjE3NTIyLTZWUFAtTlEwDQYJKoZIhvcNAQELBQADggIBAKT5qGggrNpBk3OT1H+A0ZIA8PkaSCO3TdiS+dlpaKWyzcCWdwW0pWOr48N51lbPjvxojcistiCoCm1cYqQAVPD/hAbMcDvQqTtuJZZ4PcLpgs2b8RF1MzkeHel7vhQwGLw6yJNcDApskhLCaFcqsV6HtYDI06g+ks5F+wI1D6yekMc1FrepcA3oUyjxof8BTNWgX/jXvXD3/IU5GONz3XiTpBhEb8/4V72eQymyiQLEI9GsDKlUkxTLOdr2D3QJoQqkrel396VdDF6MGfvfX2dHvFZU+KgRrHh3zNNzYxgTLDQJbOWov+HMAnCguIk5cSOujhNmz/+80jwKL32dKK9EI1GglqGCv/b+RYYDHeuv/dNZrW2S+SlQui6CSOPQpJ4QZ+1U0YxEw3cpiKa2TpUzdeZwzvWpU4c54Q8Y/QiJG6yMAcHIleHNK9KZHNVGb3VmzcDwvzyxb2MKDYXVHChjCZGkdIrGT5F2+4614H+klHem3R18S3XaYuO8Kwbq4nimvska3xtxblDILewvmOA3x/CHJok+e6V1ULF+0UGVvma6Fl2oxYg6UnXMagzjl7X5Ake4mtqgDKVG/h6qoB/eIZQECC3XKBPipxK8j3B0cG0l6aWML29qxwENBnf/biEI7D2yPVGmX844sfqpCUxtZh+b5VH1VJngCwGqAdhQ",
            "certificateLevel": "ADVANCED"
        }
    }
}

2.2 Person detail parameters

Parameter	Description
`resultId`	The unique identifier of the single person result.
`category`	The categories the matched record belongs to, which can be one or a combination of the following: TER, PEP, SIP, RCA.
`matchRate`	For Close match scans only. Indicates the Close Match Rate for each matched entity. Values are from 1 (not close) to 100 (exact or very close).
`person`	Person entity

Our APIs