# basiq-connect

> Basiq Connect is a javascript library written in React, which allows applicants to securely connect to their bank so lenders can generate an Affordability Report.

Latest version **0.10.6** (published 2019-08-29) · 0 weekly downloads

## Install

```sh
npm install basiq-connect
pnpm add basiq-connect
yarn add basiq-connect
bun add basiq-connect
```

## Health

**Score 10/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; low quality score; large bundle; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.10.6 |
| Published | 2019-08-29 |
| First published | 2019-08-15 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 8 |
| Unpacked size | 10.1 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | stefanabasiq |

## Links

- npm: https://www.npmjs.com/package/basiq-connect
- npm.io page: https://npm.io/package/basiq-connect

## Dependencies (8)

- [redux](https://npm.io/package/redux.md) ^4.0.1
- [core-js](https://npm.io/package/core-js.md) ^3.2.0
- [lato-font](https://npm.io/package/lato-font.md) ^3.0.0
- [url-loader](https://npm.io/package/url-loader.md) ^2.1.0
- [react-redux](https://npm.io/package/react-redux.md) ^7.0.1
- [redux-thunk](https://npm.io/package/redux-thunk.md) ^2.3.0
- [font-awesome](https://npm.io/package/font-awesome.md) ^4.7.0
- [react-app-polyfill](https://npm.io/package/react-app-polyfill.md) ^1.0.1

## Recent versions

- 0.10.6 (latest) — 2019-08-29
- 0.10.5 — 2019-08-29
- 0.10.4 — 2019-08-29
- 0.10.3 — 2019-08-29
- 0.10.2 — 2019-08-29
- 0.10.1 — 2019-08-28
- 0.10.0 — 2019-08-27
- 0.9.9 — 2019-08-27
- 0.9.8 — 2019-08-27
- 0.9.7 — 2019-08-27
- 0.9.6 — 2019-08-26
- 0.9.5 — 2019-08-26
- 0.9.4 — 2019-08-26
- 0.9.3 — 2019-08-26
- 0.9.2 — 2019-08-26
- … 82 more at https://npm.io/package/basiq-connect/versions

## README

Basiq Connect is a javascript library written in React, which allows applicants to securely connect to their bank so lenders can generate an Affordability Report.

## Requirements

Basiq Connect requires installation of react and react-dom. Ensure that react and react-dom are at least v16.9.0:

$ npm install react

$ npm install react-dom

## Installation

$ npm install basiq-connect

## Configuration

Basiq Connect is a function which receives configuration as an input object with following parameters:

* **containerId**
  - ID of the DOM element in which Basiq Connect will be rendered
  - Type: String
* **token**
  - authentication token
  - Type: String
* **userID**
  - ID of the user
  - Type: String
* **connectLinkID**
  - ID part of Basiq Connect link
  - Type: String
  - Example: If connect link is https://connect.basiq.io/0272b5c7-b19a-4d93-908d-18c44ferffwd7a  - ID part of connect link is 0272b5c7-b19a-4d93-908d-18c44ferffwd7a
* **upload**
  - True if uploading statements should be enabled
  - Type: Boolean
* **connect**
  - True if connecting to bank with credentials should be enabled
  - Type: Boolean 
* **companyName**
  - Name of the company(bank)
  - Type: String

## How to use it

Basiq Connect requires authentication. Authentication can be done by providing connect link or access token and user id.

- Calling Basiq Connect with provided token and userID
  Add the following code to your .js file:

```
import BasiqConnect from 'basiq-connect';

BasiqConnect({
    containerId: DOM_CONTAINER_ID,
    token: YOU_TOKEN,
    userID: YOUR_USER_ID,
    upload: TRUE/FALSE,
    connect: TRUE\FALSE,
    companyName: YOUR_COMPANY_NAME
});
```

- Calling Basiq Connect with provided connect link:
Add the following code to your .js file:

```
import BasiqConnect from 'basiq-connect';

BasiqConnect({
    containerId: DOM_CONTAINER_ID,
    connectLink: YOUR_CONNECT_LINK,
    upload: TRUE/FALSE,
    connect: TRUE\FALSE,
    companyName: YOUR_COMPANY_NAME
});

```

---
_Source: https://npm.io/package/basiq-connect · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._