SprintCheck SDK for Expo - Identity verification (BVN, NIN, Facial) for React Native Expo projects
npm install sprintcheck-expoA React Native Expo SDK for identity verification services including BVN (Bank Verification Number), NIN (National Identification Number), and Facial verification.
- 🏦 BVN Verification - Verify Bank Verification Numbers
- 🆔 NIN Verification - Verify National Identification Numbers
- 👤 Facial Verification - Biometric facial verification
- 📱 Expo Compatible - Works with Expo managed and bare workflows
- 🔒 Secure - End-to-end encryption for sensitive data
- 🚀 Easy Integration - Simple API with TypeScript support
``bash`
npm install sprintcheck-expo
or
`bash`
yarn add sprintcheck-expo
Since this SDK uses native modules, you need to generate the native code:
`bash`
expo prebuild
`kotlin
import com.sprintcheckrn.SprintCheckPackage
packages.add(SprintCheckPackage())
`
`bash`
expo run:android
> Note: Currently only Android is supported. iOS support coming soon.
`typescript
import SprintCheck from 'sprintcheck-expo';
// Initialize the SDK
const initializeSDK = async () => {
const result = await SprintCheck.initialize({
apiKey: 'your-api-key',
encryptionKey: 'your-encryption-key'
});
if (result.success) {
console.log('SDK initialized successfully');
} else {
console.error('Failed to initialize SDK:', result.error);
}
};
`
`typescript`
const verifyBVN = async (email: string) => {
try {
const result = await SprintCheck.startBvnVerification(email);
if (result.success) {
console.log('BVN verification started:', result.data);
} else {
console.error('BVN verification failed:', result.error);
}
} catch (error) {
console.error('Error:', error);
}
};
`typescript`
const verifyNIN = async (email: string) => {
try {
const result = await SprintCheck.startNinVerification(email);
if (result.success) {
console.log('NIN verification started:', result.data);
} else {
console.error('NIN verification failed:', result.error);
}
} catch (error) {
console.error('Error:', error);
}
};
`typescript`
const verifyFace = async (email: string) => {
try {
const result = await SprintCheck.startFacialVerification(email);
if (result.success) {
console.log('Facial verification started:', result.data);
} else {
console.error('Facial verification failed:', result.error);
}
} catch (error) {
console.error('Error:', error);
}
};
Initializes the SprintCheck SDK with your API credentials.
Parameters:
- config.apiKey (string): Your SprintCheck API keyconfig.encryptionKey
- (string): Your encryption key
Returns: Promise resolving to a VerificationResult
Starts the BVN verification process.
Parameters:
- email (string): User's email address
Returns: Promise resolving to a VerificationResult
Starts the NIN verification process.
Parameters:
- email (string): User's email address
Returns: Promise resolving to a VerificationResult
Starts the facial verification process.
Parameters:
- email (string): User's email address
Returns: Promise resolving to a VerificationResult
Returns the current initialization status of the SDK.
`typescript
interface SprintCheckConfig {
apiKey: string;
encryptionKey: string;
}
interface VerificationResult {
success: boolean;
message: string;
data?: any;
error?: string;
}
`
- Expo SDK 49+
- React Native 0.70+
- Android API level 24+
- Node.js 16+
1. "SprintCheck doesn't seem to be linked" error
- Make sure you've run expo prebuildexpo prebuild --clean
- Ensure the plugin is properly configured in your app.json
- Try cleaning and rebuilding:
2. Build errors on Android
- Ensure your Android SDK is up to date
- Check that minSdkVersion is at least 24
- Try running cd android && ./gradlew clean`
3. Plugin not found
- Make sure you've installed the package correctly
- Verify the plugin path in your app.json configuration
If you encounter issues:
1. Contact support at info@megasprintlimited.com.ng
MIT License - see LICENSE file for details.
- 📧 Email: info@megasprintlimited.com.ng
- 📖 Documentation: Click here