0.0.3 • Published 2 years ago
@synaps-io-pre-prod/react-verify v0.0.3
react-verify
Synaps ReactJS SDK
Synaps is an all-in-one compliance platform. It offers a simple, fast and secure way to meet compliance requirements at scale.
Visit Synaps.io | Read the Synaps documentation
Install
With npm
npm install @synaps-io/react-verify
With yarn
yarn add @synaps-io/react-verify
Import
import Synaps from '@synaps-io-pre-prod/react-verify'
Usage
import React, { Component } from 'react'
import Synaps from '@synaps-io-pre-prod/react-verify'
class Example extends Component {
render() {
return (
<Synaps
sessionId={'f3243476-cec44c4a-5565ccd6-e7e9622d'}
service={'individual'}
lang={'en'}
onReady={() => console.log('component ready')}
onFinish={() => console.log('user finish process')}
color={{
primary: '212b39',
secondary: 'ffffff'
}}
/>
)
}
}
Props list
Prop name | Prop type | Default | Required | Description |
---|---|---|---|---|
sessionId | string | '' | Y | Session can be referred as a customer verification session. More info |
service | string | '' | Y | individual - for know your customer corporate - for know your business |
lang | string | 'en' | N | Event listener called on every open/close action |
tier | int | null | N | Tier is a simply way to divide your workflow into small pieces. It is very useful when you offer different features based on the verification level of your customer. More info |
color | {primary : string, secondary: string} | null | N | You can set a primary color and a secondary color, it will create a verification flow tailored to your compliance needs and your brand. |
onReady | () => void | null | N | Event listener called when the page is fully loaded |
onFinish | () => void | null | N | Event listener called when the user finished verification |
Examples
React 16
React 18
License
Apache 2.0 © Synaps