index.md

Client Encryption API documentation

This is an encryption library created by ReCheck devs team.

We are glad to receive any feedback you want to give us.

You can find the docs website here.

Table of Contents

• Overview
• Requirements
• Getting started
  • Exported functions
  • Application layer
  • Low level layer

Overview

This is a reference implementation of a protocol for end-to-end encryption with the Recheck services platform. It implements data storage, fetching and validation with a set of keypairs that support ethereum and aeterntiy digital signatures.

A Sequence Diagram

Requirements

• npm version 8.15 or above

• You will need to download the library from the node repository.

• npm i recheck-clientjs-library

Getting started

Exported functions

debug: setDebugMode,

Setting the debug either true or false.

init: init

Specify API token, host and blockchain network

login: login,

Returns a token that the user need in order to communicate with the server.

loginWithChallengeParams: loginWithChallengeParams,

Returns a token that the user need in order to communicate with the server. Has a parameter challenge. When the user is using our service, upon login into the system there is going to be a QR code that you have to scan. That will create a link between the server and the GUI and you will be prompted to the GUI file manager.

newKeyPair: newKeyPair

Creates a key pairs and recovery phrase

store: store

Encrypt, upload and register a file or any data

open: open

share: share

validate: validate

prepare: prepare

decrypt: decrypt

poll: poll

select: select

selection: getSelected

prepareSelection: prepareSelection

execSelection: execSelection

---

Application layer

The exported functions in better detail.

Over here

---

Low level layer

The base functions in better detail.

Over here