Skip to content

Latest commit

 

History

History
62 lines (41 loc) · 1.85 KB

README.md

File metadata and controls

62 lines (41 loc) · 1.85 KB
Raw

Build Status codecov

vl

vl is the verification layer of verifid, actually the core project that is responsible from verifying identity cards or passports. Basically it's a self deployed API which has 4 main endpoints. It runs on either Docker or Kubernetes as a container. All endpoints fit in just two controllers and all endpoints have detailly documented. vl relies on some other verifid and as well as other Open Source Python modules. vl uses Nginx as a load balancer and it's already configured in setup files.

This server was generated by the swagger-codegen project. By using the OpenAPI-Spec from a remote server, you can easily generate a server stub.

vl header

Endpoints

  • /user
    • /sendUserData
    • /verify
  • /image
    • /uploadIdentity
    • /uploadProfile

vl endpoints

Requirements

  • Python 3.5.2+

Usage

To run the vl server, please execute the following from the root directory

pip3 install -r requirements.txt
python3 -m vl

and open your browser to here

http://localhost:8080/v1/ui/

Your Swagger definition available here

http://localhost:8080/v1/swagger.json

Running with Docker

To run the server on a Docker container, please execute the following from the root directory

# building the image
docker build -t vl .

# starting up a container
docker run -p 5000:5000 vl