Skip to content

Using IDLive® eKYC Toolkit Server

Start containers

To simplify the deployment of the KYC solution consisting of five Docker containers, we have prepared a docker-compose configuration file and a script for starting the solution on Linux. Below are the detailed instructions along with the configuration files.

Docker Compose Configuration

The ekyc-docker-compose.yml file describes the configuration for running the various services of the IDLive® eKYC Toolkit:

version: "3.8"
services:
  ekyc-api:
    image: 561397722827.dkr.ecr.eu-west-1.amazonaws.com/growthproject/ekyc-gateway-api:1.1.0
    networks:
      - ekyc-network
    environment:
      DEFAULT_PAD_PIPELINE: "pad-r-1"
      DEFAULT_DFD_PIPELINE: "dfd-1"
      IDLF_SERVER_URL: "http://idlf-server:8080"
      IAD_SERVER_URL: "http://iad-server:8080"
      IDLD_SERVER_URL: "http://idld-server:8080"
      IDFM_SERVER_URL: "http://idfm-server:8080"
    ports:
      - 8080:8080
    depends_on:
      - idlf-server
      - iad-server
      - idld-server
      - idfm-server

  idlf-server:
    image: 561397722827.dkr.ecr.eu-west-1.amazonaws.com/facesdk/idface-server-all-prod:1.49.4
    deploy:
      restart_policy:
        condition: on-failure
        delay: 5s
        max_attempts: 3
        window: 120s
    networks:
      - ekyc-network
    environment:
      IDFACE_SERVER_AVAILABLE_PIPELINES: "pad-r-1,dfd-1"

  iad-server:
    image: 561397722827.dkr.ecr.eu-west-1.amazonaws.com/iadproject/iad-server-prod:2.3.4
    restart: always
    deploy:
      restart_policy:
        condition: on-failure
        delay: 5s
        max_attempts: 3
        window: 120s
    networks:
      - ekyc-network

  idld-server:
    image: 561397722827.dkr.ecr.eu-west-1.amazonaws.com/idlivedoc-server-prod-sr-pc-ps-dm:3.3.0
    restart: always
    deploy:
      restart_policy:
        condition: on-failure
        delay: 5s
        max_attempts: 3
        window: 120s
    networks:
      - ekyc-network
    environment:
      IDLIVEDOC_SERVER_AVAILABLE_PIPELINES: "default-sr,default-pc,default-ps,default-dm"

  idfm-server:
    image: 561397722827.dkr.ecr.eu-west-1.amazonaws.com/growthproject/facerecognition/idfacematch/idfacematch-server-prod:1.5.0
    restart: always
    deploy:
      restart_policy:
        condition: on-failure
        delay: 5s
        max_attempts: 3
        window: 120s
    networks:
      - ekyc-network
    environment:
      IDFM_SERVER_QDRANT_HOST: "qdrant"
    depends_on:
      - qdrant

  qdrant:
    image: qdrant/qdrant:latest
    restart: always
    networks:
      - ekyc-network
    environment:
      QDRANT__STORAGE__HNSW_INDEX__M: 64
      QDRANT__STORAGE__HNSW_INDEX__EF_CONSTRUCT: 600
      QDRANT__SEARCH__HNSW_INDEX__EF: 600
    volumes:
      - ./qdrant_data:/qdrant/storage

networks:
  ekyc-network:
    name: ekyc-network
    driver: bridge

This configuration sets up all necessary services with specific environment variables, ports, and restart policies to ensure reliable operation.

Starting the Solution

The following ekyc-start.sh script automates the startup process for the IDLive® eKYC Toolkit:

export COMPOSE_PROJECT_NAME=ekyc

docker compose -f "ekyc-docker-compose.yml" build
docker compose -f "ekyc-docker-compose.yml" up -d

To run the solution, follow these steps:

  1. Ensure Docker and Docker Compose are installed on your system.
  2. Save the ekyc-docker-compose.yml file and ekyc-start.sh script in the same directory.
  3. Open a terminal, navigate to the directory containing the files, and run the command:
./ekyc-start.sh

This command will build and start all the defined services in detached mode, allowing you to run the entire KYC solution with a single command.

By executing these steps, you will have the IDLive® eKYC Toolkit up and running, enabling you to integrate advanced KYC capabilities into your application seamlessly.

Using a License Server

The provided docker-compose.yml file is designed for Evaluation builds, which include a built-in time-limited license and do not require a License Server.

If you are using a Production setup with an external License Server, make sure to set the HASP_NETWORK_LICENSE_SERVER environment variable for each eKYC component in the Docker Compose file. For example:

environment:
  HASP_NETWORK_LICENSE_SERVER: "<license-server-address>"

Replace <license-server-address> with the address of your License Server.

See the Licensing documentation — Using the License Server in eKYC Components for details.

Previous versions

This section contains archived Docker Compose files for earlier versions of the IDLive® eKYC Toolkit. You can download any previous configuration and use it as needed.