Config Reference

Identification Config Reference

Creating the client for identification

const eidEasyClient = window.eidEasyBrowserClient.createClient({
    clientId: '2IaeiZXbcKzlP1KvjZH9ghty2IJKM8Lg', // required
    redirectUri: 'http://localhost/', // required
    apiEndpoints: { // required
      identityStart: () => 'https://eid-sample-app.test/api/identity/start',
      identityFinish: () => 'https://eid-sample-app.test/api/identity/finish',
    },
    countryCode: 'EE', // required
    language: 'et',
    sandbox: true,
    oauthParamState: 'custom-state-value', // this gets used only in case of identification methods
});

Client Settings

Option	Type	Default	Description
clientId	string	undefined	Required. Get from id.eideasy.com after signing up.
redirectUri	string	undefined	Required. This gets used for redirects back to your application e.g. when using eParaksts mobile. The value of redirectUri has to match with the "Oauth redirect_uri(s)" setting you provided in your eID Easy admin page.
apiEndpoints.identityStart	function	undefined	Required. This should return your server endpoint for the identity start request. See the "Implementing the identityStart and identityFinish endpoints" section for more information.
apiEndpoints.identityFinish	function	undefined	Required. This should return your server endpoint for the identity finish request. See the "Implementing the identityStart and identityFinish endpoints" section for more information.
countryCode	string	undefined	Required. ISO 3166-1 alpha-2 country code
sandbox	boolean	false	Whether to use the sandbox mode.
language	string	'en'	Two letter ISO 639-1 language code.
oauthParamState	string	undefined	Value of the OAuth state param.

Implementing the identityStart and identityFinish endpoints

You should implement and expose two endpoints on your server to handle the identity start and identity finish requests.

identityStart endpoint should take the request body sent by the browser-client, add your client_id and secret to it and send it to https://id.eideasy.com/api/identity/{client_id}/{method}/start.

It should then return the response from https://id.eideasy.com/api/identity/{client_id}/{method}/start back to the browser-client.

identityFinish endpoint should take the request body sent by the browser-client, add your client_id and secret to it and send it to https://id.eideasy.com/api/identity/{client_id}/{method}/complete.

If the response from https://id.eideasy.com/api/identity/{client_id}/{method}/complete contains {"status": "OK" }, then the user has successfully authenticated and you can proceed with logging in the user.

In all other cases, you can return the response from https://id.eideasy.com/api/identity/{client_id}/{method}/complete back to the browser-client and the browser-client will handle the error.

See the diagram below for request examples and a visual representation of the flow.

Austrian Handy Signatur Login

Austrian Handy Signatur is a redirect based method, so:

1. user gets redirected to the Austrian Handy Signatur page where they have to enter their user and mobile number
2. Austrian Handy Signatur then asks the user for confirmation on their cellphone
3. user gets redirected back to the redirectUri specified in the eidEasyClient settings with a token you can use to fetch data

eidEasyClient.identification.atHandy.start({
   redirect: (context) => {
      console.log(context);
      // you can do the redirect here yourself should you wish so
      // window.location.href = context.redirectUrl;
      return {
         data: null,
      };
   },
});

Austrian Handy Signatur identification settings

Option	Type	Default	Description
redirect	function	undefined	You can use this setting to override the default redirection functionality

eDO App login

eidEasyClient.identification.edoAppEid.start({
   redirect: (context) => {
      console.log(context);
      // you can do the redirect here yourself should you wish so
      // window.location.href = context.redirectUrl;
      return {
        data: null,
      };
   },
});

eDO App identification settings

Option	Type	Default	Description
fail	function	undefined	This function gets called when the authentication process failed.
success	function	undefined	This function gets called when the authentication process succeeds.
finished	function	undefined	This function gets called when the authentication process has either failed or succeeded. This means that this function gets called always, no matter the authentication result. For example, it can be useful to hide a loading spinner at the end of the authentication process or to do some other clean up work.

eParaksts mobile login

eParaksts Mobile is an OAuth2 based method, so:

1. user gets redirected to the eParaksts page where they have to enter their user number
2. eParaksts then asks the user for confirmation on their cellphone
3. user gets redirected back to the redirectUri specified in the eidEasyClient settings with a token you can use to fetch data

eidEasyClient.identification.eParakstsMobile.start({
   redirect: (context) => {
      console.log(context);
      // you can do the redirect here yourself should you wish so
      // window.location.href = context.redirectUrl;
      return {
         data: null,
      };
   },
});

eParakstsMobile identification settings

Option	Type	Default	Description
redirect	function	undefined	You can use this setting to override the default redirection functionality

Identification with Freja eID

eidEasyClient.identification.frejaEid.start({
   idcode: 'xxxxxxxxxxxxx', // required
   started: () => {
      // identification process has started,
      // Freja eID app will prompt the user to approve the identification request
   },
   fail: (error) => {
      // do something with the error
   },
   success: (result) => {
      // do something with the result
   },
   finished: () => {
     // the process has finished, you can do some clean up like hiding a loader here
   },
});

Freja eID identification settings

Option	Type	Default	Description
idcode	string	undefined	Required. End user's personal identification code
started	function	undefined	This function gets called when the authentication process has started, Freja eID app will prompt the user to approve the identification request.
fail	function	undefined	This function gets called when the authentication process failed.
success	function	undefined	This function gets called when the authentication process succeeds.
finished	function	undefined	This function gets called when the authentication process has either failed or succeeded. This means that this function gets called always, no matter the authentication result. For example, it can be useful to hide a loading spinner at the end of the authentication process or to do some other clean up work.

Finnish Trust Network (FTN) login

FTN is an OAuth2 based method, so:

1. user gets redirected to the FTN page where they have to enter their user number
2. FTN then asks the user for confirmation on their cellphone
3. user gets redirected back to the redirectUri specified in the eidEasyClient settings with a token you can use to fetch data

eidEasyClient.identification.finnishTrustNetwork.start({
   redirect: (context) => {
      console.log(context);
      // you can do the redirect here yourself should you wish so
      // window.location.href = context.redirectUrl;
      return {
         data: null,
      };
   },
});

FTN identification settings

Option	Type	Default	Description
redirect	function	undefined	You can use this setting to override the default redirection functionality

Identification with an ID Card

// deprecated, not stable
eidEasyClient.identification.idCard.start({
   fail: (error) => {
      // do something with the error
   },
   success: (result) => {
      // do something with the result
   },
   finished: () => {
      // the process has finished, you can do some clean up like hiding a loader here
   },
});
// using Web eID, stable
eidEasyClient.identification.webEid.start({
  iframeHolder: document.getElementById('webeIdIframeHolder'), // Required. DOM element whose content gets replaced with the Web eID iframe
  fail: (error) => {
    // do something with the error
  },
  success: (result) => {
    // do something with the result
  },
  finished: () => {
    // the process has finished, you can do some clean up like hiding a loader here
  },
});

idCard identification settings

Option	Type	Default	Description
iframeHolder	DOM element	undefined	Required (when using Web eID). DOM element whose content gets replaced with webEid iframe
fail	function	undefined	This function gets called when the authentication process failed.
success	function	undefined	This function gets called when the authentication process succeeds.
finished	function	undefined	This function gets called when the authentication process has either failed or succeeded. This means that this function gets called always, no matter the authentication result. For example, it can be useful to hide a loading spinner at the end of the authentication process or to do some other clean up work.

IDIN login

IDIN is an OAuth2 based method, so:

1. user gets redirected to the IDIN page where they have to enter their user number
2. IDIN then asks the user for confirmation on their cellphone
3. user gets redirected back to the redirectUri specified in the eidEasyClient settings with a token you can use to fetch data

// IDIN identification
eidEasyClient.identification.idin.start({
   redirect: (context) => {
      console.log(context);
      // you can do the redirect here yourself should you wish so
      // window.location.href = context.redirectUrl;
      return {
         data: null,
      };
   },
});
// IDIN identification using Customer ID
eidEasyClient.identification.idinCustomerId.start({
  redirect: (context) => {
    console.log(context);
    // you can do the redirect here yourself should you wish so
    // window.location.href = context.redirectUrl;
    return {
      data: null,
    };
  },
});

IDIN identification settings

