Recognito
  • About RECOGNITO
  • Face Recognition SDK
    • Performance Overview
    • Integration Guide
      • Linux
        • Installation
        • API Reference
        • Licensing
        • Sample Application
      • Windows
        • Installation
        • API Reference
        • Licensing
        • Sample Application
      • Android
        • Installation
        • API Reference
        • Licensing
        • Sample Application
      • iOS
        • Installation
        • API Reference
        • Licensing
        • Sample Application
      • Flutter
        • Installation
        • API Reference
        • Licensing
        • Sample Application
  • Face Liveness Detection SDK
    • Performance Overview
    • Integration Guide
      • Linux
        • Installation
        • API Reference
        • Licensing
        • Sample Application
      • Windows
        • Installation
        • API Reference
        • Licensing
        • Sample Application
      • Android
        • Installation
        • API Reference
        • Licensing
        • Sample Application
      • iOS
        • Installation
        • API Reference
        • Licensing
        • Sample Application
      • Flutter
        • Installation
        • API Reference
        • Licensing
        • Sample Application
  • ID Document Recognition SDK
    • Performance Overview
    • Integration Guide
      • Linux
        • Installation
        • API Reference
        • Licensing
        • Sample Application
      • Android
        • Installation
        • API Reference
        • Licensing
        • Sample Application
      • iOS
        • Installation
        • API Reference
        • Licensing
        • Sample Application
  • ID Document Liveness Detection SDK
    • Performance Overview
    • Integration Guide
      • Linux
        • Installation
        • API Reference
        • Licensing
        • Sample Application
  • License Option
  • How to implement 1:N identification with RECOGNITO SDK
  • Contact & Support
Powered by GitBook
On this page
  • Docker
  • Installation
  • - Download
  • - Install dependencies
  • - Setting Up SDK License Key
  • Test
  • - Run Demo
  • - Test Flask Server APIs
  • - Test Gradio
  1. ID Document Recognition SDK
  2. Integration Guide
  3. Linux

Sample Application

Linux-ID Document Recognition SDK Flask, Gradio Demo

Docker

Pull the Docker image and run the container:

sudo docker pull recognito/id-ocr:latest
sudo docker run -it -e LICENSE_KEY="XXXXX-XXXXX-XXXXX-XXXXX" -p 8001:8000 -p 7861:7860 recognito/id-ocr:latest [OPTION --gradio(-g), --flask(-f)]

Installation

- Download

Download ID_SDK.zip

The Demo directory contains the following directories and files:

dependency\

Dependency files

engine\

SDK engine files

examples\

Sample images

flask\

Flask server side demo code

gradio\

Gradio demo code

Dockerfile

Dockerfile for building a Docker image

install.sh

Script for install environment

license.txt

License key file

run_demo.sh

Script for run demo

- Install dependencies

Run the install.sh script to install dependencies:

./install.sh

- Setting Up SDK License Key

  • Online Licensing: Set the online license key as an environment variable:

export LICENSE_KEY="XXXXX-XXXXX-XXXXX-XXXXX"
  • Offline Licensing: Copy the license.txt license file to the demo directory.


Test

- Run Demo

Run the demo script with the desired option:

./run_demo.sh [OPTION --gradio(-g), --flask(-f), --help(-h)]

- Test Flask Server APIs

To test the Flask Server API, you can use Postman. Here are the endpoints for testing:

POST /api/read_idcard

Extract data from ID card.

Parameters

image: image file for the front of ID card

image2: image file for the back of ID card

Response

data: OCR result

POST /api/read_idcard_base64

Extract data from ID card base64 images.

Parameters

image1: base64 image for the front image

image2: base64 image for the back image

Response

data: OCR result

- Test Gradio

Go to http://127.0.0.1:7860/ on a web browser.

PreviousLicensingNextAndroid

Last updated 16 days ago

Postman usage guide for Flask Demo
Gradio Demo