@rebilly/risk-data-collector
Advanced tools
Comparing version 2.5.1 to 2.5.2
@@ -0,1 +1,8 @@ | ||
## [2.5.2](https://github.com/Rebilly/rebilly/compare/risk-data-collector-v2.5.1...risk-data-collector-v2.5.2) (2023-04-20) | ||
### Bug Fixes | ||
* **risk-data-collector:** Use markdown linter and force a new release ([#154](https://github.com/Rebilly/rebilly/issues/154)) ([6cc79f1](https://github.com/Rebilly/rebilly/commit/6cc79f1779afcfbd62c70518dbcffad1ef3ec5f2)) | ||
## [2.5.1](https://github.com/Rebilly/rebilly/compare/risk-data-collector-v2.5.0...risk-data-collector-v2.5.1) (2023-04-20) | ||
@@ -2,0 +9,0 @@ |
{ | ||
"name": "@rebilly/risk-data-collector", | ||
"version": "2.5.1", | ||
"version": "2.5.2", | ||
"description": "Microlibrary that collects browser data for risk assessment", | ||
@@ -5,0 +5,0 @@ "type": "module", |
# risk-data-collector | ||
Collect browser data for risk assessment purposes. | ||
## Description | ||
`risk-data-collector` is a client side microlibrary which collects user data required for the risk assessment component of 3DS v2. | ||
## Data collected | ||
``` | ||
colorDepth | ||
javaEnabled | ||
language | ||
screenHeight | ||
screenWidth | ||
timeZoneOffset | ||
deviceFingerprintHash | ||
kountFraudSessionId (optional) | ||
``` | ||
- colorDepth | ||
- javaEnabled | ||
- language | ||
- screenHeight | ||
- screenWidth | ||
- timeZoneOffset | ||
- deviceFingerprintHash | ||
- kountFraudSessionId (optional) | ||
## Usage | ||
`risk-data-collector` is distributed in two ways: | ||
1. Via a CDN link | ||
### Via a CDN link | ||
The library becomes available under the `RiskDataCollector` global namespace and can be used like so: | ||
@@ -41,6 +45,7 @@ | ||
<br> | ||
> Note: You can replace `@latest` with `@<version>` (Example `@1.0.0`). To pin to a specific version. | ||
2. As an npm package | ||
``` | ||
### As an npm package | ||
```bash | ||
yarn add @rebilly/risk-data-collector | ||
@@ -52,2 +57,3 @@ | ||
Which can be imported and used like so: | ||
```js | ||
@@ -63,10 +69,13 @@ import {collectData} from '@rebilly/risk-data-collector'; | ||
## Kount | ||
`risk-data-collector` works with [Kount](https://kount.com/) to collect `kountFraudSessionId`. | ||
If you already have an account with Kount, you can use it with `risk-data-collector` by providing: | ||
* `env` - `sandbox` or `production`, determines which Kount environment to use (defaults to `sandbox`) | ||
* `kountAccountId` - your Kount account ID | ||
* (optional) `kountSessionId` - 32 character session ID, omit to have Kount generate a session ID for you | ||
- `env` - `sandbox` or `production`, determines which Kount environment to use (defaults to `sandbox`) | ||
- `kountAccountId` - your Kount account ID | ||
- (optional) `kountSessionId` - 32 character session ID, omit to have Kount generate a session ID for you | ||
Example: | ||
```js | ||
@@ -73,0 +82,0 @@ import {collectData} from '@rebilly/risk-data-collector'; |
308831
87