Option	Type	Default	Description
redirect	function	undefined	You can use this setting to override the default redirection functionality

Itsme login

Itsme is an OAuth2 based method, so:

1. user gets redirected to the Itsme page where they have to enter their user number
2. user gets redirected back to the redirectUri specified in the eidEasyClient settings with a token you can use to fetch data

// Itsme Identification - full user data
eidEasyClient.identification.itsme.start({
   redirect: (context) => {
      console.log(context);
      // you can do the redirect here yourself should you wish so
      // window.location.href = context.redirectUrl;
      return {
         data: null,
      };
   },
});
// Itsme Standard - full user data
eidEasyClient.identification.itsmeStandard.start({
  redirect: (context) => {
    console.log(context);
    // you can do the redirect here yourself should you wish so
    // window.location.href = context.redirectUrl;
    return {
      data: null,
    };
  },
});
// Itsme Basic - limited user data
eidEasyClient.identification.itsmeBasic.start({
  redirect: (context) => {
    console.log(context);
    // you can do the redirect here yourself should you wish so
    // window.location.href = context.redirectUrl;
    return {
      data: null,
    };
  },
});

Itsme identification settings

Option	Type	Default	Description
redirect	function	undefined	You can use this setting to override the default redirection functionality

MitID login

MitID is an OAuth2 based method, so:

1. user gets redirected to the MitID page where they have to enter their user number
2. user gets redirected back to the redirectUri specified in the eidEasyClient settings with a token you can use to fetch data

eidEasyClient.identification.mitId.start({
   redirect: (context) => {
      console.log(context);
      // you can do the redirect here yourself should you wish so
      // window.location.href = context.redirectUrl;
      return {
         data: null,
      };
   },
});

MitID identification settings

Option	Type	Default	Description
redirect	function	undefined	You can use this setting to override the default redirection functionality

Mobile ID identification

eidEasyClient.identification.mobileId.start({
   idcode: '60001019906', // required
   phone: '+37200000766', // required
   started: (result) => {
      // do something with the result
      // e.g. display the result.data.challenge code
   },
   fail: (error) => {
      // do something with the error
   },
   success: (result) => {
      // do something with the result
   },
   finished: () => {
      // the process has finished, you can do some clean up like hiding a loader here
   },
});

MobileId identification settings

Option	Type	Default	Description
idcode	string	undefined	Required. End user's personal identification code
phone	string	undefined	Required. End user's phone number, must have the country code prefixed with a '+' sign, e.g. +37200000766
started	function	undefined	This function gets called when the authentication process has started. The argument object of this function contains the challenge (response.data.challenge) you can display to the end-user.
fail	function	undefined	This function gets called when the authentication process failed.
success	function	undefined	This function gets called when the authentication process succeeds.
finished	function	undefined	This function gets called when the authentication process has either failed or succeeded. This means that this function gets called always, no matter the authentication result. For example, it can be useful to hide a loading spinner at the end of the authentication process or to do some other clean up work.

MojeID login

MojeID is an OAuth2 based method, so:

1. user gets redirected to the MojeID page where they have to enter their user number
2. user gets redirected back to the redirectUri specified in the eidEasyClient settings with a token you can use to fetch data

eidEasyClient.identification.mojeId.start({
   redirect: (context) => {
      console.log(context);
      // you can do the redirect here yourself should you wish so
      // window.location.href = context.redirectUrl;
      return {
         data: null,
      };
   },
});
// For Poland (PL)
eidEasyClient.identification.plMojeId.start({
  redirect: (context) => {
    console.log(context);
    // you can do the redirect here yourself should you wish so
    // window.location.href = context.redirectUrl;
    return {
      data: null,
    };
  },
});

MojeID identification settings

Option	Type	Default	Description
redirect	function	undefined	You can use this setting to override the default redirection functionality

Norwegian BankID login

Norwegian BankID is an OAuth2 based method, so:

1. user gets redirected to the Norwegian Bank page where they have to enter their user number
2. user gets redirected back to the redirectUri specified in the eidEasyClient settings with a token you can use to fetch data

eidEasyClient.identification.norwegianBankId.start({
   redirect: (context) => {
      console.log(context);
      // you can do the redirect here yourself should you wish so
      // window.location.href = context.redirectUrl;
      return {
         data: null,
      };
   },
});

Norwegian BankID identification settings

Option	Type	Default	Description
redirect	function	undefined	You can use this setting to override the default redirection functionality

Smart-ID identification

eidEasyClient.identification.smartId.start({
   idcode: '10101010005', // required
   started: (result) => {
      // do something with the result
      // e.g. display the result.data.challenge code
   },
   fail: (error) => {
      // do something with the error
   },
   success: (result) => {
      // do something with the result
   },
   finished: () => {
      // the process has finished, you can do some clean up like hiding a loader here
   },
});

smartId identification settings

Option	Type	Default	Description
idcode	string	undefined	Required. End user's personal identification code
started	function	undefined	This function gets called when the authentication process has started. The argument object of this function contains the challenge (response.data.challenge) you can display to the end-user.
fail	function	undefined	This function gets called when the authentication process failed.
success	function	undefined	This function gets called when the authentication process succeeds.
finished	function	undefined	This function gets called when the authentication process has either failed or succeeded. This means that this function gets called always, no matter the authentication result. For example, it can be useful to hide a loading spinner at the end of the authentication process or to do some other clean up work.

Swedish BankID login

Swedish BankID is an OAuth2 based method, so:

1. user gets redirected to the Swedish Bank page where they have to enter their user number
2. user gets redirected back to the redirectUri specified in the eidEasyClient settings with a token you can use to fetch data

eidEasyClient.identification.seBankId.start({
   redirect: (context) => {
      console.log(context);
      // you can do the redirect here yourself should you wish so
      // window.location.href = context.redirectUrl;
      return {
         data: null,
      };
   },
});

Swedish BankID identification settings

Option	Type	Default	Description
redirect	function	undefined	You can use this setting to override the default redirection functionality

Identification with ZealiD

When the ZealiD identification process starts, eidEasyClient will automatically create a ZealId iframe and start listening for messages originating from that iframe. You just have to provide a DOM element (the "iframeHolder" setting in the example below) to which eidEasyClient can append the iframe.

eidEasyClient.identification.zealId.start({
   iframeHolder: document.getElementById('zealIdIframeHolder'), // Required. DOM element whose content gets replaced with the ZealiD's iframe
   fail: (error) => {
      // do something with the error
   },
   success: (result) => {
      // do something with the result
   },
   finished: () => {
     // the process has finished, you can do some clean up like hiding a loader here
   },
});

ZealiD identification settings

Option	Type	Default	Description
iframeHolder	DOM element	undefined	Required. DOM element whose content gets replaced with the ZealiD's iframe
fail	function	undefined	This function gets called when the authentication process failed.
success	function	undefined	This function gets called when the authentication process succeeds.
finished	function	undefined	This function gets called when the authentication process has either failed or succeeded. This means that this function gets called always, no matter the authentication result. For example, it can be useful to hide a loading spinner at the end of the authentication process or to do some other clean up work.

Signing Config Reference

Creating the client for signing

const eidEasyClient = window.eidEasyBrowserClient.createClient({
   clientId: '2IaeiZXbcKzlP1KvjZH9ghty2IJKM8Lg', // required
   docId: 'CR1GsqrBICJmJMXTCxM82jxb8MlhLpWTacZARn4o', // required
   countryCode: 'EE', // required
   language: 'et',
   sandbox: true,
});

Client Settings

Option	Type	Default	Description
clientId	string	undefined	Required. Get from id.eideasy.com after signing up.
docId	string	undefined	Required. The docId of the document you have prepared for signing. You can find more information on file preparation here and the API reference for file preparation here
countryCode	string	undefined	Required. ISO 3166-1 alpha-2 country code
sandbox	boolean	false	Whether to use the sandbox mode.
language	string	'en'	Two letter ISO 639-1 language code.

Aba DO Signature

Aba DO is an OAuth2 based method, so the user gets redirected to Aba DO page where they can complete the signing process.

eidEasyClient.signature.abaDoSignature.start({
  countryCode: "DO", // required
   redirect: (context) => {
      console.log(context);
      // you can do the redirect here yourself should you wish so
      // window.location.href = context.redirectUrl;
      return {
         data: null,
      };
   },
});

