Skip to content

Install

The IDLive® eKYC Toolkit is delivered as a set of Docker images via Amazon ECR. The current version of the servers and the docker pull commands for it are in your personal account on the customer portal.

Installing prerequisites

Since the eKYC API Gateway Server is distributed in a form of Docker image, you need to make sure that you have Docker Engine installed on your machine. If it's not, the best way to install it is to follow the official documentation.

Pulling the Docker images

Follow these steps to install images via the customer portal:

  1. Navigate to your personal account on the customer portal.
  2. Click the "Generate command" button.
  3. Wait for the command to be generated. Once ready, click the "Copy" button to copy the pull command.
  4. Use the copied command in Terminal or another tool.
  5. For the Evaluation version, a single command downloads all required Docker images at once. For the Production version, each server component is assumed to be deployed on a separate pod or host, so the Docker pull command must be generated individually for each server in the customer portal.

Use a Local Container Registry

For production deployments, we recommend pulling the images once and pushing them to your own local container registry (e.g., Harbor, AWS ECR, GitLab Container Registry, or a private Docker registry).

This ensures fast and reliable access to Docker images across your infrastructure, especially in environments using Kubernetes or automated scaling.

Access to our official container registry is provided for your convenience, but we do not guarantee its 24/7 availability. For critical deployments, using a local registry is strongly advised.