# viraljain7/backend architecture

> Architecture diagram of the GitHub repository viraljain7/backend, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-07). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/viraljain7/backend
- Repository: https://github.com/viraljain7/backend

## Overview

This is an Express API for merchant onboarding, KYC, product administration and Pine Labs payments. The main workflow is user authentication followed by business, director, document and identity verification steps, with persisted merchant records; administrators review KYC and manage products, while payment endpoints coordinate orders with Pine Labs. The graph reflects explicit app routing and source-index references. Several route/controller and integration details were not excerpted, so unsupported links are omitted.

Main entry points: [`src/app.js`](https://github.com/viraljain7/backend/blob/main/src/app.js) (Express application), [`src/models/User.js`](https://github.com/viraljain7/backend/blob/main/src/models/User.js) (User records), [`src/models/Director.js`](https://github.com/viraljain7/backend/blob/main/src/models/Director.js) (Director records), [`src/config/db.js`](https://github.com/viraljain7/backend/blob/main/src/config/db.js) (SQL database)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_entry["API entry"]
  node_app["Express application<br/>[app.js]"]
end

subgraph group_identity["Identity and onboarding"]
  node_auth["Authentication<br/>[auth.controller.js]"]
  node_entities["Merchant entities"]
  node_business["Business information"]
  node_directors["Director onboarding"]
  node_kyc["Document and KYC checks"]
  node_userdocs["User documents"]
end

subgraph group_operations["Administration"]
  node_adminreview["Admin KYC review"]
  node_adminproducts["Product administration"]
  node_adminnotify["Notifications"]
  node_adminip["IP administration<br/>[ip.controller.js]"]
end

subgraph group_payments["Payments"]
  node_payments["Payment orders"]
  node_webhook["Payment webhook"]
  node_pine["Pine Labs service"]
end

subgraph group_data["Persistence and services"]
  node_sql[("SQL database<br/>[db.js]")]
  node_user[("User records<br/>[User.js]")]
  node_director[("Director records<br/>[Director.js]")]
  node_documents[("User document records<br/>[UserDocument.js]")]
  node_products[("Product records<br/>[Product.js]")]
  node_notifications[("Notification records<br/>[Notifications.js]")]
  node_orders[("Payment order records<br/>[PineLabsOrder.js]")]
  node_paymentsdb[("Payment records<br/>[PineLabsPayment.js]")]
  node_storage["Object storage helper<br/>[r2Helper.js]"]
  node_verification["Verification helper"]
end

node_client(("API client"))

node_client -->|"sends requests"| node_app
node_app -->|"routes auth"| node_auth
node_app -->|"routes entities"| node_entities
node_app -->|"routes business info"| node_business
node_app -->|"routes KYC"| node_kyc
node_app -->|"routes directors"| node_directors
node_app -->|"routes documents"| node_userdocs
node_app -->|"routes admin KYC"| node_adminreview
node_app -->|"routes products"| node_adminproducts
node_app -->|"routes notifications"| node_adminnotify
node_app -->|"routes IP admin"| node_adminip
node_app -->|"routes payments"| node_payments
node_auth -->|"reads users"| node_user
node_auth -->|"runs transactions"| node_sql
node_auth -->|"resolves identity"| node_user
node_entities -->|"reads and updates"| node_user
node_entities -->|"uses director records"| node_director
node_entities -->|"uses product records"| node_products
node_entities -->|"uses documents"| node_documents
node_business -->|"updates business"| node_user
node_business -->|"uses director records"| node_director
node_directors -->|"updates user"| node_user
node_directors -->|"updates directors"| node_director
node_directors -->|"uploads files"| node_storage
node_kyc -->|"updates KYC"| node_user
node_kyc -->|"uses director records"| node_director
node_kyc -->|"uploads evidence"| node_storage
node_kyc -->|"checks identity"| node_verification
node_userdocs -->|"resolves user"| node_user
node_userdocs -->|"manages documents"| node_documents
node_userdocs -->|"uploads files"| node_storage
node_adminreview -->|"reviews user"| node_user
node_adminreview -->|"reviews directors"| node_director
node_adminproducts -->|"looks up users"| node_user
node_adminproducts -->|"manages products"| node_products
node_adminnotify -->|"manages notices"| node_notifications
node_adminnotify -->|"looks up users"| node_user
node_adminip -->|"looks up users"| node_user
node_payments -->|"manages orders"| node_orders
node_payments -->|"manages payments"| node_paymentsdb
node_payments -->|"calls service"| node_pine
node_webhook -->|"updates orders"| node_orders
node_webhook -->|"updates payments"| node_paymentsdb
node_user -->|"uses connection"| node_sql
node_director -->|"uses connection"| node_sql
node_documents -->|"uses connection"| node_sql
node_products -->|"uses connection"| node_sql
node_notifications -->|"uses connection"| node_sql

click node_app "https://github.com/viraljain7/backend/blob/main/src/app.js"
click node_auth "https://github.com/viraljain7/backend/blob/main/src/controllers/Auth/auth.controller.js"
click node_entities "https://github.com/viraljain7/backend/blob/main/src/controllers/Entities/entities.controller.js"
click node_business "https://github.com/viraljain7/backend/blob/main/src/controllers/Onboarding/BusinessInfo/businessInfo.controller.js"
click node_directors "https://github.com/viraljain7/backend/blob/main/src/controllers/Onboarding/Directors/directors.controller.js"
click node_kyc "https://github.com/viraljain7/backend/blob/main/src/controllers/Onboarding/DocKYC/docKYC.controller.js"
click node_userdocs "https://github.com/viraljain7/backend/blob/main/src/controllers/Onboarding/DocumentUpload/userDocument.controller.js"
click node_adminreview "https://github.com/viraljain7/backend/blob/main/src/controllers/Admin/KYC/adminKYC.controller.js"
click node_adminproducts "https://github.com/viraljain7/backend/blob/main/src/controllers/Admin/Product/product.controller.js"
click node_adminnotify "https://github.com/viraljain7/backend/blob/main/src/controllers/Admin/Notifications/notification.controller.js"
click node_adminip "https://github.com/viraljain7/backend/blob/main/src/controllers/Admin/IP/ip.controller.js"
click node_payments "https://github.com/viraljain7/backend/blob/main/src/controllers/Payment/PineLabs/Order/pineLabsOrder.controller.js"
click node_webhook "https://github.com/viraljain7/backend/blob/main/src/controllers/Payment/PineLabs/Webhook/pineLabsWebhook.controller.js"
click node_pine "https://github.com/viraljain7/backend/blob/main/src/Services/Pinelabs/pinelabs.service.js"
click node_sql "https://github.com/viraljain7/backend/blob/main/src/config/db.js"
click node_user "https://github.com/viraljain7/backend/blob/main/src/models/User.js"
click node_director "https://github.com/viraljain7/backend/blob/main/src/models/Director.js"
click node_documents "https://github.com/viraljain7/backend/blob/main/src/models/UserDocument.js"
click node_products "https://github.com/viraljain7/backend/blob/main/src/models/Product.js"
click node_notifications "https://github.com/viraljain7/backend/blob/main/src/models/Notifications.js"
click node_orders "https://github.com/viraljain7/backend/blob/main/src/models/PineLabsOrder.js"
click node_paymentsdb "https://github.com/viraljain7/backend/blob/main/src/models/PineLabsPayment.js"
click node_storage "https://github.com/viraljain7/backend/blob/main/src/utils/r2Helper.js"
click node_verification "https://github.com/viraljain7/backend/blob/main/src/utils/verificationHelper.js"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_app,node_client toneBlue
class node_auth,node_entities,node_business,node_directors,node_kyc,node_userdocs toneAmber
class node_adminreview,node_adminproducts,node_adminnotify,node_adminip toneMint
class node_payments,node_webhook,node_pine toneRose
class node_sql,node_user,node_director,node_documents,node_products,node_notifications,node_orders,node_paymentsdb,node_storage,node_verification toneIndigo
```

## Components

### API entry

- [Express application](https://github.com/viraljain7/backend/blob/main/src/app.js): `src/app.js`

### Identity and onboarding

- [Authentication](https://github.com/viraljain7/backend/blob/main/src/controllers/Auth/auth.controller.js): `src/controllers/Auth/auth.controller.js`
- [Merchant entities](https://github.com/viraljain7/backend/blob/main/src/controllers/Entities/entities.controller.js): `src/controllers/Entities/entities.controller.js`
- [Business information](https://github.com/viraljain7/backend/blob/main/src/controllers/Onboarding/BusinessInfo/businessInfo.controller.js): `src/controllers/Onboarding/BusinessInfo/businessInfo.controller.js`
- [Director onboarding](https://github.com/viraljain7/backend/blob/main/src/controllers/Onboarding/Directors/directors.controller.js): `src/controllers/Onboarding/Directors/directors.controller.js`
- [Document and KYC checks](https://github.com/viraljain7/backend/blob/main/src/controllers/Onboarding/DocKYC/docKYC.controller.js): `src/controllers/Onboarding/DocKYC/docKYC.controller.js`
- [User documents](https://github.com/viraljain7/backend/blob/main/src/controllers/Onboarding/DocumentUpload/userDocument.controller.js): `src/controllers/Onboarding/DocumentUpload/userDocument.controller.js`

### Administration

- [Admin KYC review](https://github.com/viraljain7/backend/blob/main/src/controllers/Admin/KYC/adminKYC.controller.js): `src/controllers/Admin/KYC/adminKYC.controller.js`
- [Product administration](https://github.com/viraljain7/backend/blob/main/src/controllers/Admin/Product/product.controller.js): `src/controllers/Admin/Product/product.controller.js`
- [Notifications](https://github.com/viraljain7/backend/blob/main/src/controllers/Admin/Notifications/notification.controller.js): `src/controllers/Admin/Notifications/notification.controller.js`
- [IP administration](https://github.com/viraljain7/backend/blob/main/src/controllers/Admin/IP/ip.controller.js): `src/controllers/Admin/IP/ip.controller.js`

### Payments

- [Payment orders](https://github.com/viraljain7/backend/blob/main/src/controllers/Payment/PineLabs/Order/pineLabsOrder.controller.js): `src/controllers/Payment/PineLabs/Order/pineLabsOrder.controller.js`
- [Payment webhook](https://github.com/viraljain7/backend/blob/main/src/controllers/Payment/PineLabs/Webhook/pineLabsWebhook.controller.js): `src/controllers/Payment/PineLabs/Webhook/pineLabsWebhook.controller.js`
- [Pine Labs service](https://github.com/viraljain7/backend/blob/main/src/Services/Pinelabs/pinelabs.service.js): `src/Services/Pinelabs/pinelabs.service.js`

### Persistence and services

- [SQL database](https://github.com/viraljain7/backend/blob/main/src/config/db.js): `src/config/db.js`
- [User records](https://github.com/viraljain7/backend/blob/main/src/models/User.js): `src/models/User.js`
- [Director records](https://github.com/viraljain7/backend/blob/main/src/models/Director.js): `src/models/Director.js`
- [User document records](https://github.com/viraljain7/backend/blob/main/src/models/UserDocument.js): `src/models/UserDocument.js`
- [Product records](https://github.com/viraljain7/backend/blob/main/src/models/Product.js): `src/models/Product.js`
- [Notification records](https://github.com/viraljain7/backend/blob/main/src/models/Notifications.js): `src/models/Notifications.js`
- [Payment order records](https://github.com/viraljain7/backend/blob/main/src/models/PineLabsOrder.js): `src/models/PineLabsOrder.js`
- [Payment records](https://github.com/viraljain7/backend/blob/main/src/models/PineLabsPayment.js): `src/models/PineLabsPayment.js`
- [Object storage helper](https://github.com/viraljain7/backend/blob/main/src/utils/r2Helper.js): `src/utils/r2Helper.js`
- [Verification helper](https://github.com/viraljain7/backend/blob/main/src/utils/verificationHelper.js): `src/utils/verificationHelper.js`

### Other components

- **API client**

## Connections

- API client → Express application: sends requests
- Express application → Authentication: routes auth (evidence: `src/app.js`)
- Express application → Merchant entities: routes entities (evidence: `src/app.js`)
- Express application → Business information: routes business info (evidence: `src/app.js`)
- Express application → Document and KYC checks: routes KYC (evidence: `src/app.js`)
- Express application → Director onboarding: routes directors (evidence: `src/app.js`)
- Express application → User documents: routes documents (evidence: `src/app.js`)
- Express application → Admin KYC review: routes admin KYC (evidence: `src/app.js`)
- Express application → Product administration: routes products (evidence: `src/app.js`)
- Express application → Notifications: routes notifications (evidence: `src/app.js`)
- Express application → IP administration: routes IP admin (evidence: `src/app.js`)
- Express application → Payment orders: routes payments (evidence: `src/app.js`)
- Authentication → User records: reads users (evidence: `src/controllers/Auth/auth.controller.js`)
- Authentication → SQL database: runs transactions (evidence: `src/controllers/Auth/auth.controller.js`)
- Authentication → User records: resolves identity (evidence: `src/controllers/Auth/auth.controller.js`)
- Merchant entities → User records: reads and updates (evidence: `src/controllers/Entities/entities.controller.js`)
- Merchant entities → Director records: uses director records (evidence: `src/controllers/Entities/entities.controller.js`)
- Merchant entities → Product records: uses product records (evidence: `src/controllers/Entities/entities.controller.js`)
- Merchant entities → User document records: uses documents (evidence: `src/controllers/Entities/entities.controller.js`)
- Business information → User records: updates business (evidence: `src/controllers/Onboarding/BusinessInfo/businessInfo.controller.js`)
- Business information → Director records: uses director records (evidence: `src/controllers/Onboarding/BusinessInfo/businessInfo.controller.js`)
- Director onboarding → User records: updates user (evidence: `src/controllers/Onboarding/Directors/directors.controller.js`)
- Director onboarding → Director records: updates directors (evidence: `src/controllers/Onboarding/Directors/directors.controller.js`)
- Director onboarding → Object storage helper: uploads files (evidence: `src/controllers/Onboarding/Directors/directors.controller.js`)
- Document and KYC checks → User records: updates KYC (evidence: `src/controllers/Onboarding/DocKYC/docKYC.controller.js`)
- Document and KYC checks → Director records: uses director records (evidence: `src/controllers/Onboarding/DocKYC/docKYC.controller.js`)
- Document and KYC checks → Object storage helper: uploads evidence (evidence: `src/controllers/Onboarding/DocKYC/docKYC.controller.js`)
- Document and KYC checks → Verification helper: checks identity (evidence: `src/controllers/Onboarding/DocKYC/docKYC.controller.js`)
- User documents → User records: resolves user (evidence: `src/controllers/Onboarding/DocumentUpload/userDocument.controller.js`)
- User documents → User document records: manages documents (evidence: `src/controllers/Onboarding/DocumentUpload/userDocument.controller.js`)
- User documents → Object storage helper: uploads files (evidence: `src/controllers/Onboarding/DocumentUpload/userDocument.controller.js`)
- Admin KYC review → User records: reviews user (evidence: `src/controllers/Admin/KYC/adminKYC.controller.js`)
- Admin KYC review → Director records: reviews directors (evidence: `src/controllers/Admin/KYC/adminKYC.controller.js`)
- Product administration → User records: looks up users (evidence: `src/controllers/Admin/Product/product.controller.js`)
- Product administration → Product records: manages products (evidence: `src/controllers/Admin/Product/product.controller.js`)
- Notifications → Notification records: manages notices (evidence: `src/controllers/Admin/Notifications/notification.controller.js`)
- Notifications → User records: looks up users (evidence: `src/controllers/Admin/Notifications/notification.controller.js`)
- IP administration → User records: looks up users (evidence: `src/controllers/Admin/IP/ip.controller.js`)
- Payment orders → Payment order records: manages orders (evidence: `src/controllers/Payment/PineLabs/Order/pineLabsOrder.controller.js`)
- Payment orders → Payment records: manages payments (evidence: `src/controllers/Payment/PineLabs/Order/pineLabsOrder.controller.js`)
- Payment orders → Pine Labs service: calls service (evidence: `src/controllers/Payment/PineLabs/Order/pineLabsOrder.controller.js`)
- Payment webhook → Payment order records: updates orders (evidence: `src/controllers/Payment/PineLabs/Webhook/pineLabsWebhook.controller.js`)
- Payment webhook → Payment records: updates payments (evidence: `src/controllers/Payment/PineLabs/Webhook/pineLabsWebhook.controller.js`)
- User records → SQL database: uses connection (evidence: `src/models/User.js`)
- Director records → SQL database: uses connection (evidence: `src/models/Director.js`)
- User document records → SQL database: uses connection (evidence: `src/models/UserDocument.js`)
- Product records → SQL database: uses connection (evidence: `src/models/Product.js`)
- Notification records → SQL database: uses connection (evidence: `src/models/Notifications.js`)