Aba DO signing settings

Option	Type	Default	Description
countryCode	string	undefined	Required. ISO 3166-1 alpha-2 code of the country where the user has registered their Aba account
redirect	function	undefined	You can use this setting to override the default redirection functionality

Adacom Long Term Certificate and OneShot QES Signature

Adacom is an OAuth2 based method, so the user gets redirected to Adacom page where they can complete the signing process.

// for Adacom Long Term Certificate
eidEasyClient.signature.adacomQesSignature.start({
  countryCode: "GR", // required
   redirect: (context) => {
      console.log(context);
      // you can do the redirect here yourself should you wish so
      // window.location.href = context.redirectUrl;
      return {
         data: null,
      };
   },
});

// for Adacom One Shot QES
eidEasyClient.signature.adacomOneShotQesSignature.start({
  countryCode: "US", // required
   redirect: (context) => {
      console.log(context);
      // you can do the redirect here yourself should you wish so
      // window.location.href = context.redirectUrl;
      return {
         data: null,
      };
   },
});

Adacom signing settings

Option	Type	Default	Description
countryCode	string	undefined	Required. ISO 3166-1 alpha-2 code of the country where the user has registered their Adacom account. Adacom Long Term Certificate works only for Greece (GR), while Adacom One Shot has much wider support.
redirect	function	undefined	You can use this setting to override the default redirection functionality

Audkenni QES

eidEasyClient.signature.audkenniQesSignature.start({
   countryCode: 'EE', // required
   idcode: '10101010005', // required
   started: (response) => {
     // do something with the result
     const challenge = response.data.challenge;
   },
   fail: (error) => {
      // do something with the error
   },
   success: (result) => {
      // do something with the result
   },
   finished: () => {
      // the process has finished, you can do some clean up like hiding a loader here
   },
});

Audkenni QES signing settings

Option	Type	Default	Description
countryCode	string	undefined	Required. ISO 3166-1 alpha-2 code of the country where the user has registered their Audkenni account
started	function	undefined	This function gets called when the signing process has started. The argument object of this function contains challenge code that should be presented to user to make sure that correct transaction is getting approved.
fail	function	undefined	This function gets called when the signing process failed.
success	function	undefined	This function gets called when the signing process succeeds.
finished	function	undefined	This function gets called when the signing process has either failed or succeeded. This means that this function gets called always, no matter the authentication result. For example, it can be useful to hide a loading spinner at the end of the authentication process or to do some other clean up work.

Austrian Handy Signatur QES

Austrian Handy Signatur is an OAuth2 based method, so the user gets redirected to the Handy Signatur page where they can complete the signing process.

eidEasyClient.signature.atHandySignature.start({
   redirect: (context) => {
      console.log(context);
      // you can do the redirect here yourself should you wish so
      // window.location.href = context.redirectUrl;
      return {
         data: null,
      };
   },
});

Austrian Handy Signatur signing settings

Option	Type	Default	Description
countryCode	string	undefined	Required. ISO 3166-1 alpha-2 code of the country where the user has registered their Handy Signatur account
redirect	function	undefined	You can use this setting to override the default redirection functionality

Buypass QES Signature

Buypass is an OAuth2 based method, so the user gets redirected to Buypass page where they can complete the signing process.

eidEasyClient.signature.buypassQesSignature.start({
  countryCode: "NO", // required
   redirect: (context) => {
      console.log(context);
      // you can do the redirect here yourself should you wish so
      // window.location.href = context.redirectUrl;
      return {
         data: null,
      };
   },
});

Buypass signing settings

Option	Type	Default	Description
countryCode	string	undefined	Required. ISO 3166-1 alpha-2 code of the country where the user has registered their Buypass account. Currently, only Norway (NO) is supported.
redirect	function	undefined	You can use this setting to override the default redirection functionality

CertEurope USB token QES

eidEasyClient.signature.certEuropeUsbTokenSignature.start({
   countryCode: 'FR',
   iframeHolder: document.getElementById('idCardIframeHolder'), // Required. DOM element whose content gets replaced with an iframe (this iframe will be used to get the signing certificates from the id card)
   fail: (error) => {
      // do something with the error
   },
   success: (result) => {
      // do something with the result
   },
   finished: () => {
      // the process has finished, you can do some clean up like hiding a loader here
   },
});

CertEurope USB token settings

Option	Type	Default	Description
countryCode	string	undefined	Required. ISO 3166-1 alpha-2 code of the country that issued usb token. Currently supported: FR, PL
iframeHolder	DOM element	undefined	Required. DOM element whose content gets replaced with an iframe (this iframe will be used to get the signing certificates from the connected USB token)
fail	function	undefined	This function gets called when the signing process failed.
success	function	undefined	This function gets called when the signing process succeeds.
finished	function	undefined	This function gets called when the signing process has either failed or succeeded. This means that this function gets called always, no matter the authentication result. For example, it can be useful to hide a loading spinner at the end of the authentication process or to do some other clean up work.

CertMe QES Signature

CertMe is an OAuth2 based method, so the user gets redirected to CertMe page where they can complete the signing process.

eidEasyClient.signature.certMeQesSignature.start({
  countryCode: "RO", // required
   redirect: (context) => {
      console.log(context);
      // you can do the redirect here yourself should you wish so
      // window.location.href = context.redirectUrl;
      return {
         data: null,
      };
   },
});

CertMe signing settings

Option	Type	Default	Description
countryCode	string	undefined	Required. ISO 3166-1 alpha-2 code of the country where the user has registered their CertMe account. Currently, only Romania (RO) is supported.
redirect	function	undefined	You can use this setting to override the default redirection functionality

certSIGN USB token QES

eidEasyClient.signature.certSignUsbTokenSignature.start({
   countryCode: 'RO',
   iframeHolder: document.getElementById('idCardIframeHolder'), // Required. DOM element whose content gets replaced with an iframe (this iframe will be used to get the signing certificates from the id card)
   fail: (error) => {
      // do something with the error
   },
   success: (result) => {
      // do something with the result
   },
   finished: () => {
      // the process has finished, you can do some clean up like hiding a loader here
   },
});

certSIGN USB token settings

Option	Type	Default	Description
countryCode	string	undefined	Required. ISO 3166-1 alpha-2 code of the country that issued usb token. Currently supported: RO, PL
iframeHolder	DOM element	undefined	Required. DOM element whose content gets replaced with an iframe (this iframe will be used to get the signing certificates from the connected USB token)
fail	function	undefined	This function gets called when the signing process failed.
success	function	undefined	This function gets called when the signing process succeeds.
finished	function	undefined	This function gets called when the signing process has either failed or succeeded. This means that this function gets called always, no matter the authentication result. For example, it can be useful to hide a loading spinner at the end of the authentication process or to do some other clean up work.

certSIGN Signature over Web API

certSIGN over Web API is an OAuth2 based method, so the user gets redirected to certSIGN page where they can complete the signing process.

eidEasyClient.signature.certsignWebapiQesSignature.start({
  countryCode: "RO", // required
   redirect: (context) => {
      console.log(context);
      // you can do the redirect here yourself should you wish so
      // window.location.href = context.redirectUrl;
      return {
         data: null,
      };
   },
});

certSIGN Signature over Web API settings

Option	Type	Default	Description
countryCode	string	undefined	Required. ISO 3166-1 alpha-2 code of the country where the user has registered their certSIGN account. Currently, only Romania (RO) is supported.
redirect	function	undefined	You can use this setting to override the default redirection functionality

Chave Movel QES

eidEasyClient.signature.chaveMovelSignature.start({
   countryCode: 'PT', // required
   phone: '+37200000766', // required
   signingPin: '1234', // required
   started: (response) => {
      // do something with the result
   },
   fail: (error) => {
      // do something with the error
   },
   success: (result) => {
      // do something with the result
   },
   finished: () => {
      // the process has finished, you can do some clean up like hiding a loader here
   },
});

Chave Movel signing settings

