Guide

Introduction

eideasy-browser-client is a handy tool that you can use to handle the client side parts of the identification and signing flows when using eID Easy API.

A typical signing implementation using the eID Easy API and the eideasy-browser-client would look like this:

  1. Prepare the files for signing by sending a server side request to the /prepare-files-for-signingopen in new window endpoint.
  2. /prepare-files-for-signing endpoint returns a docId.
  3. Create a browser client instance using the docId.
  4. Use any of the eideasy-browser-client's signing modules (e.g. idCardSignature, smartIdSignature, mobileIdSignature etc.) to complete the signing process.
  5. eID Easy server sends a POST request containing doc_id and signer_id to your configured "Signature notification URL" when the user has finished signing the document.

Installation

NPM

  1. Install with npm or Yarn:
yarn add @eid-easy/eideasy-browser-client
npm install @eid-easy/eideasy-browser-client
  1. Import createClient:
import createClient from '@eid-easy/eideasy-browser-client';
1

CDN

  1. Add the script tag:
<script src="https://cdn.jsdelivr.net/npm/@eid-easy/eideasy-browser-client@2.53.0/dist/eideasy-browser-client.js" integrity="sha256-HFfq8vHLrBrwHHwOge/a6QNPdOa90C2egVvedKD6PzM=" crossorigin="anonymous"></script>
1
  1. Use the eidEasyBrowserClient object to access createClient:
const createClient = window.eidEasyBrowserClient.createClient;
1
Last Updated: 11/15/2021, 2:01:30 PM