Integrating the IDScan product#

This documentation provides an overview of the IDScan SDK, covering its technical concepts and core functionalities. It serves as a reference for developers integrating identity verification into their applications.

Reading this documentation will allow you to easily get started on the integration into your applications.

Configuration is done in the Dashboard, where you can set up verification flows, manage SDK and API settings, and configure webhooks. The dashboard is accessible at https://[yourEnvironment].getid.ee

Different services can be used depending on the verification need, the collection of services to be used are grouped in a Flow. A flow can be created in the Dashboard and then used in the SDK or API.

Main Technical Concepts#

These are the most important aspects on how the system functions, please read through them to understand the system better.

  • IDScan is rendered seamlessly as part of your web and/or native application
  • IDScan can be embedded on any page and once verifications are completed you can re-direct anywhere
  • Results are usually available within seconds of user completion, but occasionally it might take up 30 seconds
  • Results from scanned documents are available via webhooks, the Dashboard and via the API
  • There are two different statuses on an ongoing verification process:
  • The processing status and can be either done or processing (available in processingStatus)
  • The status of an application can be either approved, declined, error or needs-review (available in overallResult.status)
  • Until processing status has been set to done, the application verification is in progress and status is subject to change
  • Final results are not visible on client side. Getting the results of the user verification is done by listening to the webhook or by querying the API
  • User data collected earlier at other stages in the application (such as first and last name) can be passed in the initialization to cross-reference with data extracted from the documents
  • The word "application" is used to describe a single verification process, i.e. the process of a user applying to be verified
  • The word "flow" is used to describe a set of services that are used in a verification process

Using the Product without SDK Integration#

In order to start testing there are four pre-configured SDK flows that can be used for testing without requiring integration. These flows cover the most common identity verification scenarios, allowing you to evaluate the system quickly. It is possible to modify flows or create your own.

  • IDverify-Liveness [Doc auto-capture, Passive liveness, Deepfake, Age estimation, Face similarity, AML, All security features]
  • IDscan [Doc auto-capture, AML, All security features]
  • FaceCheck [Passive liveness, Deepfake, Age estimation, Face similarity]
  • Proof-of-Address [Proof of Address]

It is possible to generate a one-time verification link via the API or Dashboard. Additionally, a public link can be activated for unlimited use via the URL.

  • Generate one-time - Open Dashboard - Flows - Generate and copy button (the URL will be copied in your Clipboard and you can paste it)
  • Generate Public URL - Open Dashboard - Flows - Open needed flow - Integration - Activate Public Link - Press Save (you can copy the URL and it will always be available unlimited times)
  • To create a one-time verification link using the API this is described in the next chapter

WebSDK/Android/iOS Application Integration#

This is a short conceptual overview of the general steps to integrate the product. The details for each steps are described in the following chapters.

  1. Get your unique SDK key - Retrieve your unique SDK key from the Dashboard Settings - SDK Configuration.
  2. Select which services you want to use - Select the Flow you want to use, either by using one of the pre-configured ones, or by creating a new in the Dashboard.
  3. Integrate The SDK - Load it into your web page, Android, or iOS application
  4. Create a session token – Use your backend to initiate and authorize a session with the SDK key.
  5. Trigger verification – Define how users start verification (e.g., button, link, or page load).
  6. Launch the SDK - This is done by calling the SDK and adding the session token. This will open up the UI and collect the data from the user.
  7. Handle the result - Handle verification outcomes (Approved, Needs review, Declined) via webhooks (preferred), API polling, or Dashboard review.
  8. (optional) Download the collected data - Retrieve all collected information via the webhook or the API.

Creating a standalone 12h valid link that can be added to an email, or sent to a user via other channels is possible via the API. This allows for a separate actionable verification link that can be sent anywhere without application integration.

  1. Get your API Key – Retrieve your API key from the Dashboard Settings - API Configuration.
  2. Create a verification request – Use the API to initiate a verification session and get a link.
  3. Receive results via webhook – Await updates on the verification by listening to webhooks.
  4. (optional) Retrieve status via API – Use the API to check the verification progress.
  5. (optional) Download the collected data - Retrieve all collected information via the webhook or the API.

Production and Test Environment#

There are two environments made available for the integration. Use the sandbox while integrating and testing, and switch to production when going live.

  • Production: https://[yourEnvironment].getid.ee
  • Sandbox: https://[yourEnvironment].sb.getid.dev

Please note that API, SDK and signature keys are different for the two environments.