Option	Type	Default	Description
countryCode	string	undefined	Required. ISO 3166-1 alpha-2 code of the country where the user has registered their Chave Movel account. Currently, only Portugal (PT) is supported.
phone	string	undefined	Required. End user's phone number, must have the country code prefixed with a '+' sign, e.g. +37200000766
signingPin	string	undefined	Required. End user's signing PIN
started	function	undefined	This function gets called when the signing process has started. The argument object of this function contains the qr code and redirectUrl. You should display QR code image and make it clickable for mobile device users. QR code should be scanned with Diia application.
fail	function	undefined	This function gets called when the signing process failed.
success	function	undefined	This function gets called when the signing process succeeds.
finished	function	undefined	This function gets called when the signing process has either failed or succeeded. This means that this function gets called always, no matter the authentication result. For example, it can be useful to hide a loading spinner at the end of the authentication process or to do some other clean up work.

Czech BankID AdES Signature

Czech BankID is an OAuth2 based method, so the user gets redirected to bank's page where they can complete the signing process.

eidEasyClient.signature.czBankIDSignature.start({
  countryCode: "CZ", // required
   redirect: (context) => {
      console.log(context);
      // you can do the redirect here yourself should you wish so
      // window.location.href = context.redirectUrl;
      return {
         data: null,
      };
   },
});

Czech BankID AdES signing settings

Option	Type	Default	Description
countryCode	string	undefined	Required. ISO 3166-1 alpha-2 code of the country where the user has registered their bank account. Currently, only Czech Republic (CZ) is supported.
redirect	function	undefined	You can use this setting to override the default redirection functionality

Diia.Signature QES

eidEasyClient.signature.diiaQesSignature.start({
   countryCode: 'UA', // required
   started: (response) => {
      // do something with the result
     const qr = response.data.qr_code; // Base64 encoded QR code image
     const redirectUrl = response.data.redirect_uri; // as alternative to QR code
   },
   fail: (error) => {
      // do something with the error
   },
   success: (result) => {
      // do something with the result
   },
   finished: () => {
      // the process has finished, you can do some clean up like hiding a loader here
   },
});

Diia.Signature signing settings

Option	Type	Default	Description
countryCode	string	undefined	Required. ISO 3166-1 alpha-2 code of the country where the user has registered their Diia account. Currently, only Ukraine (UA) is supported.
started	function	undefined	This function gets called when the signing process has started. The argument object of this function contains the qr code and redirectUrl. You should display QR code image and make it clickable for mobile device users. QR code should be scanned with Diia application.
fail	function	undefined	This function gets called when the signing process failed.
success	function	undefined	This function gets called when the signing process succeeds.
finished	function	undefined	This function gets called when the signing process has either failed or succeeded. This means that this function gets called always, no matter the authentication result. For example, it can be useful to hide a loading spinner at the end of the authentication process or to do some other clean up work.

Denmark MitID

MitId is an OAuth2 based method, so the user gets redirected to MitID page where they can complete the signing process. Provides different levels of signing: SES, full advanced AdES, QES, Seal-based signature on "light" advanced level AdES

// SES
eidEasyClient.signature.mitIdSignature.start({
  countryCode: "DK", // required, supported countries: 'DK', 'GL'
   redirect: (context) => {
      console.log(context);
      // you can do the redirect here yourself should you wish so
      // window.location.href = context.redirectUrl;
      return {
         data: null,
      };
   },
});

// AdES
eidEasyClient.signature.mitIdAdvancedSignature.start({
  countryCode: "DK", // required
  redirect: (context) => {
    console.log(context);
    // you can do the redirect here yourself should you wish so
    // window.location.href = context.redirectUrl;
    return {
      data: null,
    };
  },
});

// QES
eidEasyClient.signature.mitIdQesSignature.start({
  countryCode: "DK", // required
  redirect: (context) => {
    console.log(context);
    // you can do the redirect here yourself should you wish so
    // window.location.href = context.redirectUrl;
    return {
      data: null,
    };
  },
});

// seal-based AdES
eidEasyClient.signature.dkMitIdAdvancedHashSignature.start({
  countryCode: "DK", // required
  redirect: (context) => {
    console.log(context);
    // you can do the redirect here yourself should you wish so
    // window.location.href = context.redirectUrl;
    return {
      data: null,
    };
  },
});

Denmark MitID signing settings

Option	Type	Default	Description
countryCode	string	undefined	Required. ISO 3166-1 alpha-2 code of the country where the user has registered their MitID account. Currently, only Denmark (DK) is supported.
redirect	function	undefined	You can use this setting to override the default redirection functionality

D-Trust SignMe Signature

D-Trust SignMe is an OAuth2 based method, so the user gets redirected to SignMe page where they can complete the signing process. Provides different levels of signing: QES, AdES

// QES
eidEasyClient.signature.dTrustSignMeSignature.start({
  countryCode: "DE", // required
  username: "test-user", // required
  redirect: (context) => {
    console.log(context);
    // you can do the redirect here yourself should you wish so
    // window.location.href = context.redirectUrl;
    return {
      data: null,
    };
  },
});

// AdES
eidEasyClient.signature.dTrustSignMeAdvSignature.start({
  countryCode: "DE", // required
  username: "test-user", // required
  redirect: (context) => {
    console.log(context);
    // you can do the redirect here yourself should you wish so
    // window.location.href = context.redirectUrl;
    return {
      data: null,
    };
  },
});

D-Trust SignMe signing settings

Option	Type	Default	Description
countryCode	string	undefined	Required. ISO 3166-1 alpha-2 code of the country where the user has registered their MitID account. Currently, only Denmark (DK) is supported.
username	function	undefined	Required. User's username provided by SignMe
redirect	function	undefined	You can use this setting to override the default redirection functionality

eCert Chile AdES

eCert Chile is an OAuth2 based method, so the user gets redirected to eCert page where they can complete the signing process.

eidEasyClient.signature.eCertChileSignature.start({
  countryCode: "CL", // required
  idcode: "23423423424", // required
  email: "chile@ecert.test", // required
  redirect: (context) => {
    console.log(context);
    // you can do the redirect here yourself should you wish so
    // window.location.href = context.redirectUrl;
    return {
      data: null,
    };
  },
});

eCert Chile AdES signing settings

Option	Type	Default	Description
countryCode	string	undefined	Required. ISO 3166-1 alpha-2 code of the country where the user has registered their MitID account. Currently, only Denmark (DK) is supported.
idcode	function	undefined	Required. End user's personal identification code
email	function	undefined	Required. Valid user email
redirect	function	undefined	You can use this setting to override the default redirection functionality

eMudhra QES

eMudhra is an OAuth2 based method, so the user gets redirected to the eMudhra page where they can complete the signing process.

eidEasyClient.signature.emudhraQesSignature.start({
  countryCode: "IN", // required
   redirect: (context) => {
      console.log(context);
      // you can do the redirect here yourself should you wish so
      // window.location.href = context.redirectUrl;
      return {
         data: null,
      };
   },
});

eMudhra signing settings

Option	Type	Default	Description
countryCode	string	undefined	Required. ISO 3166-1 alpha-2 code of the country where the user has registered their eMudhra account. Supported countries: India (IN)
redirect	function	undefined	You can use this setting to override the default redirection functionality

Signing with eParaksts mobile

eParaksts Mobile is an OAuth2 based method, so the user gets redirected to the eParaksts page where they can complete the signing process.

eidEasyClient.signature.eParakstsMobileSignature.start({
   redirect: (context) => {
      console.log(context);
      // you can do the redirect here yourself should you wish so
      // window.location.href = context.redirectUrl;
      return {
         data: null,
      };
   },
});

eParakstsMobile signing settings

Option	Type	Default	Description
redirect	function	undefined	You can use this setting to override the default redirection functionality

Evrotrust QES

eidEasyClient.signature.evroTrustSignature.start({
   phone: '+37200000766', // required
   countryCode: 'EE', // required
   started: (result) => {
      // do something with the result
      // e.g. display the result.data.challenge code
   },
   fail: (error) => {
      // do something with the error
   },
   success: (result) => {
      // do something with the result
   },
   finished: () => {
      // the process has finished, you can do some clean up like hiding a loader here
   },
});

Evrotrust signing settings

