Skip to content

Milestone: M7 — Reclaim Protocol | SOW Reference: FR4 | Requirement Clarity: ⚠️ Depends on M7-01 | Dev Status: ❌ Not started Moved from docs/requirements/tasks/POC/updated-poc-requirements-with-reclaim-protocol.md. The "Completed Components" list below predates today's successful POC demo and is now understated in places — cross-check against the current codebase rather than trusting it verbatim. Unmodified below.

M7-04 REC Verifiable Credentialing Platform - Updated POC Requirements

Including Reclaim Protocol Integration Considerations

Executive Summary

This document outlines the updated requirements for the REC Verifiable Credentialing Platform POC, incorporating considerations for future Reclaim Protocol integration that would enable individuals to claim credentials from external sources like HMRC and other online data providers.

Current POC Status & Limitations

✅ Completed Components:

  • Auth0 authentication with NextAuth.js integration
  • Organization creation and registration with Velocity Network (Mock)
  • Database schema with TypeORM entities for candidates and credential offers
  • Basic backend architecture with NestJS
  • Frontend structure with Next.js and Redux
  • Manual credential creation workflow
  • Employee management system

⚠️ Current Limitations:

  • Mock VNF SDK Implementation: Using MockVCLProvider instead of real Velocity Network integration
  • No Production API Access: Still awaiting VNF sandbox/production API keys
  • Organization-Only Workflow: No individual user credential claiming capability
  • Static Data Sources: All credential data comes from internal employee records

Updated POC Scope & Objectives

Phase 1: Complete Current POC (Priority: HIGH)

Timeline: 4-6 weeks

  1. Velocity Network Integration (Real APIs)
  2. Replace mock implementation with actual VNF SDK
  3. Obtain production/sandbox API credentials
  4. Test real credential issuance and verification

  5. Validate organization registration process

  6. Employee List Upload Module Enhancement

  7. CSV file upload interface for bulk employee data
  8. Enhanced data validation and error handling
  9. Preview functionality before processing

  10. Batch processing optimization

  11. Credential Creation Engine Completion

  12. Real VNF Credential Agent integration
  13. Past employment credential generation
  14. Batch processing capabilities with real APIs

  15. Error handling for production scenarios

  16. Email Sharing System

  17. Production-ready email templates
  18. Credential offer notifications
  19. Landing page for credential acceptance

  20. Delivery tracking and analytics

  21. Status Monitoring Dashboard

  22. Real-time credential status tracking
  23. Export capabilities for compliance reporting
  24. Search and filter functionality
  25. Performance metrics and analytics

Phase 2: Reclaim Protocol Integration Architecture (Priority: MEDIUM)

Timeline: 8-12 weeks

  1. External Data Source Framework
  2. Reclaim Protocol SDK integration
  3. HMRC API integration capability
  4. Open Banking API support

  5. Generic external data source adapter pattern

  6. Individual User Workflow

  7. Self-service credential claiming interface
  8. User consent management system
  9. External data source authentication

  10. Personal credential wallet integration

  11. Data Verification & Transformation

  12. External data validation services
  13. Data quality assurance mechanisms
  14. Transformation to VNF credential format
  15. Audit trail for external data usage

Technical Prerequisites

Immediate Requirements (Phase 1):

# Production Environment Variables Needed
VNF_API_KEY=<production-vnf-api-key>
VNF_AGENT_OPERATOR_API_URL=<production-agent-operator-url>
VNF_REGISTRAR_API_URL=<production-registrar-url>
VNF_ENVIRONMENT=production # or sandbox

# Email Infrastructure
EMAIL_HOST=<smtp-server>
EMAIL_USER=<email-credentials>
EMAIL_PASS=<email-password>

# Database
DATABASE_URL=<production-database-url>

Future Requirements (Phase 2):

# Reclaim Protocol Integration
RECLAIM_PROTOCOL_API_KEY=<reclaim-api-key>
RECLAIM_PROTOCOL_BASE_URL=<reclaim-api-base-url>

