@levelcredit/js-lib-api

LevelCredit JS API Library

• Getting Started
• API
  • CreditAPI
    • Score
    • Insights
  • ObligationAPI
    • Tradeline
  • ProtectionAPI
    • Monitoring
    • Monitoring Alerts

Getting Started

Install as dependency using npm install command

npm install --save @levelcredit/js-lib-api

Import using

import LevelCreditAPI from "@levelcredit/js-lib-api";

API

First parameters of each api call requires settings: APIFetchSettings.

type APIFetchSettings = {
  env: EnvType; // REQUIRED: "development" | "staging" | "production"
  server?: ServerType; // "levelcredit" | "renttrack"; Default: "levelcredit"
  base_url?: string; // Override base url of api call. (This won't override url path)
  method?: HTTPRequestMethod; // api should handle this, but this can be overwritten if needed
  auth_token?: string; // for cookie or header auth types
  auth_type?: APIAuthType; // "none" | "cookie" | "header" | "header-authorization" | "header-sid"
  headers?: HeadersInit; // Pass any object that follows type { [key: string]: string }
  signal?: AbortSignal; // Used for aborting api call. Pass in AbortSignal
};

When setting APIAuthType, please note that we have 2 ways to authenticate through the header. Setting "header" defaults to using "header-authorization"

# header-authorization
Authorization: Bearer <access_token>

# header-sid
SID: <jwt>

CreditAPI

Score

Authentication via display_token

type ScoreQuery = { display_token: CreditDisplayToken };

LevelCreditAPI.Credit.Score(settings: APIFetchSettings, query: ScoreQuery);
// -> Promise<Response<ScoreObject>>

Insights

Authentication via display_token

type InsightsQuery = { display_token: CreditDisplayToken };

LevelCreditAPI.Credit.Insights(settings: APIFetchSettings, query: InsightsQuery);
// -> Promise<Response<InsightsObject>>

ObligationAPI

Tradeline

Authetication via header or cookie

type TradelineQuery = {
  type: ObligationType; // "contract" | "leases" | "utilities"
  id: number; // id of obligation type
};

LevelCreditAPI.Obligation.Tradeline(settings: APIFetchSettings, query: TradelineQuery);
// -> Promise<Response<TradelineObject>>

ProtectionAPI

Monitoring

Authetication via header or cookie

type MonitoringQuery = Record<string, unknown>;

LevelCreditAPI.Protection.Monitoring.Monitoring(settings: APIFetchSettings, query: null | MonitoringQuery);
// -> Promise<Response<MonitoringObject>>

Monitoring Alerts

Authetication via header or cookie

type AlertsQuery = { id: number; dismiss?: boolean };

LevelCreditAPI.Protection.Monitoring.Alerts(settings: APIFetchSettings, null);
// -> Promise<Response<AlertSimple[]>>

LevelCreditAPI.Protection.Monitoring.Alerts(settings: APIFetchSettings, query: AlertsQuery);
// -> Promise<Response<AlertDetailed>>