Option	Type	Default	Description
phone	string	undefined	Required. End user's phone number, must have the country code prefixed with a '+' sign, e.g. +37200000766
countryCode	string	undefined	Required. ISO 3166-1 alpha-2 code of the country where the user has registered their Mobile ID account
started	function	undefined	This function gets called when the signing process has started. The argument object of this function contains the transaction id (response.data.transaction_id) that the end user sees on their device. You should display this code in your app so that the user can be sure that they are signing the right document.
fail	function	undefined	This function gets called when the signing process failed.
success	function	undefined	This function gets called when the signing process succeeds.
finished	function	undefined	This function gets called when the signing process has either failed or succeeded. This means that this function gets called always, no matter the authentication result. For example, it can be useful to hide a loading spinner at the end of the authentication process or to do some other clean up work.

Freja eID Signature

Supported signature options: Seal-based AdES, QES, AdES

// Seal-based AdES
eidEasyClient.signature.frejaSimpleSignature.start({
  countryCode: 'AT', // required
  idcode: '1100110055', // required
  started: (result) => {
    // do something
  },
  fail: (result) => {
    // do something
  },
  success: (result) => {
    // do something
  },
  finished: (result) => {
    // do something
  },
});
// AdES
eidEasyClient.signature.frejaAdvancedSignature.start({
  countryCode: 'AT', // required
  idcode: '1100110055', // required
  started: (result) => {
    // do something
  },
  fail: (result) => {
    // do something
  },
  success: (result) => {
    // do something
  },
  finished: (result) => {
    // do something
  },
});
// QES
eidEasyClient.signature.frejaQesSignature.start({
  countryCode: 'AT', // required
  idcode: '1100110055', // required
  started: (result) => {
    // do something
  },
  fail: (result) => {
    // do something
  },
  success: (result) => {
    // do something
  },
  finished: (result) => {
    // do something
  },
});

Freja eID signing settings

Option	Type	Default	Description
idcode	string	undefined	Required. End user's ID code
countryCode	string	undefined	Required. ISO 3166-1 alpha-2 code of the country where the user has registered their Mobile ID account
started	function	undefined	This function gets called when the signing process has started. The argument object of this function contains the transaction id (response.data.transaction_id) that the end user sees on their device. You should display this code in your app so that the user can be sure that they are signing the right document.
fail	function	undefined	This function gets called when the signing process failed.
success	function	undefined	This function gets called when the signing process succeeds.
finished	function	undefined	This function gets called when the signing process has either failed or succeeded. This means that this function gets called always, no matter the authentication result. For example, it can be useful to hide a loading spinner at the end of the authentication process or to do some other clean up work.

Finish Trust Network (FTN) signature

FTN is an OAuth2 based method, so the user gets redirected to the FTN page where they can complete the signing process. Available signature options: seal-based AdES, AdES, QES

// seal-based AdES
eidEasyClient.signature.ftnSignature.start({
   countryCode: 'FI', // required
   redirect: (context) => {
      console.log(context);
      // you can do the redirect here yourself should you wish so
      // window.location.href = context.redirectUrl;
      return {
         data: null,
      };
   },
});

// AdES
eidEasyClient.signature.ftnAdvancedFullSignature.start({
  countryCode: 'FI', // required
  redirect: (context) => {
    console.log(context);
    // you can do the redirect here yourself should you wish so
    // window.location.href = context.redirectUrl;
    return {
      data: null,
    };
  },
});

// QES
eidEasyClient.signature.ftnQesSignature.start({
  countryCode: 'FI', // required
  phone: '+37200003311', // required
  email: 'user@ftn.fi', // required
  redirect: (context) => {
    console.log(context);
    // you can do the redirect here yourself should you wish so
    // window.location.href = context.redirectUrl;
    return {
      data: null,
    };
  },
});

Finish Trust Network signing settings

Option	Type	Default	Description
countryCode	string	undefined	Required. ISO 3166-1 alpha-2 code of the country where user registered Trust Network account. Currently available in Finland (FI)
phone	string	undefined	Required (only for QES signature). End user's phone number, must have the country code prefixed with a '+' sign, e.g. +37200000766
email	string	undefined	Required (only for QES signature). End user's email used on Trust Network
redirect	function	undefined	You can use this setting to override the default redirection functionality

GB OneID AdES signature

OneID is an OAuth2 based method, so the user gets redirected to the OneID page where they can complete the signing process.

eidEasyClient.signature.gbOneIdAdvancedSignature.start({
   countryCode: 'GB', // required
   redirect: (context) => {
      console.log(context);
      // you can do the redirect here yourself should you wish so
      // window.location.href = context.redirectUrl;
      return {
         data: null,
      };
   },
});

GB OneID AdES signing settings

Option	Type	Default	Description
countryCode	string	undefined	Required. ISO 3166-1 alpha-2 code of the country where user registered OneID account. Currently available in Great Britain (GB)
redirect	function	undefined	You can use this setting to override the default redirection functionality

Signing with Finnish Banks and Mobile ID

This is done through a redirect, so the user gets redirected to a view where they will see all the buttons for all the available Finnish Banks and the Mobile ID button. They then choose their preferred method and complete the signing process.

eidEasyClient.signature.ftnSignature.start({
   redirect: (context) => {
      console.log(context);
      // you can do the redirect here yourself should you wish so
      // window.location.href = context.redirectUrl;
      return {
         data: null,
      };
   },
});

Finnish Banks and Mobile ID signing settings

Option	Type	Default	Description
redirect	function	undefined	You can use this setting to override the default redirection functionality

Google signature

Google Signature is an OAuth2 based method, so the user gets redirected to the Google page where they can complete the signing process.

eidEasyClient.signature.googleSignature.start({
   redirect: (context) => {
      console.log(context);
      // you can do the redirect here yourself should you wish so
      // window.location.href = context.redirectUrl;
      return {
         data: null,
      };
   },
});

Google signing settings

Option	Type	Default	Description
redirect	function	undefined	You can use this setting to override the default redirection functionality

GSE Gestión de Seguridad Electrónica AdES signature

GSE Signature is an OAuth2 based method, so the user gets redirected to the GSE page where they can complete the signing process.

eidEasyClient.signature.gseAdvSignature.start({
   countryCode: 'CO',
   redirect: (context) => {
      console.log(context);
      // you can do the redirect here yourself should you wish so
      // window.location.href = context.redirectUrl;
      return {
         data: null,
      };
   },
});

GSE signing settings

Option	Type	Default	Description
countryCode	string	undefined	Required. ISO 3166-1 alpha-2 code of the country where account is registered. Currently available only in Columbia (CO)
redirect	function	undefined	You can use this setting to override the default redirection functionality

Halcom QES

eidEasyClient.signature.halcomQesSignature.start({
   username: 'user', // required
   phone: '+37200998877', // required
   email: 'halcom@user.com', // required
   countryCode: 'SI', // required
   started: (result) => {
     if (result.data && result.data.challenge) {
       // do something with the result
       // e.g. display the result.data.challenge code
     }
   },
   fail: (error) => {
      // do something with the error
   },
   success: (result) => {
      // do something with the result
   },
   finished: () => {
      // the process has finished, you can do some clean up like hiding a loader here
   },
});

Halcom settings

Option	Type	Default	Description
username	string	undefined	Required. End user's Halcom's username
email	string	undefined	Required. End user's Halcom's email
phone	string	undefined	Required. End user's phone number, must have the country code prefixed with a '+' sign, e.g. +37200000766
countryCode	string	undefined	Required. ISO 3166-1 alpha-2 code of the country where the user has registered their account. Currently supported in Slovenia (SI)
started	function	undefined	This function gets called when the signing process has started. The argument object of this function may contain the security challenge code (response.data.challenge) that the end user sees on their device. In case the signer has not approved the transaciton yet, it contains the session token. If challenge code is present, you should display it in your app so that the user can be sure that they are signing the right document.
fail	function	undefined	This function gets called when the signing process failed.
success	function	undefined	This function gets called when the signing process succeeds.
finished	function	undefined	This function gets called when the signing process has either failed or succeeded. This means that this function gets called always, no matter the authentication result. For example, it can be useful to hide a loading spinner at the end of the authentication process or to do some other clean up work.

Harica QES signature

