1. Getting Started

npm install @boomid/zappa-react

// or 

yarn add @boomid/zappa-react

The Zappa interface works via 2 components: ZappaComponent and a Challenge.

The ZappaComponent is a wrapper for a Challenge that handles the instantiation of the Challenge, passes data to the BoomID Identity Assurance Engine, and manages callbacks.

1.1. Creating a BoomID Account

In order to use the Zappa services, and in turn the BoomID Identity Assurance Engine, you must first create a BoomID Account.

See BoomID Hub to get started.

Obtaining a Site Key

Once an account has been created on the BoomID Hub, open the Zappa module and create a new Site.

1.2. Challenges

The Challenges RoadMap is listed below.

| Implemented | In Progress | Planned | |-------------|-------------|---------| | TracedLine | PalmVerify | | | Transparent | | |

1.3. Using ZappaComponent

To utilize the ZappaComponent with your desired challenge:

import { ZappaComponent, Transparent, TracedLine } from '@boomid/zappa-react';

Then, implementation is a cinch!

<ZappaComponent
    siteKey='abc123'
    component={Transparent}
    acceptableScore={70} // Default: 90 - Score received from the BoomID Identity Assurance Engine
    verifyCallback={(score, recommendation, passed) => {
        // Handle the response here.
        // If passed, perhaps enable the "submit" button
        // If failed, perhaps force the user to log in before submitting
        console.log(`Score: ${score} - Passed: ${passed}`);
    }}
    onLoadCallback={() => {
        // Informs your application that the component has loaded. 
        // 
        console.log('loaded!')
    }}
/>