Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/React-Native-Nation/react-native-onfido

React Nativo Onfido Package
https://github.com/React-Native-Nation/react-native-onfido

Last synced: 2 months ago
JSON representation

React Nativo Onfido Package

Lists

README

        

![react-native-onfido](https://remtech.org/wp-content/uploads/2019/06/Onfido_IMTC.jpg)

[![Version](https://img.shields.io/npm/v/react-native-onfido)](https://www.npmjs.com/package/react-native-onfido)
[![Build](https://travis-ci.org/react-native-nation/react-native-onfido.svg?branch=master)](https://travis-ci.org/react-native-nation/react-native-onfido)
[![Coverage](https://coveralls.io/repos/github/react-native-nation/react-native-onfido/badge.svg?branch=master)](https://coveralls.io/github/react-native-nation/react-native-onfido?branch=master)
[![Minified size](https://img.shields.io/bundlephobia/min/react-native-onfido)](https://github.com/react-native-nation/react-native-onfido/blob/master/LICENSE)
[![Downloads](https://img.shields.io/npm/dm/react-native-onfido)](https://www.npmjs.com/package/react-native-onfido)
[![Dependabot](https://api.dependabot.com/badges/status?host=github&repo=react-native-nation/react-native-onfido)](https://dependabot.com)
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/react-native-nation/react-native-onfido/pulls)
[![Tested with jest](https://img.shields.io/badge/tested_with-jest-99424f.svg)](https://github.com/facebook/jest)

# React Native Nation Onfido
This package is a wrapper for the Onfido Library. https://onfido.com/

## Table of contents
* [How to install](#howtoinstall)
* [API Methods](#using)
* [Example](#example)
* [Community profile](#community)
* [Contributing](#contributing)

## How to install
`yarn add react-native-onfido`.


## API Methods

# startSDK
To start the onfido KYC proccess use `startSDK`
```js
Onfido.startSDK(token, applicantId, country, onSuccess, OnError);
```

# Example


## Example
React native example

```js
import Onfido from 'react-native-onfido';

Onfido.startSDK(
token,
applicantId,
country,
() => {
console.log("Verification complete");
},
(errorCause) => {
if (errorCause == "USER_LEFT_ACTIVITY") {
console.log("Flow cancelled")
} else {
console.log("Flow not finished")
};
},
// Optional iOS primary color
primaryColor);
```


## Community profile
Please read through our [CODE_OF_CONDUCT.md](/.github/CODE_OF_CONDUCT.md).


## Contributing
Please read through our [CONTRIBUTING.md](/.github/CONTRIBUTING.md).

## Contributors


James Jara
James Jara

🚇 💻 ⚠️ 📖


## React Native Nation
React Native Nation is the best spanish website for react native documentation.
[react-native-nation](https://reactnativenation.com).