Open-Kyc comprises of two parts a REST layer and a r3Corda app, OPEN-Kyc is solely developed by Vibhav Tomar Purnashish Hazra Pranav Agarwal
In addition our project Open-Kyc consist of two parts in which one of the component relies upon r3Corda an Open Source app for private blockchain while submitting this application we were asked to push the source code to the repository so we had to push r3Corda's code and due to the this fact their are some contributors other than us (who made r3Corda app) being listed in our repository so please consider this fact that Open-Kyc app is strictly developed by us (Contributors of Open-Kyc) but due to the above reason there are some other r3Corda's contributors who are being listed, nevertheless this can be also verified by checking the Open-Kyc's commits array.
- Title: Open-KYC provides a solution for redudant kyc requests, all you need to do is sign-up once on the platform and get verified by any one of the Banks and then save yourself from filling those troublesome forms again, simply apply for KYC with click of a button.Open-Kyc is an Open-Source decentralized application running on r3Corda and a Nodejs server in the Back-end and Reactjs in the front-end, It can be easily integrated with your kyc portals too.
- Pre-Requisites
Node.js
Express.js
MongoDb
JavaScript
Reactjs
r3Corda
- Implemenation of the REST API
/user
Inserts the data provided by the user in the Data Base and takes care of login and signup activities.
/kyc
Provides the user with applying, checking status, getting details of their KYC's
/utilroutes
Provides the user with some additional functionalities of forgot-password, account-verification etc.
/trackingroutes
Provides the bank with the functionality of logging their transactions.
-
Sample URL
/user/register:
-
Method:
POST
-
Data Params
Required:
Name=[String]
email=[Email]
aadharno=[integer]
panno=[integer]
usertype (Bank or Client)=[String]
phone=[integer]
-
Success Response:
- Code: 200
Content:{sucess: "true", message: "Your Requested has been accepted" }
- Code: 200
-
Error Response:
- Code: 404 NOT FOUND
Content:{success: "false", message : "Could not process the request, Try again" }
- Code: 404 NOT FOUND
-
Handling a large number of Requests
- Load Balancing --> We will deploy the app on a kubernetes cluster and manage the load and traffic from there.
-
Sample Call
route.post("/", (req, res, next) => { try { res.send({sucess: true, message: resp.message}) } catch (err) { res.send({success: false, message: "Error in sample route" } })
-
Setting Up
- Install and setup
Nodejs
- Install and setup
Mongodb
- Install ans setup
r3Corda
- Fork and Clone the repository
https://github.com/reapedjuggler/AmexHack
-
Start the r3Corda server and deploy the nodes
-
Move into the project folder
cd server
-
Setup
.env
file -
Start the server
npm start server.js
The output should be
Server connected on Port 8000