Documentation
Tutorials
01-installation 02-basic-verification 03-advanced-verification 04-nestjs-integration
GitHub npm

Home

porkate-valid8-monorepo 1.0.0

porkate-valid8 Monorepo

A flexible TypeScript KYC/KYB verification package with multiple service adapters and comprehensive event logging.

📚 Documentation

📖 View Full API Documentation - Complete API reference with examples, tutorials, and type definitions.

Packages

porkate-valid8

Core verification manager, interfaces, events system, and exceptions.

porkate-valid8-identitypass

IdentityPass adapter for Nigerian verification services (NIN, BVN, CAC, etc.).

Fully Implemented: Complete suite of 13 verification service types with 42+ methods. All services feature strongly-typed requests and responses, with support for advanced verification methods including face matching, document verification, and comprehensive business checks.

Key features:

  • ✅ 12 specialized services for each verification type (NIN, BVN, CAC, Vehicle, Passport, Driver's License, Phone, Bank Account, Credit Bureau, Tax, Voter's Card, and Other services)
  • ✅ Strongly typed requests and responses for all methods
  • ✅ Support for advanced verification methods (face matching, document verification, slip verification, etc.)
  • ✅ Original adapter response available in meta field
  • ✅ Backward compatible with legacy adapter
  • ✅ Comprehensive documentation and examples

porkate-valid8-dashboard

Hangfire-style dashboard for monitoring verification activities and metrics.

porkate-valid8-nest

NestJS integration module with decorators and services.

Getting Started

Prerequisites

  • Node.js >= 18
  • pnpm >= 8

Installation

# Install dependencies
pnpm install

# Bootstrap packages (link workspace dependencies)
pnpm bootstrap

# Build all packages
pnpm build

Development

# Watch mode for all packages
pnpm dev

# Run tests
pnpm test

# Lint
pnpm lint

# Format code
pnpm format

Monorepo Structure

porkate-valid8/
├── packages/
│   ├── core/              # porkate-valid8
│   ├── identitypass/      # porkate-valid8-identitypass
│   ├── dashboard/         # porkate-valid8-dashboard
│   └── nest/              # porkate-valid8-nest
├── examples/              # Usage examples
├── tests/                 # Integration tests
├── lerna.json             # Lerna configuration
├── pnpm-workspace.yaml    # PNPM workspace configuration
└── package.json           # Root package.json

Publishing

# Version packages
pnpm version

# Publish to npm
pnpm publish

License

MIT