Skip to content

emasys/verix-api-component

Repository files navigation

verix-api-component

A simple React component for easy Verix API integration

NPM JavaScript Style Guide

Install

npm install --save verix-api-component

Demo

Demo

Usage

Add verixapi css to your index.html file - https://app.verixapi.com/connect.css

import React from "react";
import VerixAPIButton from "verix-api-component";

const data = {
  name: {
    first: "Ben",
    last: "Smith"
  },
  birthdate: {
    month: 11,
    day: 3,
    year: 1964
  },
  mobileNumber: "9394442113",
  socialSecurityNumber: "344675890",
  filingAddress: {
    address: "744 Evergreen Terrace",
    address2: "",
    city: "Springfield",
    state: "OR",
    zip: "97403"
  },
  filingStatus: "Married Filing Jointly",
  email: "bensmith@gmail.com"
};

function Example() {
  const handleSuccess = results => {
    console.log(results);
  };

  const handleExit = results => {
    console.log(results);
  };

  return (
    <div className='container'>
      <div className='button-wrapper'>
        <VerixButton
          env='sandbox'
          className='button'
          clientId='__client_Id__'
          data={data}
          onSuccess={handleSuccess}
          onExit={handleExit}
        >
          Download Tax data
        </VerixButton>
      </div>
    </div>
  );
}

All Props

dataProps = {
  name: { // optional
    first: string,
    last: string
  },
  birthdate: { // optional
    month: 11,
    day: 3,
    year: 1964
  },
  mobileNumber: string, // optional
  socialSecurityNumber: string, // optional
  filingAddress: { //optional
    address: string,
    address2: string,
    city: string,
    state: string,
    zip: string
  },
  filingStatus: string, //optional
  email: string // required
}

<VerixAPIButton
  env="sandbox|development|production"
  style={{__your_button_style__}}
  className="__button_class__"
  clientId="__client_id___"
  data={dataProps}
  onSuccess={(result) => {} }
  onExit={(result) => {}}
>
  button label
</VerixAPIButton>

Contributing

Development

# install dependencies
npm install

# run module locally
npm start

# run example app
cd example && npm install
npm start

# view on localhost:3000

License

MIT © emasys

About

React component for Verixapi

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published