# trulioo-sdk-beta

> Trulioo JavaScript SDK

Latest version **0.1.0** (published 2020-08-29) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install trulioo-sdk-beta
pnpm add trulioo-sdk-beta
yarn add trulioo-sdk-beta
bun add trulioo-sdk-beta
```

## Health

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

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.0 |
| Published | 2020-08-29 |
| First published | 2020-08-29 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 177.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | trulioo-rd-devops |

## Links

- npm: https://www.npmjs.com/package/trulioo-sdk-beta
- npm.io page: https://npm.io/package/trulioo-sdk-beta

## Dependencies (2)

- [@babel/cli](https://npm.io/package/@babel/cli.md) ^7.0.0
- [superagent](https://npm.io/package/superagent.md) 3.7.0

## Recent versions

- 0.1.0 (latest) — 2020-08-29

## README

# trulioo-sdk

TruliooSdk - JavaScript client for trulioo-sdk
Trulioo SDK

- API version: 0.1.0
- Package version: 0.1.0
- Build package: org.openapitools.codegen.languages.JavascriptClientCodegen

## Installation

### For [Node.js](https://nodejs.org/)

#### npm

Then install it via:

```shell
npm install trulioo-sdk --save
```

## Getting Started 

Please follow the [installation](#installation) instruction and execute the following JS code:

```javascript
var TruliooSdk = require('trulioo-sdk');

var defaultClient = TruliooSdk.ApiClient.instance;
// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['x-trulioo-api-key'] = "Token"

var api = new TruliooSdk.ConfigurationApi()
var countryCode = "COUNTRY-CODE"; // {String} Country alpha2 code
var configurationName = "Identity Verification"; // {String} The product configuration. Currently \"Identity Verification\" for all products.
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getConsents(countryCode, configurationName, callback);

```

## Documentation for API Endpoints

All URIs are relative to *https://gateway.trulioo.com/trial*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*TruliooSdk.ConfigurationApi* | [**getConsents**](docs/ConfigurationApi.md#getConsents) | **GET** /configuration/v1/consents/{configurationName}/{countryCode} | Get Consents
*TruliooSdk.ConfigurationApi* | [**getCountryCodes**](docs/ConfigurationApi.md#getCountryCodes) | **GET** /configuration/v1/countrycodes/{configurationName} | Get Country Codes
*TruliooSdk.ConfigurationApi* | [**getCountrySubdivisions**](docs/ConfigurationApi.md#getCountrySubdivisions) | **GET** /configuration/v1/countrysubdivisions/{countryCode} | Get Country Subdivisions
*TruliooSdk.ConfigurationApi* | [**getDatasources**](docs/ConfigurationApi.md#getDatasources) | **GET** /configuration/v1/datasources/{configurationName}/{countryCode} | Get Datasources
*TruliooSdk.ConfigurationApi* | [**getDetailedConsents**](docs/ConfigurationApi.md#getDetailedConsents) | **GET** /configuration/v1/detailedConsents/{configurationName}/{countryCode} | Get Detailed Consents
*TruliooSdk.ConfigurationApi* | [**getFields**](docs/ConfigurationApi.md#getFields) | **GET** /configuration/v1/fields/{configurationName}/{countryCode} | Get Fields
*TruliooSdk.ConfigurationApi* | [**getRecommendedFields**](docs/ConfigurationApi.md#getRecommendedFields) | **GET** /configuration/v1/recommendedfields/{configurationName}/{countryCode} | Get Recommended Fields
*TruliooSdk.ConfigurationApi* | [**getTestEntities**](docs/ConfigurationApi.md#getTestEntities) | **GET** /configuration/v1/testentities/{configurationName}/{countryCode} | Get Test Entities
*TruliooSdk.ConnectionApi* | [**testAuthentication**](docs/ConnectionApi.md#testAuthentication) | **GET** /connection/v1/testauthentication | Test Authentication
*TruliooSdk.VerificationsApi* | [**getTransactionRecord**](docs/VerificationsApi.md#getTransactionRecord) | **GET** /verifications/v1/transactionrecord/{id} | Get Transaction Record
*TruliooSdk.VerificationsApi* | [**verify**](docs/VerificationsApi.md#verify) | **POST** /verifications/v1/verify | Verify

### ApiKeyAuth

- **Type**: API key
- **API key parameter name**: x-trulioo-api-key
- **Location**: HTTP header

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