// QES
eidEasyClient.signature.ftnQesSignature.start({
  countryCode: 'GR', // required
  username: 'user', // required
  password: 'pass',
  otpCode: '123456',
  started: (result) => {
    // do somthing
  },
  fail: (result) => {
    // do somthing
  },
  success: (result) => {
    // do somthing
  },
  finished: (result) => {
    // do somthing
  },
});

Harica signing settings

Option	Type	Default	Description
countryCode	string	undefined	Required. ISO 3166-1 alpha-2 code of the country where user registered Harica account. Currently available in Greece (GR)
username	string	undefined	Required. End user's Harica's username
password	string	undefined	Required. End user's Harica's password
otpCode	string	undefined	Required. End user's OTP code
started	function	undefined	This function gets called when the signing process has started. The argument object of this function may contain the security challenge code (response.data.challenge) that the end user sees on their device. In case the signer has not approved the transaciton yet, it contains the session token. If challenge code is present, you should display it in your app so that the user can be sure that they are signing the right document.
fail	function	undefined	This function gets called when the signing process failed.
success	function	undefined	This function gets called when the signing process succeeds.
finished	function	undefined	This function gets called when the signing process has either failed or succeeded. This means that this function gets called always, no matter the authentication result. For example, it can be useful to hide a loading spinner at the end of the authentication process or to do some other clean up work.

ID Card: EE, BE, HR, CZ, FI, LV, LT

eidEasyClient.signature.idCardSignature.start({
   countryCode: 'EE', // required
   iframeHolder: document.getElementById('idCardIframeHolder'), // Required. DOM element whose content gets replaced with an iframe (this iframe will be used to get the signing certificates from the id card)
   fail: (error) => {
      // do something with the error
   },
   success: (result) => {
      // do something with the result
   },
   finished: () => {
      // the process has finished, you can do some clean up like hiding a loader here
   },
});

idCard signing settings

Option	Type	Default	Description
countryCode	string	undefined	Required. ISO 3166-1 alpha-2 code of the country that issued the id card
iframeHolder	DOM element	undefined	Required. DOM element whose content gets replaced with an iframe (this iframe will be used to get the signing certificates from the id card)
fail	function	undefined	This function gets called when the signing process failed.
success	function	undefined	This function gets called when the signing process succeeds.
finished	function	undefined	This function gets called when the signing process has either failed or succeeded. This means that this function gets called always, no matter the authentication result. For example, it can be useful to hide a loading spinner at the end of the authentication process or to do some other clean up work.

IDIN SES

IDIN is an OAuth2 based method, so the user gets redirected to the IDIN page where they can complete the signing process.

eidEasyClient.signature.idinSignature.start({
   countryCode: 'NL',
   redirect: (context) => {
      console.log(context);
      // you can do the redirect here yourself should you wish so
      // window.location.href = context.redirectUrl;
      return {
         data: null,
      };
   },
});

IDIN signing settings

Option	Type	Default	Description
countryCode	string	undefined	Required. ISO 3166-1 alpha-2 code of the country where account is registered. Currently available only in Netherland (NL)
redirect	function	undefined	You can use this setting to override the default redirection functionality

Itsme QES

Itsme is an OAuth2 based method, so the user gets redirected to the Itsme page where they can complete the signing process.

eidEasyClient.signature.itsmeQesSignature.start({
   countryCode: 'BE',
   redirect: (context) => {
      console.log(context);
      // you can do the redirect here yourself should you wish so
      // window.location.href = context.redirectUrl;
      return {
         data: null,
      };
   },
});

Itsme signing settings

Option	Type	Default	Description
countryCode	string	undefined	Required. ISO 3166-1 alpha-2 code of the country where account is registered.
redirect	function	undefined	You can use this setting to override the default redirection functionality

Local certificate

We supported next signature options: QES, AdES, Unverified AdES

// QES
eidEasyClient.signature.certStoreQesSignature.start({
   countryCode: 'FR',
   iframeHolder: document.getElementById('localCertIframeHolder'), // Required. DOM element whose content gets replaced with an iframe (this iframe will be used to get the signing certificates from the id card)
   fail: (error) => {
      // do something with the error
   },
   success: (result) => {
      // do something with the result
   },
   finished: () => {
      // the process has finished, you can do some clean up like hiding a loader here
   },
});
// AdES
eidEasyClient.signature.certStoreAdvancedSignature.start({
  countryCode: 'FR',
  iframeHolder: document.getElementById('localCertIframeHolder'), // Required. DOM element whose content gets replaced with an iframe (this iframe will be used to get the signing certificates from the id card)
  fail: (error) => {
    // do something with the error
  },
  success: (result) => {
    // do something with the result
  },
  finished: () => {
    // the process has finished, you can do some clean up like hiding a loader here
  },
});
// Unverified AdES
eidEasyClient.signature.certStoreAdvancedUnverifiedSignature.start({
  countryCode: 'FR',
  iframeHolder: document.getElementById('localCertIframeHolder'), // Required. DOM element whose content gets replaced with an iframe (this iframe will be used to get the signing certificates from the id card)
  fail: (error) => {
    // do something with the error
  },
  success: (result) => {
    // do something with the result
  },
  finished: () => {
    // the process has finished, you can do some clean up like hiding a loader here
  },
});

Local certificate signature settings

Option	Type	Default	Description
countryCode	string	undefined	Required. ISO 3166-1 alpha-2 code of the country that issued certificate.
iframeHolder	DOM element	undefined	Required. DOM element whose content gets replaced with an iframe (this iframe will be used to get the signing certificates from the connected USB token)
fail	function	undefined	This function gets called when the signing process failed.
success	function	undefined	This function gets called when the signing process succeeds.
finished	function	undefined	This function gets called when the signing process has either failed or succeeded. This means that this function gets called always, no matter the authentication result. For example, it can be useful to hide a loading spinner at the end of the authentication process or to do some other clean up work.

LT ID QES

eidEasyClient.signature.smartIdSignature.start({
   idcode: '10101010005', // required
   countryCode: 'EE', // required
   started: (result) => {
     if (result.data && result.data.challenge) {
       // do something with the result
       // e.g. display the result.data.challenge code
     }
   },
   fail: (error) => {
      // do something with the error
   },
   success: (result) => {
      // do something with the result
   },
   finished: () => {
      // the process has finished, you can do some clean up like hiding a loader here
   },
});

LT ID QES settings

Option	Type	Default	Description
idcode	string	undefined	Required. End user's personal identification code
countryCode	string	undefined	Required. ISO 3166-1 alpha-2 code of the country where the user has registered their LT ID account
started	function	undefined	This function gets called when the signing process has started. The argument object of this function may contain the security challenge code (response.data.challenge) that the end user sees on their device. In case the signer has not approved the transaciton yet, it contains the session token. If challenge code is present, you should display it in your app so that the user can be sure that they are signing the right document.
fail	function	undefined	This function gets called when the signing process failed.
success	function	undefined	This function gets called when the signing process succeeds.
finished	function	undefined	This function gets called when the signing process has either failed or succeeded. This means that this function gets called always, no matter the authentication result. For example, it can be useful to hide a loading spinner at the end of the authentication process or to do some other clean up work.

Mobile ID

eidEasyClient.signature.mobileIdSignature.start({
   idcode: '60001019906', // required
   phone: '+37200000766', // required
   countryCode: 'EE', // required
   started: (result) => {
      // do something with the result
      // e.g. display the result.data.challenge code
   },
   fail: (error) => {
      // do something with the error
   },
   success: (result) => {
      // do something with the result
   },
   finished: () => {
      // the process has finished, you can do some clean up like hiding a loader here
   },
});

mobileId signing settings

Option	Type	Default	Description
idcode	string	undefined	Required. End user's personal identification code
phone	string	undefined	Required. End user's phone number, must have the country code prefixed with a '+' sign, e.g. +37200000766
countryCode	string	undefined	Required. ISO 3166-1 alpha-2 code of the country where the user has registered their Mobile ID account
started	function	undefined	This function gets called when the signing process has started. The argument object of this function contains the security challenge code (response.data.challenge) that the end user sees on their device. You should display this code in your app so that the user can be sure that they are signing the right document.
fail	function	undefined	This function gets called when the signing process failed.
success	function	undefined	This function gets called when the signing process succeeds.
finished	function	undefined	This function gets called when the signing process has either failed or succeeded. This means that this function gets called always, no matter the authentication result. For example, it can be useful to hide a loading spinner at the end of the authentication process or to do some other clean up work.