# HMRC Integration
HMRC_CLIENT_ID=<hmrc-client-id>
HMRC_CLIENT_SECRET=<hmrc-client-secret>
HMRC_SANDBOX_URL=<hmrc-sandbox-url>

# Open Banking
OPEN_BANKING_CLIENT_ID=<open-banking-client-id>
OPEN_BANKING_CLIENT_SECRET=<open-banking-client-secret>

Architecture Evolution

Current Architecture (Phase 1):

Organization Admin → Employee Data → VNF Credential → Email → Employee Claims

Future Architecture (Phase 2):

Individual User → External Data Sources (HMRC/Banks) → 
Reclaim Protocol → Data Verification → VNF Credential → Personal Wallet

Implementation Roadmap

Phase 1: POC Completion (Weeks 1-6)

  • Week 1-2: Replace mock VNF implementation with real APIs
  • Week 3-4: Complete employee upload and batch processing
  • Week 5-6: Finalize email system and dashboard

Phase 2: Reclaim Protocol Integration (Weeks 7-18)

  • Week 7-9: Design external data source architecture
  • Week 10-12: Implement Reclaim Protocol integration
  • Week 13-15: Build individual user workflow
  • Week 16-18: Testing and validation

Success Criteria

Phase 1 Success Metrics:

  • Successfully process 100+ employee records with real VNF APIs
  • Generate valid Velocity Network credentials
  • Achieve 95%+ email delivery rate
  • Complete batch processing within 5 minutes
  • Zero data loss or corruption incidents

Phase 2 Success Metrics:

  • Successfully integrate with Reclaim Protocol APIs
  • Retrieve and validate HMRC employment data
  • Generate credentials from external data sources
  • Maintain data privacy and consent compliance
  • Achieve 90%+ external data retrieval success rate

Risk Assessment & Mitigation

Phase 1 Risks:

  • VNF API Access Delays: Continue with enhanced mock until production access
  • Email Delivery Issues: Implement multiple SMTP providers
  • Performance Bottlenecks: Optimize batch processing algorithms

Phase 2 Risks:

  • External API Dependencies: Implement robust retry and fallback mechanisms
  • Data Privacy Compliance: Engage legal team for GDPR/UK DIATF compliance
  • User Experience Complexity: Conduct extensive UX testing

Dependencies & Blockers

Current Blockers:

  1. VNF Production API Access: Still using mock implementation
  2. Sandbox Environment: Need VNF sandbox for testing
  3. Production Credentials: Missing API keys and certificates

Future Dependencies:

  1. Reclaim Protocol Partnership: API access and integration support
  2. HMRC Developer Account: Government API access approval
  3. Open Banking Certification: Financial data access compliance

Budget Considerations

Phase 1 Costs:

  • VNF API usage fees
  • Email service provider costs
  • Cloud infrastructure scaling
  • Estimated: £5,000-£10,000

Phase 2 Costs:

  • Reclaim Protocol licensing
  • HMRC API usage fees
  • Additional compliance requirements
  • Enhanced security infrastructure
  • Estimated: £25,000-£50,000

Next Steps

Immediate Actions (This Week):

  1. Contact VCL/VNF: Request production API access and sandbox environment
  2. Email Infrastructure: Set up production SMTP services
  3. Database Optimization: Prepare for production data volumes

Short-term Actions (Next 2 Weeks):

  1. Replace Mock Implementation: Integrate real VNF SDK
  2. Performance Testing: Validate batch processing capabilities
  3. Security Audit: Ensure production readiness

Medium-term Planning (Next Month):

  1. Reclaim Protocol Research: Evaluate integration complexity
  2. HMRC API Investigation: Understand data access requirements
  3. Architecture Design: Plan for dual workflow support

Conclusion

The current POC is approximately 80% complete but requires real VNF API integration to be production-ready. The Reclaim Protocol integration represents a significant expansion that would essentially create a second product within the platform.

Recommendation: Complete Phase 1 POC with real VNF APIs first, then evaluate business case and technical feasibility for Phase 2 Reclaim Protocol integration based on stakeholder feedback and market validation.