Documentation for @netappsng/react-native-netappskycsdk

Overview

@netappsng/react-native-netappskycsdk is a React Native module designed for integrating KYC (Know Your Customer) functionalities into mobile applications. This module provides easy-to-use functions for initializing and managing KYC processes.

Installation

To install the module, run the following command in your React Native project:

npm install @netappsng/react-native-netappskycsdk

or

yarn add @netappsng/react-native-netappskycsdk

API Reference

Types

IKyc

An interface for the KYC payload with the following properties:

• userRef: A unique user reference string.
• name: The name of the user.
• slug: The slug for the KYC process.
• public_key: The public key used for the KYC process.
• levelSlug: The level of KYC required.
• closeBtn: A string to indicate if a close button should be shown.
• debugMode: A string to indicate if the module should run in debug mode.

Functions

initKyc(payload: IKyc): Promise<any>

Initializes the KYC process with the given payload.

• payload: An object of type IKyc.

closeKyc(): void

Closes the KYC modal.

Sample Usage

Below is a sample code demonstrating how to use the @netappsng/react-native-netappskycsdk module in a React Native application.

import * as React from 'react';
import { StyleSheet, View, Button } from 'react-native';
import {
  type IKyc,
  initKyc,
  closeKyc,
} from '@netappsng/react-native-netappskycsdk';

export default function App() {
  const payload: IKyc = {
    userRef: 'rufai@deeptech@law4',
    name: 'rufai',
    slug: 'bvn_test',
    public_key: 'NA_PUB_PROD-c0cdbcc7d277d4d96e017de1b46da291',
    levelSlug: 'tier_1',
    closeBtn: 'true'
  };

  const handleKyc = () => {
    initKyc(payload)
      .then((data) => {
        console.log(data);
      })
      .catch((e) => {
        console.log(e);
      });
  };

  const handleClose = () => {
    closeKyc();
  };

  return (
    <View style={styles.container}>
      <Button title="Test Kyc" onPress={handleKyc} />
      <Button title="Close Modal" onPress={handleClose} />
    </View>
  );
}

const styles = StyleSheet.create({
  container: {
    flex: 1,
    alignItems: 'center',
    justifyContent: 'center',
  },
});