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

Interface

IBVNVerificationService

IBVNVerificationService

Interface for BVN (Bank Verification Number) verification services Implementations should throw NotImplementedException for unsupported methods

View Source core/interfaces/verification-services/bvn-verification.interface.ts, line 10

Members

Promise.<VerificationResponse.<BVNVerificationData>>

# getBVNByPhoneNumber Optional

Get BVN details by phone number - OPTIONAL

View Source core/interfaces/verification-services/bvn-verification.interface.ts, line 32

boolean

# isReady

Check if the service is ready and configured

View Source core/interfaces/verification-services/bvn-verification.interface.ts, line 38

Promise.<VerificationResponse.<BVNVerificationData>>

# verifyBVN

Basic BVN verification - REQUIRED

View Source core/interfaces/verification-services/bvn-verification.interface.ts, line 15

Promise.<VerificationResponse.<BVNVerificationData>>

# verifyBVNAdvance Optional

Advanced BVN verification with additional details - OPTIONAL

View Source core/interfaces/verification-services/bvn-verification.interface.ts, line 20

Promise.<VerificationResponse.<BVNVerificationData>>

# verifyBVNWithFace Optional

BVN verification with face matching - OPTIONAL

View Source core/interfaces/verification-services/bvn-verification.interface.ts, line 26