Skip to content

Latest commit

 

History

History
36 lines (27 loc) · 1.4 KB

README.md

File metadata and controls

36 lines (27 loc) · 1.4 KB
Raw

Jincor Verification Service

Jincor VERIFY Service

Jincor Verification is a service for verify users email, phone, and etc. The main responsibilities are:

  1. Interact with a service provider
  2. Validation of a received code

Take a look at our Wiki for more details.

API Endpoints Summary

For more details see the API docs

JWT_TOKEN should be passed for every API call in the HTTP headers, that was received from auth service.

  1. /methods/{METHOD}/actions/initiate [POST]
  2. /methods/{METHOD}/verifiers/{VERIFICATION_ID}/actions/validate [POST]
  3. /methods/{METHOD}/verifiers/{VERIFICATION_ID} [DELETE]

How to start development and run tests?

  1. Clone this repo.
  2. Run docker-compose build --no-cache.
  3. Run docker-compose up -d.
  4. To install dependencies run: docker-compose exec verify yarn.
  5. To run tests run: docker-compose exec verify yarn test.
  6. To build production image run docker-compose -f docker-compose.prod.yml build --no-cache.

How to generate docs?

  1. Install npm install -g aglio.
  2. Run mkdir /usr/local/lib/node_modules/aglio/node_modules/aglio-theme-olio/cache.
  3. Generate aglio --theme-variables cyborg --theme-template triple -i apiary.apib -o ./docs/index.html.