MojeId QES

MojeId is an OAuth2 based method, so the user gets redirected to the MojeId page where they can complete the signing process.

eidEasyClient.signature.mojeIdSignature.start({
   countryCode: 'CZ',
   redirect: (context) => {
      console.log(context);
      // you can do the redirect here yourself should you wish so
      // window.location.href = context.redirectUrl;
      return {
         data: null,
      };
   },
});

MojeId signing settings

Option	Type	Default	Description
countryCode	string	undefined	Required. ISO 3166-1 alpha-2 code of the country where account is registered. Currently available in Czech Republic (CZ)
redirect	function	undefined	You can use this setting to override the default redirection functionality

MSC TrustGate AdES

MSC TrustGate is an OAuth2 based method, so the user gets redirected to the MSC TrustGate page where they can complete the signing process.

eidEasyClient.signature.mscTrustGateSignature.start({
   countryCode: 'MY',
   redirect: (context) => {
      console.log(context);
      // you can do the redirect here yourself should you wish so
      // window.location.href = context.redirectUrl;
      return {
         data: null,
      };
   },
});

MSC TrustGate signing settings

Option	Type	Default	Description
countryCode	string	undefined	Required. ISO 3166-1 alpha-2 code of the country where account is registered. Currently available in Malaysia (MY)
redirect	function	undefined	You can use this setting to override the default redirection functionality

One Time Password (OTP) signature

With OTP, eID Easy will send the user either an email or sms (depending on with which parameters you initiate the flow) that contains a one time password. You then ask the user to enter that OTP in your application and then provide it to the otpSignature module.

eidEasyClient.signature.otpSignature.start({
   smsToken: '123455',
   emailToken: '873nf7ssorwdm8e',
   fail: (error) => {
      // do something with the error
   },
   success: (result) => {
      // do something with the result
   },
   finished: () => {
      // the process has finished, you can do some clean up like hiding a loader here
   },
});

OTP signing settings

Option	Type	Default	Description
smsToken	string	undefined	The token (OTP) that the user receives via sms.
emailToken	string	undefined	The token (OTP) that the user receives via email.
fail	function	undefined	This function gets called when the signing process failed.
success	function	undefined	This function gets called when the signing process succeeds.
finished	function	undefined	This function gets called when the signing process has either failed or succeeded. This means that this function gets called always, no matter the authentication result. For example, it can be useful to hide a loading spinner at the end of the authentication process or to do some other clean up work.

SimplySign QES

SimplySign is an OAuth2 based method, so the user gets redirected to the SimplySign page where they can complete the signing process.

eidEasyClient.signature.simplySignQesSignature.start({
   countryCode: 'PL',
   redirect: (context) => {
      console.log(context);
      // you can do the redirect here yourself should you wish so
      // window.location.href = context.redirectUrl;
      return {
         data: null,
      };
   },
});

SimplySign signing settings

Option	Type	Default	Description
countryCode	string	undefined	Required. ISO 3166-1 alpha-2 code of the country where account is registered. Currently available in Poland (PL)
redirect	function	undefined	You can use this setting to override the default redirection functionality

Smart-ID

eidEasyClient.signature.smartIdSignature.start({
   idcode: '10101010005', // required
   countryCode: 'EE', // required
   waitForChallengeCode: false, // required
   started: (result) => {
     if (result.data && result.data.challenge) {
       // do something with the result
       // e.g. display the result.data.challenge code
     }
   },
   onTryComplete: (result) => {
     if (result.data && result.data.challenge) {
       // do something with the result
       // e.g. display the result.data.challenge code
     }
   },
   fail: (error) => {
      // do something with the error
   },
   success: (result) => {
      // do something with the result
   },
   finished: () => {
      // the process has finished, you can do some clean up like hiding a loader here
   },
});

smartId identification settings

Option	Type	Default	Description
idcode	string	undefined	Required. End user's personal identification code
waitForChallengeCode	boolean	true	Required. This should be always set to false. Value true is meant for backwards compatibilty for legacy integrations only.
countryCode	string	undefined	Required. ISO 3166-1 alpha-2 code of the country where the user has registered their Smart-ID account
started	function	undefined	This function gets called when the signing process has started. The argument object of this function may contain the security challenge code (response.data.challenge) that the end user sees on their device. In case the signer has not approved the transaciton yet, it contains the session token. If challenge code is present, you should display it in your app so that the user can be sure that they are signing the right document.
onTryComplete	function	undefined	This function gets called when the browser client polls for the signign session status. The argument object of this function may contain the security challenge code (response.data.challenge) that the end user sees on their device. In case the signer has not approved the transaciton yet, it contains the session token. If challenge code is present, you should display it in your app so that the user can be sure that they are signing the right document.
fail	function	undefined	This function gets called when the signing process failed.
success	function	undefined	This function gets called when the signing process succeeds.
finished	function	undefined	This function gets called when the signing process has either failed or succeeded. This means that this function gets called always, no matter the authentication result. For example, it can be useful to hide a loading spinner at the end of the authentication process or to do some other clean up work.

Spain Lleida AdES

eidEasyClient.signature.esLleidaAdvSignature.start({
   countryCode: 'ES', // required
   username: 'user', // required
   signingPin: '1234', // required
   started: (response) => {
      // do something with the result
   },
   fail: (error) => {
      // do something with the error
   },
   success: (result) => {
      // do something with the result
   },
   finished: () => {
      // the process has finished, you can do some clean up like hiding a loader here
   },
});

Spain Lleida signing settings

Option	Type	Default	Description
countryCode	string	undefined	Required. ISO 3166-1 alpha-2 code of the country where the user has registered their Chave Movel account. Currently, only Portugal (PT) is supported.
user	string	undefined	Required. User's Lleida username
signingPin	string	undefined	Required. End user's signing PIN
started	function	undefined	This function gets called when the signing process has started. The argument object of this function contains the qr code and redirectUrl. You should display QR code image and make it clickable for mobile device users. QR code should be scanned with Diia application.
fail	function	undefined	This function gets called when the signing process failed.
success	function	undefined	This function gets called when the signing process succeeds.
finished	function	undefined	This function gets called when the signing process has either failed or succeeded. This means that this function gets called always, no matter the authentication result. For example, it can be useful to hide a loading spinner at the end of the authentication process or to do some other clean up work.

SPID QES

eidEasyClient.signature.spidQesSignature.start({
   phone: '+37200998877', // required
   email: 'halcom@user.com', // required
   countryCode: 'SI', // required
   started: (result) => {
     if (result.data && result.data.challenge) {
       // do something with the result
       // e.g. display the result.data.challenge code
     }
   },
   fail: (error) => {
      // do something with the error
   },
   success: (result) => {
      // do something with the result
   },
   finished: () => {
      // the process has finished, you can do some clean up like hiding a loader here
   },
});

SPID settings

Option	Type	Default	Description
email	string	undefined	Required. End user's SPID's email
phone	string	undefined	Required. End user's phone number, must have the country code prefixed with a '+' sign, e.g. +37200000766
countryCode	string	undefined	Required. ISO 3166-1 alpha-2 code of the country where the user has registered their account. Currently supported in Slovenia (SI)
started	function	undefined	This function gets called when the signing process has started. The argument object of this function may contain the security challenge code (response.data.challenge) that the end user sees on their device. In case the signer has not approved the transaciton yet, it contains the session token. If challenge code is present, you should display it in your app so that the user can be sure that they are signing the right document.
fail	function	undefined	This function gets called when the signing process failed.
success	function	undefined	This function gets called when the signing process succeeds.
finished	function	undefined	This function gets called when the signing process has either failed or succeeded. This means that this function gets called always, no matter the authentication result. For example, it can be useful to hide a loading spinner at the end of the authentication process or to do some other clean up work.

Swedish BankId signature

Swedish BankId is an OAuth2 based method, so the user gets redirected to the bank page where they can complete the signing process. Available signature options: "light" AdES, AdES, QES

