14.0.0 • Published 1 year ago

@dustfoundation/ng-verify v14.0.0

Weekly downloads
-
License
-
Repository
-
Last release
1 year ago

ng-verify

Synaps Angular Verify SDK

NPM JavaScript Style Guide

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

enter image description here

Install

With npm

npm install @synaps-io/ng-verify

With yarn

yarn add @synaps-io/ng-verify

Import

Go to app.module.ts then add:

...
import { NgVerifyModule } from "@synaps-io/ng-verify";

@NgModule({
  declarations: [...],
  imports: [..., NgVerifyModule],
  providers: [...],
  bootstrap: [...]
})
export class AppModule {}

Usage

import { Component } from '@angular/core';

@Component({
  selector: 'app-root',
  template: `
  <div>
    <synaps-verify 
    sessionId="f3243476-cec44c4a-5565ccd6-e7e9622d"
    [color]="{ primary: '212b39', secondary: 'ffffff' }"
    lang="en"
    service="individual"
    (ready)="print('ready')"
    (finish)="print('finish')"
    ></synaps-verify>
  </div>
  `
})
export class AppComponent {
  title = 'test-angular';
  print(data: any) {
    console.log(data);
  }
}

Data list

Prop nameProp typeDefaultRequiredDescription
sessionIdstring''YSession can be referred as a customer verification session. More info
servicestring''Yindividual - for know your customer corporate - for know your business
langstring'en'NEvent listener called on every open/close action
tierintnullNTier 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}nullNYou can set a primary color and a secondary color, it will create a verification flow tailored to your compliance needs and your brand.
withFinishButtonFalsenullNThis will add a button close at the end of the flow this button will trigger an event finish.
readyeventnullNEvent listener called when the page is fully loaded
finisheventnullNEvent listener called when the user finished verification

Examples

Edit angular-verify

License

Apache 2.0 © Synaps