🔒 Visitor Identity Verification System

Overview

This system provides secure identity verification for visitors using HMAC token generation. It offers a reliable way to authenticate visitors through unique identifiers, email addresses, or phone numbers.

---

✨ Features

• Secure Authentication - Uses HMAC-SHA256 for robust token generation
• Flexible Identification - Supports multiple identification methods
• Error Handling - Comprehensive error management throughout the process
• API Endpoint - Simple RESTful interface for easy integration

---

🛠️ Technical Architecture

┌──────────────┐     ┌──────────────┐     ┌──────────────────┐     ┌────────────────┐
│ User Visit   │────▶│ Request      │───▶ │ Your Server      │────▶│ Your Frontend  │
│ your Frontend│     │ received by  │     │ creates HMAC     │     │ gets the token │
└──────────────┘     │ your server  │     │ token            │     └───────┬────────┘
                     └──────────────┘     └──────────────────┘             │
                                                                           │
                                                                    ┌──────────────────┐                           
                                                                    │ Your Frontend    │
                                                                    │ sends HMAC token │
                                                                    │ + Email or Phone │
                                                                    │using YourGPT SDK │           
                                                                    └────────┬─────────┘                           
                                                                             │
                                                                             │
┌──────────────┐     ┌──────────────┐      ┌──────────────────┐              │
│ User contact │◀────│ YourGPT      │◀────│ YourGPT receives  │◀─────────────┘
│ created      │     │ validates    │      │ Token + contact  │
└──────────────┘     │ token        │      │ details          │
                     └──────────────┘      └──────────────────┘

Authentication Flow Process

1. User visits your frontend application
2. Your server receives the request
3. Your server generates an HMAC token
4. The frontend receives the token
5. Your frontend sends the HMAC token along with Email or Phone number using the YourGPT SDK
6. YourGPT receives the token and contact details
7. YourGPT validates the token
8. User contact is created upon successful validation

---

🚀 Getting Started

Prerequisites

• Node.js environment
• Express.js framework
• Crypto module

Installation

1. Clone the repository
2. Install dependencies: npm install
3. Set environment variable: HMAC_SECRET_KEY
4. Start the server: npm start

---

📡 API Usage

Identity Verification Endpoint

Endpoint: /identity

Method: POST

Request Body:

{
  "visitorUniqueId": "visitor-123",
  "visitorEmail": "[email protected]",
  "visitorPhone": "1234567890"
}

Successful Response:

{
  "hmacToken": "5f4dcc3b5aa765d6145d8327deb882cf99..."
}

Error Response:

{
  "message": "An error occurred during identity verification."
}

---

🔐 Security Considerations

• The secret key should be stored securely in environment variables
• Token generation prioritizes unique ID over email and phone
• All input data is validated before processing

---

📝 Code Documentation

Controllers

The IndetificationController handles the verification process:

• Extracts visitor data from request
• Accesses the secret key
• Delegates token generation to the helper
• Returns appropriate responses

Helpers

The generateHmacToken function:

• Validates input parameters
• Creates HMAC using SHA256 algorithm
• Returns hexadecimal token string
• Handles errors gracefully

---

🔄 Process Flow

1. Client sends identification data
2. Router directs to controller
3. Controller extracts data and secret key
4. Helper generates HMAC token
5. Token is returned to client
6. Any errors are caught and handled

---

👨‍💻 Maintenance

For questions or support, please contact the system administrator.

© 2025 Visitor Verification System / YourGPT