eidEasyClient.signature.seBankIdSignature.start({
   countryCode: 'SE', // required
   redirect: (context) => {
      console.log(context);
      // you can do the redirect here yourself should you wish so
      // window.location.href = context.redirectUrl;
      return {
         data: null,
      };
   },
});

// light AdES
eidEasyClient.signature.seBankIdAdvancedHashSignature.start({
  countryCode: 'SE', // required
  redirect: (context) => {
    console.log(context);
    // you can do the redirect here yourself should you wish so
    // window.location.href = context.redirectUrl;
    return {
      data: null,
    };
  },
});

// AdES
eidEasyClient.signature.seBankIdAdvancedSignature.start({
  countryCode: 'SE', // required
  redirect: (context) => {
    console.log(context);
    // you can do the redirect here yourself should you wish so
    // window.location.href = context.redirectUrl;
    return {
      data: null,
    };
  },
});

// QES
eidEasyClient.signature.seBankIdQesSignature.start({
  countryCode: 'SE', // required
  redirect: (context) => {
    console.log(context);
    // you can do the redirect here yourself should you wish so
    // window.location.href = context.redirectUrl;
    return {
      data: null,
    };
  },
});

Swedish BankId signing settings

Option	Type	Default	Description
countryCode	string	undefined	Required. ISO 3166-1 alpha-2 code of the country where user registered bank account. Currently available in Sweden (SE)
redirect	function	undefined	You can use this setting to override the default redirection functionality

Swisscom QES

eidEasyClient.signature.swissComQesSignature.start({
   phone: '+37200334455', // required
   countryCode: 'CH', // required
   started: (result) => {
     if (result.data && result.data.challenge) {
       // do something with the result
       // e.g. display the result.data.challenge code
     }
   },
   fail: (error) => {
      // do something with the error
   },
   success: (result) => {
      // do something with the result
   },
   finished: () => {
      // the process has finished, you can do some clean up like hiding a loader here
   },
});

Swisscom settings

Option	Type	Default	Description
phone	string	undefined	Required. End user's phone number, must have the country code prefixed with a '+' sign, e.g. +37200000766
countryCode	string	undefined	Required. ISO 3166-1 alpha-2 code of the country where the user has registered their Smart-ID account
started	function	undefined	This function gets called when the signing process has started. The argument object of this function may contain the security challenge code (response.data.challenge) that the end user sees on their device. In case the signer has not approved the transaciton yet, it contains the session token. If challenge code is present, you should display it in your app so that the user can be sure that they are signing the right document.
fail	function	undefined	This function gets called when the signing process failed.
success	function	undefined	This function gets called when the signing process succeeds.
finished	function	undefined	This function gets called when the signing process has either failed or succeeded. This means that this function gets called always, no matter the authentication result. For example, it can be useful to hide a loading spinner at the end of the authentication process or to do some other clean up work.

SwissID QES

eidEasyClient.signature.swissComQesSignature.start({
   email: 'some@user.com', // required
   countryCode: 'CH', // required
   started: (result) => {
     if (result.data && result.data.challenge) {
       // do something with the result
       // e.g. display the result.data.challenge code
     }
   },
   fail: (error) => {
      // do something with the error
   },
   success: (result) => {
      // do something with the result
   },
   finished: () => {
      // the process has finished, you can do some clean up like hiding a loader here
   },
});

SwissID settings

Option	Type	Default	Description
email	string	undefined	Required. End user's valid email
countryCode	string	undefined	Required. ISO 3166-1 alpha-2 code of the country where the user has registered their Smart-ID account
started	function	undefined	This function gets called when the signing process has started. The argument object of this function may contain the security challenge code (response.data.challenge) that the end user sees on their device. In case the signer has not approved the transaciton yet, it contains the session token. If challenge code is present, you should display it in your app so that the user can be sure that they are signing the right document.
fail	function	undefined	This function gets called when the signing process failed.
success	function	undefined	This function gets called when the signing process succeeds.
finished	function	undefined	This function gets called when the signing process has either failed or succeeded. This means that this function gets called always, no matter the authentication result. For example, it can be useful to hide a loading spinner at the end of the authentication process or to do some other clean up work.

TrustAsia AdES

TrustAsia is an OAuth2 based method, so the user gets redirected to the TrustAsia page where they can complete the signing process.

eidEasyClient.signature.trustAsiaSignature.start({
   countryCode: 'CN',
   redirect: (context) => {
      console.log(context);
      // you can do the redirect here yourself should you wish so
      // window.location.href = context.redirectUrl;
      return {
         data: null,
      };
   },
});

TrustAsia signing settings

Option	Type	Default	Description
countryCode	string	undefined	Required. ISO 3166-1 alpha-2 code of the country where account is registered. Currently available in China (CN)
redirect	function	undefined	You can use this setting to override the default redirection functionality

Trans Sped QES signature

Trans Sped is an OAuth2 based method, so the user gets redirected to the Trans Sped page where they can complete the signing process.

eidEasyClient.signature.transSpedQesSignature.start({
   countryCode: 'RO',
   redirect: (context) => {
      console.log(context);
      // you can do the redirect here yourself should you wish so
      // window.location.href = context.redirectUrl;
      return {
         data: null,
      };
   },
});

Trans Sped signing settings

Option	Type	Default	Description
countryCode	string	undefined	Required. ISO 3166-1 alpha-2 code of the country where account is registered.
redirect	function	undefined	You can use this setting to override the default redirection functionality

Uanataca QES

eidEasyClient.signature.uanatacaQesSignature.start({
   countryCode: 'CH', // required
   username: 'user', // required
   password: 'pass', // required
   pin: '1234', // required
   started: (result) => {
     // do something
   },
   confirmationCodeRequest: (result, resolve) => {
     // take care of confirmation code
   },
   fail: (result) => {
     // do something
   },
   success: (result) => {
     // do something
   },
   finished: (result) => {
     // do something
   },
});

Uanataca settings

Option	Type	Default	Description
countryCode	string	undefined	Required. ISO 3166-1 alpha-2 code of the country where the user has registered their Smart-ID account
username	string	undefined	Required. End user's Uanataca username
password	string	undefined	Required. End user's Uanataca password
pin	string	undefined	Required. End user's pin code
started	function	undefined	This function gets called when the signing process has started. The argument object of this function may contain the security challenge code (response.data.challenge) that the end user sees on their device. In case the signer has not approved the transaciton yet, it contains the session token. If challenge code is present, you should display it in your app so that the user can be sure that they are signing the right document.
confirmationCodeRequest	function	undefined	This function gets called when confirmation code has been received.
fail	function	undefined	This function gets called when the signing process failed.
success	function	undefined	This function gets called when the signing process succeeds.
finished	function	undefined	This function gets called when the signing process has either failed or succeeded. This means that this function gets called always, no matter the authentication result. For example, it can be useful to hide a loading spinner at the end of the authentication process or to do some other clean up work.

Yes.com QES

Yes.com signing is a redirect based method, so the user gets redirected to the Yes.com view where they can use their smartphone to complete the signing process.

eidEasyClient.signature.yesComQesSignature.start({
   countryCode: 'DE', // required
   redirect: (context) => {
      console.log(context);
      // you can do the redirect here yourself should you wish so
      // window.location.href = context.redirectUrl;
      return {
         data: null,
      };
   },
});

Yes.com signing settings

Option	Type	Default	Description
countryCode	string	undefined	Required. ISO 3166-1 alpha-2 code of the country where the user has registered their Yes.com account. Currently available only for Germany (DE)
redirect	function	undefined	You can use this setting to override the default redirection functionality

ZealiD QES

ZealId signing is a redirect based method, so the user gets redirected to the Zeal ID view where they can use their smartphone to complete the signing process.

eidEasyClient.signature.zealIdSignature.start({
   countryCode: 'EE', // required
   redirect: (context) => {
      console.log(context);
      // you can do the redirect here yourself should you wish so
      // window.location.href = context.redirectUrl;
      return {
         data: null,
      };
   },
});

ZealiD signing settings

Option	Type	Default	Description
countryCode	string	undefined	Required. ISO 3166-1 alpha-2 code of the country where the user has registered their Zeal-ID account
redirect	function	undefined	You can use this setting to override the default redirection functionality