Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents
stylenone

API Key

You'll need your API key, so contact info@ondato.com if you don't have them.

...

Code Block
breakoutModewide
languagebash
curl --location --request POST 'https://sandbox-esignature.ondato.com/smart-id/document-signature/' \
--header 'x-api-key: {your-api-key}' \
--form 'countryCode="LT"' \
--form 'nationalIdentityNumber="30303039914"' \
--form 'displayText="Please confirm transaction"' \
--form 'file=@"/C:/Users/user/Downloads/TEST PDF.pdf"'

...

GET Get

...

Signed Document

https://sandbox-esignature.ondato.com/smart-id/document-signature/:sessionId

...

Session is present in the system and the request is either running or has been completed less than 5 minutes ago.

Response parameters

...

Parameter

...

Required

...

Description

...

nationalIdentityNumber

...

Required

...

...

Mobile-ID

Mobile-ID is a SIM card based digital signature solution (and requires a special Mobile-ID SIM card which your mobile operator will provide). It is recognised by governments and it grants access to online services in a similar manner to an ID card.

...

Parameter

Required

Description

phoneNumber

Required

Phone number of the signer with the country code in the format of +xxxxxxxxx

nationalIdentityNumber

Required

National identification number

language

Required

Language for user dialog in mobile phone. 3-letters capitalized acronyms are used. Possible values: EST, ENG, RUS, LIT. NB! If you use language="LIT" to send to Estonian number (+372...) or you use language="EST" to send to Lithuanian number (+370...) then internally language is replaced with "ENG".

displayText

Optional

Text to display for authentication consent dialog on the mobile device. Limited to 40 characters including up to 5 characters from extension table ( €[]^|{}\ ).

amlScreeningRequired

Optional

Do execute AML screening?

Response parameters

...

Parameter

Required

Description

sessionId

Required

A string that can be used to request operation result.

verificationCode

Required

Verification code is needed, so that user can bind together the session on the browser and the authentication request on mobile device.

...

https://sandbox-esignature.ondato.com/mobile-id/authentication/:sessionId

Response parameters

...

Parameter

Required

Description

countryCode

Required

Country code

nationalIdentityNumber

Required

National identification number

name

Required

Person name

surname

Required

Person surname

isPep

Optional

If amlScreeningRequired was used in Create Authentication Session method

...

Parameter

Required

Description

phoneNumber

Required

Phone number of the signer with the country code in the format of +xxxxxxxxx

nationalIdentityNumber

Required

National identification number

language

Required

Language for user dialog in mobile phone. 3-letters capitalized acronyms are used. Possible values: EST, ENG, RUS, LIT. NB! If you use language="LIT" to send to Estonian number (+372...) or you use language="EST" to send to Lithuanian number (+370...) then internally language is replaced with "ENG".

displayText

Optional

Text to display for authentication consent dialog on the mobile device. Limited to 60 characters or 128 bytes in UTF-8 encoding, whichever is reached first.

file

Required

File to sign

Response parameters

...

Parameter

Required

Description

sessionId

Required

A string that can be used to request operation result.

verificationCode

Required

Verification code is needed, so that user can bind together the session on the browser and the authentication request on mobile device.

...

Code Block
breakoutModewide
languagebash
curl --location --request POST 'https://sandbox-esignature.ondato.com/mobile-id/document-signature/' \
--header 'x-api-key: {your-api-key}' \
--form 'phoneNumber="37060000666"' \
--form 'nationalIdentityNumber="50001018865"' \
--form 'language="ENG"' \
--form 'displayText="Please confirm transaction"' \
--form 'file=@"/C:/Users/user/Downloads/TEST PDF.pdf"'

...

GET Get

...

Signed Document

https://sandbox-esignature.ondato.com/mobile-id/document-signature/:sessionId

...

Session is present in the system and the request is either running or has been completed less than 5 minutes ago.

Response parameters

...

Parameter

...

Required

...

Description

...

nationalIdentityNumber

...

Required

...