API v3 Reference

info

Looking for V2 Docs?

We Recommend Using V4!

API Reference Overview

Introduction

This document provides information on how to interact with the Nova Credit API to obtain a Nova Credit Passport®.

The best way to run foreign credit checks using Nova Credit's API is to have your applicants use NovaConnect, an easy-to-use and secure JavaScript module. Visit our Quickstart Guide for all details on how to get Nova Credit API credentials and integrate NovaConnect into your app or website today.

Framework and Protocol

The Nova Credit API is organized around REST. It uses resource-oriented URLs, HTTP response codes, and native HTTP functionality such as authentication and verbs. Note that our APIs are served over HTTPS; HTTP is not supported in production.

Delivery Formats

JSON is the default response format except /connect/passport/<version>/pdf, which returns a pdf.

Endpoints

Our API host is api.novacredit.com. (See the Quickstart guide for environment information.)

Our resource URL patterns are:

Value	Description
/connect/accesstoken	Retrieves an access token for an applicant's Nova Credit Passport
/connect/passport/<version>/json	Retrieves an applicant's Nova Credit Passport in JSON form
/connect/passport/<version>/pdf	Retrieves an applicant's Nova Credit Passport in PDF form

Our JSON and PDF Credit Passport endpoints use versions to support breaking changes and backwards compatibility. The version should be specified as part of the resource URI (e.g.: api.novacredit.com/connect/passport/v3/json). You may read documentation for v2 here and for v1 here.

Country Bureau Specifics

See bureau-specific information here

Sandbox Mode

Sandbox Users by Country

Nova provides integrating clients with a number of test users that they can submit data for in order to analyze a response. By default, the information for only one user is present alongside NovaConnect when in the sandbox environment although the following user information may be submitted.

In general, the "Default User" for each bureau has a low risk profile and clean credit history.

Australia Equifax (AUS_EFX)

Inputs	Default (Low Risk) User	Medium Risk	High Risk
First name	Samantha	Charlotte	Noah
Last name	O'Connor	Williams	Taylor
Date of birth	03-30-1991	07-01-1991	09-20-1960
Email address	samantha@email.com	charlotte@email.com	noah@email.com
Gender	Female	Female	Male
Street address	10 Seahorse Court	Main Drive	24 Kingsland Road
Suburb	Indented Head	Werribee South	Berala
State	Victoria	Victoria	New South Wales
Postcode	3223	3030	2141
Australian Driver's License state of issue	New South Wales	Victoria	Victoria
Australian Driver's License number	98056840	85989564	85544842
Australian Driver's License card number	F1234567	098ABC	123XYZ
Australian Passport number	PA0000128		C5100511
Australian Medicare Card number	2951709671	2951777281
Australian Medicare Card reference number	1	1
Australian Medicare Card valid to date	04-2051	05-2051
Australian Medicare Card color	Green	Green
Australian Medicare Card middle name	E	none
Australian Immigration Card number	ABC123456
Australian Immigration Card birth month	March
Australian Immigration Card birth year	1991

Canada TransUnion (CAN_TU)

Inputs	Default (Low Risk) User	Medium Risk	High Risk
First name	Olivia	Fernando	John
Last name	Tremblay	Isabell	Fence
Email	olivia@email.com	fernando@email.com	john@email.com
Date of birth	04-25-1973	05-04-1955	10-11-1960
SIN	734779572
Address	33 Cork St W	170 Jackson Street West	100 Main Street West
City	Guelph	Hamilton	Hamilton
Province	Ontario (ON)	Ontario (ON)	Ontario (ON)
Postal code	N1H 2W9	L8P 1L9	L8P 1H6
Question 1/3	675 UPPER JAMES ST	BANK OF MONTREAL	ONTARIO
Question 2/3	CAR LOANS CANADA	NONE OF THE ABOVE	408 SCOOBY RD
Question 3/3	THE BAY CREDIT CARD	208 EMBARCADERO S	MAIN STREET WEST

Canada Equifax (CAN_EFX)

Inputs	Default (Low Risk) User	Medium Risk	High Risk
First name	Emma	Chris	Allen
Last name	Smith	Jerrold	Mikey
Email	emma@email.com	chris@email.com	allen@email.com
Date of birth	10-25-1989	01-11-1954	12-16-1967
SIN	111222333	111220231
Address	1966 Eglinton Avenue East	2320 16 Avenue Northwest	10520 111 Avenue Northwest
City	Toronto	Calgary	Edmonton
Province	Ontario (ON)	Alberta (AB)	Alberta (AB)
Postal code	M1L 2M6	T2N 4H8	T5G 0B6
Question 1/3	None of the above	Chartwell Road	HSBC
Question 2/3	None of the above	NSLSC	2014
Question 3/3	2333	0231	8888

China Chengxin Credit (CHN_CCX)

Inputs	Default (Low Risk) User	Medium Risk	High Risk
Chinese name	张三	徽因	望舒
Chinese resident ID	123456199001011233	110101198001236685	110101199001017559
Email	zhangsan@email.com	huiyin@email.com	wangshu@email.com
Chinese mobile number	13800138000	13800138000	13800138000

Great Britain Equifax (GBR_EFX)

Inputs	Default (Low Risk) User	Medium Risk	High Risk
First name	David	Nathan	Allie
Last name	Jones	Smith	Gretchen
Email	david@email.com	nathan@email.com	allie@email.com
Date of birth	10-25-1989	01-04-1988	12-30-1987
Street address	177 Brompton Road	11 Granby Road	4 Aaron Road
Post town	London	Bournemouth	Cirencester
Post code	SW31NF	BH9 3NZ	GL7 6JD
Question 1/3 (mobile phone/cable/credit card)	Vodafone	None of the above	Barclays
Question 2/3 (current account opened/credit limit)	Barclays	£ 2000 - £ 2500	None of the above
Question 3/3 (overdraft limit)	£ 2500 to £ 2999	£ 2500 to £ 2999	£ 50 - £ 100

India Crif High Mark (IND_CHM)

Inputs	Default (Low Risk) User	Medium Risk	High Risk
First name	Raj	Diya	Sona
Last name	Du	Puja	Arati
Date of birth	10-25-1989	02-06-1976	10-11-1966
Father's last name	Du	Puja	Arati
Email address	rajdu@email.com	diya@email.com	sona@email.com
Indian phone number	6233334444	7234567892	8580066232
Street address	2 Community Center	55 Park Street	1 Juhu Tara Road
City	New Delhi	Kolkata	Mumbai
State	Delhi (DL)	West Bengal (WB)	Maharashtra (MH)
Pincode	110017	700017	400049
PAN number	ADIPA8123J	AFUPJ7365N	AAWPH3050M
Voter ID number	86953789734322	866849897356234	95134121422221
Question 1	RBL Bank	None of the above	36,000
Question 2	New Delhi	ICICI Bank	Yes Bank
Question 3	2005	7	2

India TransUnion CIBIL (IND_CIBIL)

info

Please note that if the correct security code is entered, other security questions will not be asked.

Inputs	Default (Low Risk) User	Medium Risk	High Risk
First name	Anik	Astha Sai	Vijay
Last name	Shah	Dutta	Pratap Krish
Date of birth	11-26-1992	01-28-1986	01-13-1995
Gender	Male	Female	Male
Email address	anik@email.com	astha@email.com	vijay@email.com
Indian phone number	9773949726	9775550000	9779991234
Street address	2 3218 STREET NO 2 BALBIR NAGARSHAHDRA	1 Daresi Rd, Sheb Bazar, Rakabganj	101, MI Road, Bapu Bazar, Biseswarji
City	Delhi	Agra	Jaipur
State	Delhi (DL)	Uttar Pradesh (UP)	Rajasthan (RJ)
Pincode	110009	282003	302001
PAN number	YEHPG0098E	ABCPD0000A	XYZPK2020K
Passport number	A1234567	A00001234	A12341234
Security code	092090	925925	561678
Question 1	Scb	Sbi Card	None of the Above
Question 2	1500001	17000	I Don't Have An Account With Icici Bank
Question 3	147000	30000	25000
Question 4	Pnb Hsg	Rbl Bank	Axis Bank
Question 5	Bajaj Fin Ltd	Icici Bank	Axis Bank

Mexico Circulo de Credito (MEX_CDC)

Inputs	Default (Low Risk) User	Medium Risk	High Risk
First name	Juan	Xavier	Alexis
Father's last name	Garcia	Jose	Elena
Mother's last name	Gonzales	Barrios	Quipa
Date of birth	10-25-1989	12-12-1972	06-03-1982
Email address	juan@email.com	xavier@email.com	alexis@email.com
Street name and number	357 Avenida Insurgentes Sur	2 Calle James Sullivan	1 Miguel Laurent
City	Ciudad de México	Ciudad de México	Ciudad de México
Zipcode	06100	06470	03200
State	Ciudad de México (CDMX)	Ciudad de México (CDMX)	Ciudad de México (CDMX)
Do you have an active mortgage in Mexico?	No	No	Yes
Have you had an auto loan in the last 2 years in Mexico?	Yes	Yes	No
Do you have an active credit card in Mexico?	Yes	Yes	No
Provide the last 4 digits of any of your Mexican credit cards	0000	4827

Mexico Buro de Credito (MEX_BDC)

Inputs	Default (Low Risk) User	Medium Risk	High Risk
First name	Lara	Alejandra	Mitzi
Second name	del Rosario	Maria	Manuela
Father's last name	Ortega	Hernández	Martínez
Mother's last name	Fuentes	García	Márquez
Date of birth	05-06-1992	11-06-1992	10-26-1999
Email address	lara@email.com	alejandra@email.com	mitzi@email.com
Street name and number	Jaime Balmes #8	Calle Ozuluama 4	Av. Benjamín Franklin 45
City	Ciudad de México	Ciudad de México	Ciudad de México
District/Town	Los Morales Polanco	Hipódromo	Colonia Condesa
Zipcode	11510	06100	06140
State	Ciudad de México (CDMX)	Ciudad de México (CDMX)	Ciudad de México (CDMX)
Do you have an active mortgage in Mexico?	Yes	Yes	No
Have you had an auto loan in the last 2 years in Mexico?	No	No	No
Do you have an active credit card in Mexico?	Yes	Yes	No
Provide the last 4 digits of any of your Mexican credit cards	1234	1910

Korea NICE (KOR_NICE)

Inputs	Default (Low Risk) User	Medium Risk	High Risk
Full name	이지훈	신은선	박수진
Date of birth	10-20-1975	11-01-1990	05-30-1994
Email	jihoon@email.com	eunsun@email.com	soojin@email.com
Gender	Male	Female	Female
Phone number	+1 (415) 555-5555	+1 (408) 590-4123	+1 (420) 143-1738

Nigeria CRC (NGA_CRC)

Inputs	Default (Low Risk) User	Medium Risk	High Risk
Full name	Daraja Attah	Aminu Ojo Oni	Sunkanmi Oyekan
Bank verification number	83920323750	22237445315	43098094389
Date of birth	01-15-1985	04-13-1977	09-22-1968
Gender	Female	Male	Male
Email address	daraja@email.com	aminu@email.com	sunkanmi@email.com

Brazil Experian (BRA_XP)

Inputs	Default (Low Risk) User
First name	Ana
Last name	Silva
Date of birth	03-25-1980
CPF number	170.719.241-39
Email address	ana@email.com

Kenya Creditinfo (KEN_CI)

Inputs	Default (Low Risk) User	Medium Risk	High Risk
First name	Wangechi	Naliaka	Vincent
Last name	Mwangi	Makani	Abong'o
Date of birth	05-05-1980	01-27-1988	04-20-1994
National ID	40133214	30581375	31665491
Email address	wangechi@email.com	naliaka@email.com	vincent@email.com
Name of the financial institution where you took your last non-mobile loan	Kenya Commercial Bank Ltd	Chase Bank (K) Ltd.	Standard Chartered Bank Kenya
When did you take out your last non-mobile loan?	2016-08	2016-07	2016-08
Have you ever taken a mobile loan?	Yes	Yes	Yes
Which of these is the last four digits of a past or current Kenyan mobile phone number?	6006	3737	2550

Dominican Republic TransUnion (DOM_TU)

Inputs	Default (Low Risk) User	Medium Risk	High Risk
Full name	Jean Carlos Rodriguez Garcia	Juana Mercedes Toribio Reyes	Maria Jose Maderas Troncoso
Date of birth	08-06-1993	04-18-1963	09-22-1981
National ID	11700074831	00200106557	00200994465
Email address	jean@email.com	juana@email.com	maria@email.com
Question 1	None of the above	None of the above	None of the above
Question 2	None of the above	None of the above	1
Question 3	1	3	1
Question 4	No	Yes	Yes
Question 5	None of the above	None of the above	EMIGK

Stripe Sandbox Values

If you have applicant payments enabled for your account, you may use the following fake credit card numbers to test the applicant's end-to-end Nova application, including simulations of an applicant's payment for their Nova Credit Passport.

info

Please note that this feature is only available for select customers. Contact your Nova Credit Representative to learn more.

Description	Card Number	Name on Card	Expiration Date	CVC
Successful Payment (credit card)	4242424242424242	Anything	Anything in the future	Anything
Unsuccessful Payment (credit card decline)	4242424242424000	Anything	Anything in the future	Anything

Simulating Different Cases in NovaConnect

When using NovaConnect in sandbox mode, you may input one of the following values in the Last Name field (in some country forms, the Father's last name or Full name field) to more conveniently simulate different cases:

Inputs	Description
bureaudown	Simulates the error shown when a bureau is offline or unresponsive
error	Simulates generic NovaConnect error
timeout	Simulates the countdown shown to an applicant who has failed their first attempt and not completed a second

Data Types & Formats

Data Types

Type	Description
String	Extended character set, numbers and punctuation symbols. This includes non-ASCII language-specific characters such as ß, à, ç, é, and more (all encoded as utf8).
Integer	A rounded numerical value.
Float	A 64-bit floating decimal point format.
Bool	A boolean-flag indicating true or false.
Object	Nested JSON level with more field-values.
Array	A value or type array contains a zero or positive amount of elements. The elements can be of any type.
Null	The reserved value null. May be combined with other types as in Bool or Null

Data Formats

Format	Description
Timestamp	(String) UTC ISO 8601 data and time format. Full specs according to RFC 3339. Example: 1982-09-26T32:20:50.52Z
Full Date	(String) UTC ISO 8601 date format. Full date format in YYYY-MM-DD. Example: 1982-09-26
Short Date	(String) UTC ISO 8601 date format. Shorter format in YYYY-MM. Example: 1982-09
UUID	(String) Universally Unique Identifier according to RFC 4122
URI	(String) Uniform Resource Identifier according to RFC 3986
Short Version	(String) Version number is predicated with "V" e.g. "V1", "V2", "V3", or "V4". Case insensitive.
Full Version	(String) Semantic versioning. http://semver.org/
Percentage	(Float, 2 decimal) Formatted in the range of 0 - 100% excluding percentage symbol
Pipe	(String) Pipe-delimited string of values. E.g. val1 (Pipe) val2 (Pipe) val3
ISO 3166-1 alpha-3	(String) Three letter country codes. E.g. CAN, MEX, IND
ISO 4217	(String) Three letter currency code. E.g. USD, EUR, INR

Credit Passport® Structure

Example of the JSON structure of the Nova Credit Passport® response:
{
  "meta": {
    ...
  },
  "personal": {
    ...
  },
  "product": {
    ...
  },
  "currencies": [
    ...
  ],
  "scores": [
    ...
  ],
  "tradelines": [
    ...
  ],
  "bank_accounts": [
    ...
  ],
  "public_records": [
    ...
  ],
  "frauds": [
    ...
  ],
  "collections": [
    ...
  ],
  "nonsufficient_funds": [
    ...
  ],
  "addresses": [
    ...
  ],
  "employers": [
    ...
  ],
  "disputes": [
    ...
  ],
  "notices": [
    ...
  ],
  "metrics": [
    ...
  ],
}

The Nova Credit Passport® response body is segmented into three objects and seven arrays with additional data being country-specific. The structure is as follows:

• meta {object}
• personal {object}
• product {object}
• currencies [array]
• scores [array]
• tradelines [array]
• inquiries [array]
• addresses [array]
• metrics [array]

In addition to the above elements, certain countries provide applicant data that others don't. In the documentation below, you will find corresponding tables that show which bureaus that support each of these nodes:

• public_records [array]
• frauds [array]
• collections [array]
• nonsufficient_funds [array]
• bank_accounts [array]
• employers [array]
• disputes [array]
• notices [array]

Credit Passport® Body

meta {}

Example meta response:

{
  "meta": {
    "public_token": "ff0886a4-f3ff-11e6-bc64-92361f002671",
    "pdf_name": "raj_du_92361f002671",
    "external_id": "d20f8cb2-969a-4448-97ea-c0680ed4d880",
    "user_args": "235234224",
    "callback_URL": "http://mydomain.com/nova",
    "callback_URL_called_date": "2017-01-13T11:07:59.51Z",
    "created_at": "2017-01-13T11:07:46.51Z",
    "country": "IND",
    "company_code": "IND_CHM",
    "api_version": "3.6.85",
    "consent_version": "1.4.73",
    "bureau_report_id": "214abi4fop1a4"
  },
  ...
}

Information specific to the report that's been returned.

Field	Format	Notes
public_token	UUID	The unique identifier of this report
pdf_name	String	File name of the associated PDF report
external_id	String	The unique identifier of the report, this is defined by the institution pulling this report
user_args	String	The input of the userArgs function in NovaConnect
callback_URL	URI	The callback URL defined by the integrating partner
callback_URL_called_date	Timestamp
created_at	Timestamp	The date the credit report was retrieved
country	ISO 3166-1 alpha-3	Origin country of the applicant See country
country_destination	ISO 3166-1 alpha-3	Destination country, the country the creditor operates in See country
company_code	String	Code representing the country & foreign bureau used to pull report See company_code
api_version	Full version	The API version used to generate this report
consent_version	Full version	The consent version the applicant agreed to
bureau_report_id	String	The foreign bureau's unique report identifier

product {}

Example product response:

{
  "product": {
    "name": "Village Communities",
    "product_id": "9cf178e0-760e-11e7-abf3-5da9d338ae4b",
    "inquiry_type": "TENANT"
  },
  ...
}

Details of the product the applicant applied for. Please refer to the Product reference in the Quickstart Guide.

Field	Format	Notes
name	String	Product name as specified in Nova Credit Dashboard
product_id	UUID
inquiry_type	String	See product inquiry types

personal {}

Example personal response:

{
  "personal": {
      "first_name": "Raj",
      "last_name": "Du",
      "full_name": "Raj Du",
      "email": "rajdu@email.com",
      "telephone": "+9146270422",
      "date_of_birth": "1989-10-25",
      "foreign_id": "ADIPA8123J",
      "foreign_id_type": "PERMANENT_ACCOUNT_NUMBER"
    },
  ...
}

Information specific to the applicant whose credit report is being accessed.

Field	Format	Notes
first_name	String
last_name	String
full_name	String	Combination of the applicant's first and last name. For Mexico, this is the first name, father's last name, then mother's last name.
middle_name	String
transliterated_full_name	String	Romanization of applicant's full name
other_names	String	A comma-separated list of other names associated with applicant, such as aliases, maiden names, and other surnames
email	String
telephone	String
date_of_birth	Full Date
year_of_birth	String	Only provided if a full date of birth is not available, but the year is. date_of_birth will be omitted in this case
is_deceased	Bool
date_of_death	Full Date or short date	Only provided if is_deceased is true
foreign_id	String	The foreign ID provided to us by the consumer. Note that this field may not always be present.
foreign_id_type	String	The type of ID being displayed in capital snake case. In the PDF this field will appear in plain text (e.g., Permanent Account Number (PAN)). Note that this field may not always be present. See foreign_id_type

scores []

Example scores response:
{
  "scores": [{
      "score_type": "NOVA_SCORE_BETA",
      "score_version": "1.0.5",
      "value": 798,
      "risk_indicator": "MEDIUM_RISK",
      "history": [
        {
          "value": 798,
          "risk_indicator": "MEDIUM_RISK",
          "date_reported": "2019-02-28"
        }
        ...
      ],
    },
    {
      "score_type": "FOREIGN_SCORE",
      "value": "992",
      "risk_indicator": "LOW_RISK",
      "adverse_action_codes": [{
        ...
      }, {
        ...
      }],
      "history": [
        {
          "value": "992",
          "risk_indicator": "LOW_RISK",
          "date_reported": "2019-02-28",
          "adverse_action_codes": [],
        },
        ...
      ],
    }
  ],
  ...
}

Information specific to the applicant's credit score, including both the foreign data supplier’s score, as well as the Nova score. scores are returned in an array, and all elements follow the same structure.

Field	Format	Notes
score_type	String	See score_type
score_version	Full version	Only applies if score_type is not FOREIGN_SCORE
value	Integer OR String	Value of the score. Integer if type NOVA_SCORE_BETA, string otherwise.
risk_indicator	String	See risk_indicator
prob_default	Deprecated
adverse_action_codes	Array	See adverse_action_codes
history	Array	See history

history

A child to scores, history is an array of historical scores and associated data.

Field	Format	Notes
date_reported	Full Date or short date	Date at which historical score object was reported.
value	Integer OR String	Value of the score. Integer if type NOVA_SCORE_BETA, string otherwise.
risk_indicator	String	See risk_indicator
prob_default	Deprecated
adverse_action_codes	Array	See adverse_action_codes

adverse_action_codes

Example response from the adverse_action_codes array:
...,
  "adverse_action_codes": [{
    "code": "T2",
    "description": "Many revolving accounts bank national"
  },
  {
    "code": "M0",
    "description": "It has a number of accounts currently in default"
  },
  {
    "code": "R1",
    "description": "Very few accounts with balances"
  }]
}

A child to scores, adverse_action_codes are the codes that are either provided directly by the foreign bureau partner or generated by Nova Credit using the consumer credit data provided by the foreign bureau partner, and detail the reasoning behind the score returned. adverse_action_codes are returned in an array, can have zero objects, and there is no upper bound.

Field	Format	Notes
code	String	See adverse_action_codes by bureau
description	String

metrics []

Example of three metrics within the metrics array:
{
  "metrics": [
    {
      "metric_status": "AVAILABLE",
      "metric_source": "NOVA",
      "metric_name": "AGE_TRADELINE_OLDEST",
      "metric_value": 32,
      "metric_label": "Age of Oldest Tradeline (months)",
      "metric_format": "NUMERIC",
      "metric_type": "AGE_MONTHS"
    },
    {
      "metric_status": "AVAILABLE",
      "metric_source": "NOVA",
      "metric_name": "RATIO_CREDIT_UTILIZATION_REVOLVING",
      "metric_value": 0.40103270223752152,
      "metric_label": "Revolving Credit Utilization Ratio",
      "metric_format": "NUMERIC",
      "metric_type": "RATIO"
    },
  ],
  ...
}

Metrics are analytical values derived from the underlying data in the Nova Credit Passport®. metrics are returned in an array and are of configurable length; the array can have zero objects, and there is no upper bound.

By default, eight metrics are included in every response:

• AGE_TRADELINE_OLDEST
• COUNT_INQUIRIES_LAST_SIX_MONTHS
• COUNT_TRADELINES_OPEN
• COUNT_TRADELINES_PAST_DUE_1_OR_MORE_PAY_CYCLES_LAST_12_MONTHS
• COUNT_TRADELINES_PAST_DUE_3_OR_MORE_PAY_CYCLES
• RATIO_CREDIT_UTILIZATION_REVOLVING
• TOTAL_DEBT_ALL_OPEN
• TOTAL_SCHEDULED_PAYMENT_OBLIGATIONS_ALL_OPEN

You can remove these metrics or add additional metrics to your reports by contacting your Nova Credit Representative. Once configured, the ordering and size of the metrics array is consistent across API responses (with the exception of bureau summary data, noted below).

It is possible that you will want to reconfigure these metrics after your initial integration with our API; please consider an approach that permits adding and removing metrics without incurring additional integration work. If you have configured customized metrics, or intend to in the future, please contact your Nova Credit Representative for additional examples, details, and advice. It is particularly important that you discuss the mechanics of your metric integration if it relies on a fixed ordering or maximum number of metrics.

In addition to the metrics included in every report, the foreign bureau may provide additional summary data. In this case, these additional metrics will be prepended to the metrics array and can be differentiated by the value of metric_source.

Field	Format	Notes
metric_name	String	See metric_name
metric_value	Number	Value of the metric
metric_status	String	See metric_status
metric_source	String	See metric_source
metric_label	String	See metric_label
metric_type	String	See metric_type
metric_format	String	See metric_format
most_recent_date	Full Date or short date	Date of first instance in the values array (Timeseries only)
metric_timeseries	Object	See metric_timeseries
metric_range	Array	2-length numeric array of [lowerbound, upperbound] inclusive range

metric_timeseries

Object containing values and interval of timeseries data

Field	Format	Notes
interval	String	Time interval between metrics in the values array (Timeseries only) See interval
values	Array	Array of timeseries data

currencies []

Example currencies response:

{
  "currencies": [{
    "original": "INR",
    "target": "USD",
    "rate": "0.015",
    "source": "ECB",
    "date": "2017-01-12"
  }],
  ...
}

An array of currencies found in the response and information relating to their conversion.

Field	Format	Notes
original	ISO 4217	The original currency the values were returned in
target	ISO 4217	The currency the original currency was converted to
rate	String	The daily rate at which the conversion was made. Can be coerced to float
source	String	See currency_source
date	Full Date or Short Date	The date at which the conversion occurred

tradelines []

Example response from the tradelines array:
{
  "tradelines": [{
    "tradeline_id": "44dd200a-f404-11e6-bc64-92361f002671",
    "institution": null,
    "original_currency": "INR",
    "date_opened": "2012-12-22",
    "date_last_reported": "2017-01-01",
    "past_due_balance": 0,
    "current_pay_status": "CURRENT",
    "scheduled_payment": 500,
    "history_frequency": "MONTHLY",
    "portfolio_type": "REAL_ESTATE",
    "account_type": "MORTGAGE",
    "current_condition_type": "TRANSFER_SOLD",
    "current_condition_status": "ACTIVE",
    "responsibility": "INDIVIDUAL",
    "balance": 1104,
    "high_balance": 1502,
    "credit_limit": 4100,
    "payment_obligation_frequency": "MONTHLY",
    "history": [{
      ...
    }, {
      ...
    }]
  }]
}

Tradelines refer to the applicant's previous and current credit-related products that they have held in the past seven years. Tradelines are returned in an array, can have zero objects, and there is no upper bound.

Field	Format	Notes
tradeline_id	UUID	Reference ID of the tradeline
institution	String or Null. For compliance reasons, this field will be null except for special cases	Name of the lending institution
translated_institution	String or Null. For compliance reasons, this field will be null except for special cases	Translated name of the lending institution
original_currency	ISO 4217
date_opened	Full Date or Short Date
date_last_reported	Full Date or Short Date
date_negative_reported	Full Date or Short Date	The date that the tradeline reached negative status as indicated by the credit reporting institution
date_closed	Full Date or Short Date
last_payment_amount	Integer
past_due_balance	Integer
current_pay_status	String	See current_pay_status
current_pay_substatus	String	See current_pay_substatus
scheduled_payment	Integer
history_frequency	String	See history_frequency
portfolio_type	String	See portfolio_type
account_type	String	See account_type
current_condition_type	String	See current_condition_type
current_condition_status	String	See current_condition_status
responsibility	String	See responsibility
balance	Integer
high_balance	Integer
credit_limit	Integer
is_open	Bool
is_collateralized	Bool
original_loan	Integer
history	Array	See history
payment_obligation_frequency	String	See payment_obligation_frequency
charge_off_amount	Integer
comments	Array	See comments

history

Monthly history example over three years:
{
  "history": [{
    "year": "2016",
    "payments": [null, null, null, 1, 1, 1, 0, 0, 0, 0, 0, 0],
    "balances": [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],
    "credit_limits": [710, 710, 710, 710, 710, 710, 710, 710, 710, 710, 710, 700],
  }, {
    "year": "2015",
    "payments": [0, 0, 1, 2, 2, 0, 0, 0, -1, -1, -1, -1],
    "balances": [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],
    "credit_limits": [710, 710, 710, 710, 710, 710, 710, 710, 710, 710, 710, 700],
  }]
}

A child to tradelines, history refers to the applicant's tradeline activity. history is returned in an array and can have zero objects or a maximum of 7 objects (one object per year).

The format of history depends on the history_frequency value of the tradeline, which will most often be MONTHLY.

There are multiple histories that the history node reports and are denoted by separate keys in each history object. See the list of supported histories by country at the bottom of the page.

Field	Description	Format	Notes
year		Integer{4}	YYYY
payments	A history of payments made. Credit accounts only	Array	null = N/A payment, out of range -1 = reported but unknown specifics 0 = paid on time 1 = Less than or equal to 1 pay period late 2 = Less than or equal to 2 pay periods late 3 = Less than or equal to 3 pay periods late 4 = Less than or equal to 4 pay periods late 5 = 5 or more pay periods late
balances	A history of the tradeline's account balances. Credit accounts only	Array	null = N/A payment, out of range
credit_limits	A history of the tradeline's credit limits. Credit accounts only	Array	null = N/A payment, out of range

history_frequency explanation

History Frequency	Explanation
MONTHLY	Array length equal to 12. The first element is the month of December and the last is January. Nova cannot distinguish where in that month the payment happened, hence Nova defaults to counting from the end of the month onward.
BI_MONTHLY (every two months)	Array length equal to 6. The first element is the month of December and the last is January. Nova cannot distinguish where in that month the payment happened, hence Nova defaults to counting from the end of the two months onward.
SEMI_MONTHLY (twice in a month)	Array length equal to 24.
WEEKLY	Array length equal to 52. The first element is the last week of the year. Nova cannot distinguish where in that month the payment happened, hence Nova defaults to counting from the end of the week.
BI_WEEKLY (every two weeks)	Array length equal to 26.
QUARTERLY	Array length equal to 4. The first element is the month of December and the last is April. Nova cannot distinguish where in that month the payment happened, hence Nova defaults to counting from the end of the quarter onward.
SEMI_ANNUAL	Array length equal to 2. The first element is the month of December and the second element is the month of July.
ANNUAL	Array length equal to 1. The first element is the month of December. Nova cannot distinguish where in that year the payment happened, hence Nova defaults to counting from the end of the year onward.

Available Histories by Country

	payments	balances	credit_limits
Canada TransUnion (CAN_TU)	✓	✗	✗
Canada Equifax (CAN_EFX)	✓	✗	✗
Great Britain Equifax (GBR_EFX)	✓	✓	✓
India Crif High Mark (IND_CHM)	✓	✗	✗
India CIBIL (IND_CIBIL)	✓	✗	✗
Mexico Circulo de Credito (MEX_CDC)	✓	✗	✗
Mexico Buro de Credito (MEX_BDC)	✓	✗	✗
Australia Equifax (AUS_EFX)	✓	✗	✗
Korea NICE (KOR_NICE)	✗	✗	✗
Nigeria CRC (NGA_CRC)	✓	✗	✗
Brazil Experian (BRA_XP)	✗	✗	✗
Kenya Creditinfo (KEN_CI)	✓	✗	✗
Dominican Republic TransUnion (DOM_TU)	✓	✗	✗
United States (USA_XP)	✓	✗	✗

bank_accounts []

Example response from the bank_accounts array:
{
  "bank_accounts": [{
    "bank_account_id": "8c46ab70-d485-11e7-a5ca-95dbcbcedd5b",
    "bank_account_type": "CHECKING",
    "responsibility": "INDIVIDUAL",
    "date_last_reported": "2017-11-01",
    "date_opened": "2015-07-19",
    "current_pay_status": "CURRENT",
    "institution": null,
    "is_overdraftable": false,
    "is_overdrawn": false,
    "balance": 20048,
    "original_currency": "GBP",
    "comments": [ ... ]
  }]
}

Bank accounts refer to the applicant's previous and current bank account products, which they've held over the past seven years. Bank accounts are returned in an array, can have zero objects, and there is no upper bound.

Field	Format	Notes
bank_account_id	UUID	Reference ID of the bank account
bank_account_type	String	See bank_account_type
date_last_reported	Full Date or Short Date
date_opened	Full Date or Short Date
date_closed	Full Date or Short Date
current_pay_status	String	When no overdraft has ever occurred on the bank account, this field can be blank. See current_pay_status
current_pay_substatus	String	When no overdraft has ever occurred on the bank account, this field can be blank. See current_pay_substatus
institution	String or Null	Name of the institution providing the account. For compliance reasons, this field will be null except for special cases
translated_institution	String or Null	Translated name of the institution providing the account. For compliance reasons, this field will be null except for special cases
is_overdraftable	Bool	The bank account has an overdraft facility
is_overdrawn	Bool	Indicates if an overdraft event occurred in the past
responsibility	String	See responsibility
balance	Integer
original_currency	ISO 4217
comments	Array	See comments

Supported Bureaus

	bank_accounts
Canada TransUnion (CAN_TU)	✓
Canada Equifax (CAN_EFX)	✓
Great Britain Equifax (GBR_EFX)	✓
India Crif High Mark (IND_CHM)	✗
India CIBIL (IND_CIBIL)	✗
Mexico Circulo de Credito (MEX_CDC)	✗
Mexico Buro de Credito (MEX_BDC)	✗
Australia Equifax (AUS_EFX)	✗
Korea NICE (KOR_NICE)	✓
Nigeria CRC (NGA_CRC)	✗
Brazil Experian (BRA_XP)	✗
Kenya Creditinfo (KEN_CI)	✗
Dominican Republic TransUnion (DOM_TU)	✗
United States (USA_XP)	✗

public_records []

Example response from the public_records array:
{
  "public_records": [{
    "public_record_id": "8c463646-d485-11e7-a5ca-95dbcbcedd5b",
    "public_record_type": "FORECLOSURE",
    "is_resolved": true,
    "date_filed": "2014-06-01",
    "court_name": "ABERDARE",
    "date_last_reported": "2014-08-01",
    "comments": [ ... ],
  }]
}

Public records refer to the applicant's previous and current public records, which they've held over the past seven years. public_records are returned in an array, can have zero objects, and there is no upper bound.

Field	Format	Notes
public_record_id	UUID	Reference ID of the public record
public_record_type	String	See public_record_type
is_resolved	Bool
date_filed	Full Date or Short Date
court_name	String
date_last_reported	Full Date or Short Date
comments	Array	See comments

Supported Bureaus

	public_records
Canada TransUnion (CAN_TU)	✓
Canada Equifax (CAN_EFX)	✓
Great Britain Equifax (GBR_EFX)	✓
India Crif High Mark (IND_CHM)	✗
India CIBIL (IND_CIBIL)	✗
Mexico Circulo de Credito (MEX_CDC)	✗
Mexico Buro de Credito (MEX_BDC)	✗
Australia Equifax (AUS_EFX)	✓
Korea NICE (KOR_NICE)	✓
Nigeria CRC (NGA_CRC)	✗
Brazil Experian (BRA_XP)	✓
Kenya Creditinfo (KEN_CI)	✗
Dominican Republic TransUnion (DOM_TU)	✗
United States (USA_XP)	✓

frauds []

Example response from the frauds array:
{
  "frauds": [{
    "fraud_id": "dff5b307-8834-461f-b2f6-605ed9ff67a9",
    "date_reported": "2016-12-12",
    "is_fraudster": false,
    "comments": [ ... ],
    "linked_entries": {
        "tradeline_id": "154ef107-f406-466b-8545-544e3e210cd0",
    },
  }],
}

Frauds refer to the applicant's previous and current fraud reports, which they've held over the past seven years. Frauds are returned in an array, can have zero objects, and there is no upper bound.

The data provided in the frauds node is returned unaltered from the supplying credit bureau. To see a complete list of potential values returned for frauds, please contact your Nova Credit Representative.

Field	Format	Notes
fraud_id	UUID	Reference ID of the fraud
date_reported	Full date
is_fraudster	Bool	true if the consumer is the perpetrator of the fraud, false if the consumer is the victim of the fraud
comments	Array	See comments
linked_entries	Object	See linked_entries

Supported Bureaus

	frauds
Canada TransUnion (CAN_TU)	✓
Canada Equifax (CAN_EFX)	✓
Great Britain Equifax (GBR_EFX)	✗
India Crif High Mark (IND_CHM)	✗
India CIBIL (IND_CIBIL)	✗
Mexico Circulo de Credito (MEX_CDC)	✓
Mexico Buro de Credito (MEX_BDC)	✓
Australia Equifax (AUS_EFX)	✗
Korea NICE (KOR_NICE)	✓
Nigeria CRC (NGA_CRC)	✗
Brazil Experian (BRA_XP)	✗
Kenya Creditinfo (KEN_CI)	✓
Dominican Republic TransUnion (DOM_TU)	✓
United States (USA_XP)	✗

collections []

Example response from the collections array:
{
  "collections": [{
    "collection_id": "53ffcad0-3f10-4b73-b87f-5624af48701d",
    "is_paid": true,
    "agency_name": "METRO RECOVERY",
    "date_last_reported": "2015-11-01",
    "balance": 176,
    "date_filed": "2016-07-01",
    "date_last_payment": "2015-11-01",
    "original_currency": "CAD",
    "comments": [ ... ],
    "linked_entries": {
        "tradeline_id": "90fa6676-e4bc-4c06-ad94-24dbf32ddcb4",
    },
  }]
}

Collections refer to the third party collections made on the applicant's accounts, which they've held over the past seven years. collections are returned in an array, can have zero objects, and there is no upper bound.

Field	Format	Notes
collection_id	UUID	Reference ID of the collection
is_paid	Bool
agency_name	String	Collection agency name
date_last_reported	Full Date or Short Date
balance	Integer	Amount still owed to agency
date_filed	Full Date or Short Date	Date collection was given to collection agency
date_last_payment	Full Date or Short Date
original_currency	ISO 4217
statement	String	Full description of the collection
comments	Array	See comments
linked_entries	Object	See linked_entries

Supported Bureaus

	collections
Canada TransUnion (CAN_TU)	✓
Canada Equifax (CAN_EFX)	✓
Great Britain Equifax (GBR_EFX)	✓
India Crif High Mark (IND_CHM)	✗
India CIBIL (IND_CIBIL)	✗
Mexico Circulo de Credito (MEX_CDC)	✓
Mexico Buro de Credito (MEX_BDC)	✓
Australia Equifax (AUS_EFX)	✓
Korea NICE (KOR_NICE)	✓
Nigeria CRC (NGA_CRC)	✗
Brazil Experian (BRA_XP)	✗
Kenya Creditinfo (KEN_CI)	✗
Dominican Republic TransUnion (DOM_TU)	✗

nonsufficient_funds []

Example response from the nonsufficient funds array:
{
  "nonsufficient_funds": [{
    "nonsufficient_fund_id": "ba44d46d-5c85-479f-bb90-eb20bb726cc7",
    "nonsufficient_date": "2015-03-01",
    "date_last_reported": "2015-07-01",
    "comments": [ ... ],
    "linked_entries": {
        "bank_account_id": "ba44a76a-cb02-43c9-8490-c9ed92b36f3c",
    },
  }]
}

Nonsufficient funds refer to the nonsufficient fund reports made on the applicant's accounts, which they've held over the past seven years. nonsufficient_funds are returned in an array, can have zero objects, and there is no upper bound.

Field	Format	Notes
nonsufficient_fund_id	UUID	Reference ID of the nonsufficient fund
nonsufficient_date	Full Date or Short Date	Date initially reported
date_last_reported	Full Date or Short Date
comments	Array	See comments
linked_entries	Object	See linked_entries

Supported Bureaus

	nonsufficient_funds
Canada TransUnion (CAN_TU)	✓
Canada Equifax (CAN_EFX)	✓
Great Britain Equifax (GBR_EFX)	✓
India Crif High Mark (IND_CHM)	✗
India CIBIL (IND_CIBIL)	✗
Mexico Circulo de Credito (MEX_CDC)	✗
Mexico Buro de Credito (MEX_BDC)	✗
Australia Equifax (AUS_EFX)	✗
Korea NICE (KOR_NICE)	✓
Nigeria CRC (NGA_CRC)	✗
Brazil Experian (BRA_XP)	✓
Kenya Creditinfo (KEN_CI)	✗
Dominican Republic TransUnion (DOM_TU)	✗
United States (USA_XP)	✗

inquiries []

Example of two inquiries within the inquiries array:
{
  "inquiries": [
    {
      "inquiry_id": "f9609e9e-f404-11e6-bc64-92361f002671",
      "inquiry_date": "2016-09-22",
      "company_name": null,
      "is_credit_seeking": true,
      "inquiry_account_type": "STUDENT",
      "is_collateralized": false
    },
    {
      "inquiry_id": "08dd0f88-f405-11e6-bc64-92361f002671",
      "inquiry_date": "2016-09-22",
      "company_name": null,
      "is_credit_seeking": true,
      "inquiry_account_type": "MORTGAGE",
      "is_collateralized": true,
      "comments": ["Some comment"]
    }
  ],
  ...
}

Inquiries are the credit inquiries that have been performed on the applicant's account over the past seven years. inquiries are returned in an array, can have zero objects, and there is no upper bound.

Field	Format	Notes
inquiry_id	UUID	Reference ID of the inquiry
is_credit_seeking	Bool	Whether the inquiry is soft (false) or hard (true)
is_collateralized	Bool	Whether the inquiry is collateralized
inquiry_account_type	String	Indicates the account type linked to an individual's historic inquiries where this information is available. See inquiry_account_type
inquiry_date	Full Date or Short Date
company_name	String or Null. For compliance reasons, this field will be null except for special cases
translated_company_name	String or Null. For compliance reasons, this field will be null except for special cases
comments	Array	See comments

Supported Bureaus

	inquiries
Canada TransUnion (CAN_TU)	✓
Canada Equifax (CAN_EFX)	✓
Great Britain Equifax (GBR_EFX)	✓
India Crif High Mark (IND_CHM)	✓
India CIBIL (IND_CIBIL)	✓
Mexico Circulo de Credito (MEX_CDC)	✓
Mexico Buro de Credito (MEX_BDC)	✓
Australia Equifax (AUS_EFX)	✓
Korea NICE (KOR_NICE)	✗
Nigeria CRC (NGA_CRC)	✓
Brazil Experian (BRA_XP)	✓
Kenya Creditinfo (KEN_CI)	✓
Dominican Republic TransUnion (DOM_TU)	✓
United States (USA_XP)	✓

employers []

Example of the employers array:
{
  "employers": [
    {
      "employer_id": "682ed21e-f405-11e6-bc64-92361f002671",
      "company_name": null,
      "annual_salary": 50000
    }
  ],
  ...
}

Employers is a history of the applicant’s work experience. employers are returned in an array, can have zero objects, and there is no upper bound.

Field	Format	Notes
employer_id	UUID	Reference ID of this employer
company_name	String or Null. For compliance reasons, this field will be null except for special cases
job_title	String
annual_salary	Integer
original_currency	ISO 4217	Only provided if annual_salary exists
date_reported	Full Date or Short Date
comments	Array	See comments

Supported Bureaus

	employers
Canada TransUnion (CAN_TU)	✓
Canada Equifax (CAN_EFX)	✓
Great Britain Equifax (GBR_EFX)	✗
India Crif High Mark (IND_CHM)	✗
India CIBIL (IND_CIBIL)	✓
Mexico Circulo de Credito (MEX_CDC)	✓
Mexico Buro de Credito (MEX_BDC)	✓
Australia Equifax (AUS_EFX)	✓
Korea NICE (KOR_NICE)	✗
Nigeria CRC (NGA_CRC)	✗
Brazil Experian (BRA_XP)	✓
Kenya Creditinfo (KEN_CI)	✓
Dominican Republic TransUnion (DOM_TU)	✓
United States (USA_XP)	✗

addresses []

Example of the addresses array:
{
  "addresses": [
    {
      "address_id": "043d133c-f406-11e6-bc64-92361f002671",
      "address": "2 Nhavi Street, Khar East, Mumbai, 400052, Maharashtra",
      "date_reported": "2015-05-19"
    }
  ],
  ...
}

Addresses is a history of where the applicant has previously lived. addresses are returned in an array, can have zero objects, and there is no upper bound.

Field	Format	Notes
address_id	UUID	Reference ID of this address
address	String	The entire address that was returned
street	String
neighborhood	String
district	String
city	String
zipcode	String
state	String
date_reported	Full Date or Short Date

disputes []

Example response from the disputes array:
{
  "disputes": [{
    "dispute_id": "b8636142-141d-4d05-a1ba-a745f8a60525",
    "date_reported": "2016-12-12",
    "statement": "This data has been disputed by the individual concerned.",
    "linked_entries": {
        "tradeline_id": "ccd74a5d-f22c-4fb8-9d39-c650109df351",
        "public_record_id": "348be108-2a9a-4706-8d8d-95e7ba778af0",
        "collection_id": "cdb4366a-e248-46f8-ba42-acd3f0b243fb"
    },
  }],
}

Disputes refer to the previous and current disputes the applicant has formally made on their credit report. disputes are returned in an array, can have zero objects, and there is no upper bound.

Field	Format	Notes
dispute_id	UUID	Reference ID of the dispute
date_reported	Full date
statement	String	Full description of the dispute
comments	Array	See comments
linked_entries	Object	See linked_entries

Supported Bureaus

	disputes
Canada TransUnion (CAN_TU)	✓
Canada Equifax (CAN_EFX)	✗
Great Britain Equifax (GBR_EFX)	✓
India Crif High Mark (IND_CHM)	✓
India CIBIL (IND_CIBIL)	✓
Mexico Circulo de Credito (MEX_CDC)	✓
Mexico Buro de Credito (MEX_BDC)	✓
Australia Equifax (AUS_EFX)	✓
Korea NICE (KOR_NICE)	✗
Nigeria CRC (NGA_CRC)	✗
Brazil Experian (BRA_XP)	✓
Kenya Creditinfo (KEN_CI)	✓
Dominican Republic TransUnion (DOM_TU)	✓
United States (USA_XP)	✓

notices []

Example response from the notices array:
{
  "notices": [{
    "notice_id": "b9cfa6e8-e4c6-4a71-aa51-ae655e0dc01e",
    "notice_type": "BUREAU COMMENT",
    "date_reported": "2016-12-12",
    "statement": "Successful inquiry by other SIC",
  }],
}

Notices refer to notices and statements provided by the supplying credit bureau or the applicant about the applicant's credit report. notices are returned in an array, can have zero objects, and there is no upper bound.

Field	Format	Notes
notice_id	UUID	Reference ID of the notice
notice_type	String	See notice_type
date_reported	Full date
statement	String	Full description of the notice

Supported Bureaus

	notices
Canada TransUnion (CAN_TU)	✓
Canada Equifax (CAN_EFX)	✓
Great Britain Equifax (GBR_EFX)	✗
India Crif High Mark (IND_CHM)	✓
India CIBIL (IND_CIBIL)	✗
Mexico Circulo de Credito (MEX_CDC)	✓
Mexico Buro de Credito (MEX_BDC)	✗
Australia Equifax (AUS_EFX)	✓
Korea NICE (KOR_NICE)	✗
Nigeria CRC (NGA_CRC)	✗
Brazil Experian (BRA_XP)	✗
Kenya Creditinfo (KEN_CI)	✗
Dominican Republic TransUnion (DOM_TU)	✗
United States (USA_XP)	✗

Common Fields

comments []

{
  ...,
  "comments": [
    { key: "JT", value: "Joint account" },
    { key: "AC", value: "Account closed" }
  ]
}

Several nodes of passport contain a comments property, which is an array of 0 or more objects with two fields--key and value. Each element of comments is a note from the bureau about that node.

linked_entries {}

{
  ...,
  "linked_entries": {
      "tradeline_id": "",
      "public_record_id": "",
      "collection_id": "",
      "bank_account_id": "",
  }
}

Several nodes of passport contain a linked_entries property, which is an object of UUID values. For some countries, we know that a dispute, for example, is tied to a tradeline as it comes in the form of a trade narrative code or similar. In those cases we create an entry in the disputes node and form a link with linked_entries.tradeline_id to the related tradeline. We cannot always infer a link, and in those cases we do not populate these fields. The following links will exist where the leaf will have a link to the parent:

• tradelines => disputes
• tradelines => frauds
• tradelines => collections
• collections => disputes
• public_records => disputes
• bank_accounts => nonsufficient_funds

The following situations could appear and this is how we solve them for now:

Q: Trade can be both tied to a dispute and tied to an external collection. Is the collection automatically disputed as well?

A: If we have enough information to ascertain that disputing both is a reasonable approach, we will create a dispute entry and link both the tradeline and the collection entry. If the dispute flag is specific to the collection or trade and not both (which are themselves linked together) we will only link one to the dispute. We do not infer more than we can, but by default if the trade contains a dispute flag and it's generic to the entire record, we will also dispute the collection if that is on the same record.

Q: Could a circular dependency exist?

A: No, a trade can be disputed, but a trade cannot be created from a dispute. Similar logic for other nodes.

Tables

country

Values of the country field.

Value	Description
CAN	Canada
GBR	Great Britain
IND	India
MEX	Mexico
AUS	Australia
KOR	Korea
NGA	Nigeria
BRA	Brazil
KEN	Kenya
DOM	Dominican Republic
USA	United STates

company_code

Values of the company_code field.

Value	Description
CAN_TU	Canada TransUnion
CAN_EFX	Canada Equifax
GBR_EFX	Great Britain Equifax
IND_CHM	India Crif High Mark
IND_CIBIL	India CIBIL
MEX_CDC	Mexico Círculo de Crédito
MEX_BDC	Mexico Buro de Crédito
AUS_EFX	Australia Equifax
KOR_NICE	Korea NICE
NGA_CRC	Nigeria CRC
BRA_XP	Brazil Experian
CHN_CCX	China Chengxin Credit
KEN_CI	Kenya Creditinfo
DOM_TU	Dominican Republic TransUnion
USA_XP	United States Experian

currency_source

Values of the currency_source field.

Value	Description
ECB	European Central Bank
OER	Open Exchange Rates

foreign_id_type

Values of the foreign_id_type field.

Value	Description
BANK_VERIFICATION_NUMBER	Bank Verification Number (BVN)
CEDULA_ID_NUMBER	Cedula Number
CPF_NUMBER	Individual Taxpayer Registry Number (CPF)
PASSPORT	Passport Number
PERMANENT_ACCOUNT_NUMBER	Permanent Account Number (PAN)
SOCIAL_INSURANCE_NUMBER	Social Insurance Number (SIN)
VOTER_ID	Voter ID

score_type

Values of the score_type field.

Value	Description
FOREIGN_SCORE	The score provided by the foreign bureau
NOVA_SCORE_BETA	The Nova Score is currently in beta

risk_indicator

Values of the risk_indicator field.

Value	Score Range
VERY_HIGH_RISK	300 - 579
HIGH_RISK	580 - 639
MEDIUM_RISK	640 - 699
LOW_RISK	700 - 749
VERY_LOW_RISK	750 - 850

account_type

Values of the account_type field.

Value	Description
OVERDRAFT	Overdraft tradeline
MORTGAGE	Mortgage-related tradeline
HOME_EQUITY	Any loan where property is used as collateral
CREDIT_LINE	A line of credit
VEHICLE	Any loan or lease for a vehicle
PERSONAL	Any loan for personal use
STUDENT	Any loan for educational purposes
LEASE_RENTAL	Any loan for a rental
CREDIT_CARD	Any credit-card type falls into this category. This can be a secured or unsecured card, retail cards, commercial cards, and more
CHARGE_CARD	Any credit card for use with an account that must be paid in full at the end of each cycle
RETAIL	Any loan used for consumer goods
ONLINE_RETAIL	Any loan used for consumer goods purchased online or by mail order
FLEX_SPENDING	Any pretax salary withholding flexible spending account
PAYDAY_LOAN	Any small, short-term, high-interest, unsecured, fast cash loan
UTILITY_TELCO_CABLE	Any loan to cover utilities. Examples are mobile usage bills, cable bills, electricity bills, and more
MEDICAL	Any loan related to medical services
INSURANCE_CLAIM	Any insurance claim to cover repayment
MICROFINANCE	Any loan to those lacking access to traditional banking services
OTHER	Other

portfolio_type

Values of the portfolio_type field.

Value	Description
REAL_ESTATE	Secured asset loans, typically related to a property, with fixed repayment amounts over a fixed length of time. For example, a mortgage
INSTALLMENT	Loans that are typically repaid with fixed repayment amounts over a fixed timeframe. For example, an auto loan
REVOLVING	Flexible access to a line of credit with repayment amounts determined by the amount of credit used. For example, a credit card
UNSPECIFIED_LIMIT	Accounts with no fixed limit where the payment in full is expected each payment cycle. For example, a utility account
OTHER

responsibility

Values of the responsibility field.

Value	Description
INDIVIDUAL	The individual is solely responsible for the tradeline
JOINT	The individual is jointly responsible
AUTHORIZED_USER	The individual is an authorized user
GUARANTOR	The individual is the guarantor
OTHER	Account ownership not identified

bank_account_type

Values of the bank_account_type field.

Value	Description
CHECKING	Checking account
SAVINGS	Savings account
OTHER

public_record_type

Values of the public_record_type field.

Value	Description
BANKRUPTCY	Consumer has filed for bankruptcy
TAX_LIEN	A lien imposed upon a property by law due to delinquent taxes
JUDGMENT	Legal decision associated with severe derogatory financial event

notice_type

Values of the notice_type field for notices.

Value	Description
BUREAU_COMMENT	The bureau left a comment about the applicant's credit report
BUREAU_ALERT	The bureau left an alert about the applicant's credit report
CONSUMER_STATEMENT	The consumer left a free-form statement on their credit report
OTHER

metric_name

Values of the metric_name field. To configure the set of metrics provided in your API response or to request additional custom metrics, contact your Nova Credit Representative. This list should be considered non-exhaustive and may be expanded in the future.

Name	Description
AGE_INQUIRY_MOST_RECENTLY_REPORTED	Age of Most Recently Reported Inquiry (months)
AGE_INQUIRY_OLDEST	Age of Oldest Inquiry (months)
AGE_SINCE_TRADELINE_MOST_RECENTLY_REPORTED	Age Since Tradeline Was Most Recently Reported (months)
AGE_TRADELINE_MOST_RECENTLY_REPORTED	Age of Most Recently Reported Tradeline (months)
AGE_TRADELINE_OLDEST	Age of Oldest Tradeline (months)
AGE_TRADELINE_OLDEST_REAL_ESTATE	Age of Oldest Real Estate Tradeline (months)
AGE_TRADELINE_OLDEST_OPEN	Age of Oldest Open Tradeline (months)
AGE_TRADELINE_OLDEST_REVOLVING	Age of Oldest Revolving Tradeline (months)
COUNT_BANKRUPTCIES	Bankruptcies
COUNT_COLLECTIONS	Collections
COUNT_DEROGATORY_MARKS	Derogatory Marks (all)
COUNT_SEVERE_DEROGATORY_MARKS	Severe Derogatory Marks
COUNT_DISPUTES	Dispute Records
COUNT_FORECLOSURES	Foreclosures
COUNT_FRAUDS	Fraud Records
COUNT_GARNISHMENTS	Garnishments
COUNT_NON_SUFFICIENT_FUNDS	Nonsufficient Funds
COUNT_PUBLIC_RECORDS	Public Records
COUNT_TAX_LIENS	Tax Liens
COUNT_TRADELINES	Tradelines
COUNT_TRADELINES_NON_AUTH_USER	Tradelines (Not Authorized User)
COUNT_TRADELINES_CHARGED_OFF	Charged Off Tradelines
COUNT_TRADELINES_CHARGED_OFF_NON_AUTH_USER	Charged Off Tradelines (Not Authorized User)
COUNT_TRADELINES_DELINQUENT_EVER	Tradelines Delinquent Ever
COUNT_TRADELINES_DELINQUENT_CURRENTLY	Currently Delinquent Tradelines (1+ Pay Cycle Past Due)
COUNT_TRADELINES_OPEN	Open Tradelines
COUNT_TRADELINES_OPEN_NON_AUTH_USER	Open Tradelines (Not Authorized User)
COUNT_TRADELINES_OPEN_COLLATERALIZED	Open Collateralized Tradelines
COUNT_TRADELINES_OPEN_COLLATERALIZED_NON_AUTH_USER	Open Collateralized Tradelines (Not Authorized User)
COUNT_TRADELINES_OPEN_INSTALLMENT	Open Installment Tradelines
COUNT_TRADELINES_OPEN_INSTALLMENT_NON_AUTH_USER	Open Installment Tradelines (Not Authorized User)
COUNT_TRADELINES_OPEN_REAL_ESTATE	Open Real Estate Tradelines
COUNT_TRADELINES_OPEN_REAL_ESTATE_NON_AUTH_USER	Open Real Estate Tradelines (Not Authorized User)
COUNT_TRADELINES_OPEN_REVOLVING	Open Revolving Tradelines
COUNT_TRADELINES_OPEN_REVOLVING_NON_AUTH_USER	Open Revolving Tradelines (Not Authorized User)
COUNT_TRADELINES_SATISFACTORY	Satisfactory Tradelines
COUNT_TRADELINES_SATISFACTORY_CURRENTLY	Currently Satisfactory Tradelines
COUNT_TRADELINES_PAST_DUE_CURRENTLY_2_OR_MORE_CYCLES	Current Tradelines 2+ Pay Cycles Past Due
COUNT_TRADELINES_PAST_DUE_1_OR_MORE_PAY_CYCLES_LAST_6_MONTHS	Tradelines 1+ Pay Cycles Past Due in Last 6 Months
COUNT_TRADELINES_PAST_DUE_1_OR_MORE_PAY_CYCLES_LAST_12_MONTHS	Tradelines 1+ Pay Cycles Past Due in Last 12 Months
COUNT_TRADELINES_PAST_DUE_2_OR_MORE_PAY_CYCLES	Tradelines 2+ Pay Cycles Past Due
COUNT_TRADELINES_PAST_DUE_2_OR_MORE_PAY_CYCLES_LAST_6_MONTHS	Tradelines 2+ Pay Cycles Past Due in Last 6 Months
COUNT_TRADELINES_PAST_DUE_2_OR_MORE_PAY_CYCLES_LAST_12_MONTHS	Tradelines 2+ Pay Cycles Past Due in Last 12 Months
COUNT_TRADELINES_PAST_DUE_3_OR_MORE_PAY_CYCLES	Tradelines 3+ Pay Cycles Past Due
COUNT_TRADELINES_PAST_DUE_3_OR_MORE_PAY_CYCLES_LAST_6_MONTHS	Tradelines 3+ Pay Cycles Past Due in Last 6 Months
COUNT_TRADELINES_PAST_DUE_3_OR_MORE_PAY_CYCLES_LAST_12_MONTHS	Tradelines 3+ Pay Cycles Past Due in Last 12 Months
COUNT_TRADELINES_PAST_DUE_CURRENTLY_EXACTLY_1_PAY_CYCLE	Current Tradelines Exactly 1 Pay Cycle Last Due
COUNT_PAYMENTS_PAST_DUE_6_MONTHS_2_OR_MORE_CYCLES	Payments 2+ Pay Cycles Past Due in Last 6 Months
COUNT_PAYMENTS_PAST_DUE_12_MONTHS_2_OR_MORE_CYCLES	Payments 2+ Pay Cycles Past Due in Last 12 Months
COUNT_PAYMENTS_PAST_DUE_12_MONTHS_3_OR_MORE_CYCLES	Payments 3+ Pay Cycles Past Due in Last 12 Months
COUNT_PAYMENTS_ON_TIME	On Time Payments
COUNT_PAYMENTS_LATE_1_CYCLE	Payments One Cycle Late
COUNT_PAYMENTS_LATE_2_CYCLES	Payments Two Cycles Late
COUNT_PAYMENTS_LATE_3_CYCLES	Payments Three Cycles Late
COUNT_PAYMENTS_LATE_4_OR_MORE_CYCLES	Payments At Least Four Cycles Late
COUNT_INQUIRIES	Inquiries
COUNT_INQUIRIES_LAST_7_DAYS	Inquiries Last 7 Days
COUNT_INQUIRIES_LAST_6_MONTHS	Inquiries Last 6 Months
COUNT_INQUIRIES_LAST_12_MONTHS	Inquiries Last 12 Months
RATIO_CREDIT_UTILIZATION	Credit Utilization Ratio
RATIO_CREDIT_UTILIZATION_REVOLVING	Revolving Credit Utilization Ratio
RATIO_EXTERNAL_CALAMITY	Open External Calamity Tradelines Ratio
RATIO_ON_TIME_PAYMENTS	On Time Payment Ratio
TOTAL_DEBT_ALL_OPEN	Total Debt Open
TOTAL_DEBT_HOME_EQUITY_OPEN	Total Debt (Home Equity) Open
TOTAL_DEBT_INSTALLMENT_OPEN	Total Debt (Installment) Open
TOTAL_DEBT_MORTGAGE_OPEN	Total Debt (Mortgage) Open
TOTAL_DEBT_REAL_ESTATE_OPEN	Total Debt (Real Estate) Open
TOTAL_DEBT_REVOLVING_OPEN	Total Debt (Revolving) Open
TOTAL_SCHEDULED_PAYMENT_OBLIGATIONS_ALL_OPEN	Total Scheduled Payment Obligations Open
TOTAL_SCHEDULED_PAYMENT_OBLIGATIONS_HOME_EQUITY_OPEN	Total Scheduled Payment Obligations (Home Equity) Open
TOTAL_SCHEDULED_PAYMENT_OBLIGATIONS_INSTALLMENT_OPEN	Total Scheduled Payment Obligations (Installment) Open
TOTAL_SCHEDULED_PAYMENT_OBLIGATIONS_MORTGAGE_OPEN	Total Scheduled Payment Obligations (Mortgage) Open
TOTAL_SCHEDULED_PAYMENT_OBLIGATIONS_REAL_ESTATE_OPEN	Total Scheduled Payment Obligations (Real Estate) Open
TOTAL_SCHEDULED_PAYMENT_OBLIGATIONS_REVOLVING_OPEN	Total Scheduled Payment Obligations (Revolving) Open
TOTAL_DEBT_ALL_OPEN_CLOSED	Total Debt Open and Closed
TOTAL_DEBT_HOME_EQUITY_OPEN_CLOSED	Total Debt (Home Equity) Open and Closed
TOTAL_DEBT_INSTALLMENT_OPEN_CLOSED	Total Debt (Installment) Open and Closed
TOTAL_DEBT_MORTGAGE_OPEN_CLOSED	Total Debt (Mortgage) Open and Closed
TOTAL_DEBT_REAL_ESTATE_OPEN_CLOSED	Total Debt (Real Estate) Open and Closed
TOTAL_DEBT_REVOLVING_OPEN_CLOSED	Total Debt (Revolving) Open and Closed
TOTAL_SCHEDULED_PAYMENT_OBLIGATIONS_ALL_OPEN_CLOSED	Total Scheduled Payment Obligations (All) Open and Closed
TOTAL_SCHEDULED_PAYMENT_OBLIGATIONS_HOME_EQUITY_OPEN_CLOSED	Total Scheduled Payment Obligations (Home Equity) Open and Closed
TOTAL_SCHEDULED_PAYMENT_OBLIGATIONS_INSTALLMENT_OPEN_CLOSED	Total Scheduled Payment Obligations (Installment) Open and Closed
TOTAL_SCHEDULED_PAYMENT_OBLIGATIONS_MORTGAGE_OPEN_CLOSED	Total Scheduled Payment Obligations (Mortgage) Open and Closed
TOTAL_SCHEDULED_PAYMENT_OBLIGATIONS_REAL_ESTATE_OPEN_CLOSED	Total Scheduled Payment Obligations (Real Estate) Open and Closed
TOTAL_SCHEDULED_PAYMENT_OBLIGATIONS_REVOLVING_OPEN_CLOSED	Total Scheduled Payment Obligations (Revolving) Open and Closed
AGE_NEGATIVE_TRADELINE_MOST_RECENTLY_REPORTED	Age of Most Recently Reported Negative Tradeline (months)
AGE_NEGATIVE_TRADELINE_OLDEST_REAL_ESTATE	Age of Oldest Negative Real Estate Tradeline (months)
AGE_NEGATIVE_TRADELINE_OLDEST_REVOLVING	Age of Oldest Negative Revolving Tradeline (months)
AGE_NEGATIVE_TRADELINE_OLDEST_INSTALLMENT	Age of Oldest Negative Installment Tradeline (months)
AGE_NEGATIVE_TRADELINE_OLDEST_UNSPECIFIED_LIMIT	Age of Oldest Negative Unspecified Limit Tradeline (months)
AGE_NEGATIVE_TRADELINE_OLDEST	Age of Oldest Negative Tradeline (months)
AGE_NEGATIVE_TRADELINE_NEWEST	Age of Newest Negative Tradeline (months)
COUNT_TRADELINES_NEGATIVE	Negative Tradelines
COUNT_TRADELINES_NEGATIVE_REAL_ESTATE	Negative Real Estate Tradelines
COUNT_TRADELINES_NEGATIVE_REVOLVING	Negative Revolving Tradelines
COUNT_TRADELINES_NEGATIVE_INSTALLMENT	Negative Installment Tradelines
COUNT_TRADELINES_NEGATIVE_UNSPECIFIED_LIMIT	Negative Unspecified Limit Tradelines
COUNT_TRADELINES_NEGATIVE_NON_AUTH_USER	Negative Tradelines (Not Authorized User)
COUNT_TRADELINES_NEGATIVE_REAL_ESTATE_NON_AUTH_USER	Negative Real Estate Tradelines (Not Authorized User)
COUNT_TRADELINES_NEGATIVE_REVOLVING_NON_AUTH_USER	Negative Revolving Tradelines (Not Authorized User)
COUNT_TRADELINES_NEGATIVE_INSTALLMENT_NON_AUTH_USER	Negative Installment Tradelines (Not Authorized User)
COUNT_TRADELINES_NEGATIVE_UNSPECIFIED_LIMIT_NON_AUTH_USER	Negative Unspecified Limit Tradelines (Not Authorized User)
COUNT_TRADELINES_NEGATIVE_EXACTLY_DEFAULT	Defaulted Negative Tradelines
COUNT_TRADELINES_NEGATIVE_DEFAULT_OR_WORSE	Defaulted (or Worse Pay Status) Negative Tradelines
COUNT_TRADELINES_NEGATIVE_DEFAULT_OR_WORSE_LAST_6_MONTHS	Defaulted (or Worse Pay Status) Negative Tradelines in Last 6 Months
COUNT_TRADELINES_NEGATIVE_DEFAULT_OR_WORSE_LAST_12_MONTHS	Defaulted (or Worse Pay Status) Negative Tradelines in Last 12 Months
COUNT_TRADELINES_NEGATIVE_EXACTLY_DEROGATORY	Derogatory Negative Tradelines
COUNT_TRADELINES_NEGATIVE_DEROGATORY_OR_WORSE	Derogatory (or Worse Pay Status) Negative Tradelines
COUNT_TRADELINES_NEGATIVE_DEROGATORY_OR_WORSE_LAST_6_MONTHS	Derogatory (or Worse Pay Status) Negative Tradelines in Last 6 Months
COUNT_TRADELINES_NEGATIVE_DEROGATORY_OR_WORSE_LAST_12_MONTHS	Derogatory (or Worse Pay Status) Negative Tradelines in Last 12 Months
COUNT_TRADELINES_NEGATIVE_EXACTLY_SEVERE_DEROGATORY	Severe Derogatory Negative Tradelines
COUNT_TRADELINES_NEGATIVE_SEVERE_DEROGATORY_OR_WORSE	Severe Derogatory (or Worse Pay Status) Negative Tradelines
COUNT_TRADELINES_NEGATIVE_SEVERE_DEROGATORY_OR_WORSE_LAST_6_MONTHS	Severe Derogatory (or Worse Pay Status) Negative Tradelines in Last 6 Months
COUNT_TRADELINES_NEGATIVE_SEVERE_DEROGATORY_OR_WORSE_LAST_12_MONTHS	Severe Derogatory (or Worse Pay Status) Negative Tradelines in Last 12 Months
TOTAL_DEBT_NEGATIVE_OPEN_CLOSED	Total Negative Debt Open and Closed
TOTAL_DEBT_NEGATIVE_REVOLVING_OPEN_CLOSED	Total Negative Debt (Revolving) Open and Closed
TOTAL_DEBT_NEGATIVE_INSTALLMENT_OPEN_CLOSED	Total Negative Debt (Installment) Open and Closed
TOTAL_DEBT_NEGATIVE_REAL_ESTATE_OPEN_CLOSED	Total Negative Debt (Real Estate) Open and Closed
TOTAL_DEBT_NEGATIVE_UNSPECIFIED_LIMIT_OPEN_CLOSED	Total Negative Debt (Unspecified Limit) Open and Closed
KOR_NICE_COUNT_OPEN_GUARANTEES	[Provided by KOR_NICE] Open Guarantee Tradelines
KOR_NICE_TOTAL_OPEN_GUARANTEES	[Provided by KOR_NICE] Amount Owing on Open Guarantee Tradelines
KOR_NICE_COUNT_OPEN_LOANS	[Provided by KOR_NICE] Open Installment Loans
KOR_NICE_TOTAL_OPEN_LOANS	[Provided by KOR_NICE] Amount Owing on Open Installment Loans
KOR_NICE_COUNT_CREDIT_CARDS	[Provided by KOR_NICE] Open Credit Card Tradelines
KOR_NICE_TOTAL_CREDIT_CARDS	[Provided by KOR_NICE] Transfer Balance Owing on Open Credit Card Tradelines
SERASA_COUNT_PAYMENT_DEROGS	[Provided by BRA_XP] Number of delinquent payments, including early delinquencies
SERASA_VALUE_PAYMENT_DEROGS	[Provided by BRA_XP] Value of delinquent payments, including early delinquencies
SERASA_COUNT_NSFS	[Provided by BRA_XP] Count of NSFs
SERASA_COUNT_INQUIRIES_CURRENT_MONTH	[Provided by BRA_XP] Inquiries Current Month
SERASA_COUNT_INQUIRIES_LAST_THREE_MONTHS	[Provided by BRA_XP] Inquiries Previous Three Calendar Months

metric_status

Values of the metric_status field.

Value	Description
AVAILABLE	Metric is available for this report
UNAVAILABLE_REPORT	Metric is unavailable for this report due to lack of underlying data

metric_source

Values of the metric_source field.

Value	Description
NOVA	This data was calculated from the report data by Nova
BUREAU	This data was provided in the report by the foreign bureau

metric_label

Values of the metric_label field. See metric_name

metric_type

Values of the metric_type field.

Value	Description
INTEGER	This data is an integer
CURRENCY	This data is a currency
RATIO	This data is a ratio
AGE_MONTHS	This data is an age, calculated in months

metric_format

Values of the metric_format field.

Value	Description
NUMERIC	This data is an individual numeric value
TIMESERIES	This data is a series of values over given increments of time
RANGE	This data is a 2-length numeric array of [lowerbound, upperbound] inclusive range

product inquiry_type

Values of the inquiry_type set for your product in the Nova Credit Dashboard.

Value
MONITORING
CREDIT_CARD
VEHICLE_AUTO
VEHICLE_OTHER
MORTGAGE
PERSONAL
STUDENT
UTILITY
COMMERCIAL
CONSUMER
TENANT
OTHER

inquiry_account_type

Values of the inquiry_account_type field.

Value
STUDENT
CREDIT_CARD
CREDIT_LINE
HOME_EQUITY
LEASE_RENTAL
MICROFINANCE
MORTGAGE
OTHER
OVERDRAFT
PAYDAY_LOAN
PERSONAL
RETAIL
UTILITY_TELCO_CABLE
VEHICLE
UNKNOWN
INSURANCE_CLAIM
MEDICAL
RETAIL

interval

Values of the interval field.

Value
WEEKLY
BI_WEEKLY
SEMI_MONTHLY
MONTHLY
BI_MONTHLY
QUARTERLY
SEMI_ANNUAL
ANNUAL

current_pay_status

Values of the current_pay_status field.

Value	Description
CURRENT	The account is in good standing with no delinquent payment obligation
EARLY_DELINQUENT	Consumer has failed to satisfy one payment cycle
DELINQUENT	Consumer has failed to satisfy two payment cycles
DEFAULT	Consumer has failed to satisfy three payment cycles
DEROGATORY	Consumer has failed to satisfy at least four payment cycles
SEVERE_DEROGATORY	The account has been flagged with a severe negative event indicated by the presence of the current_pay_substatus field

current_pay_substatus

Values of the current_pay_substatus field.

Value	Description
CHARGE_OFF	The account is in default or worse status (3+ payment cycles past due), and the creditor does not anticipate repayment to become current. Loss taken in the books. Synonym to written-off
BANKRUPTCY	The account is included in a bankruptcy proposal
FORECLOSURE	Foreclosure process has been initiated
SETTLED	Lender has accepted a settlement on this account
REPOSSESSION	Property has been reposessed due to consumer failure to pay
EXTERNAL_COLLECTIONS	Account has been placed with a third party collection agency
GARNISHMENT	Court ordered repayment of consumer funds, often wages in order to satisfy a debt obligation

current_condition_type

Values of the current_condition_type field. The condition the tradeline is in currently.

Value	Description
TRANSFER_SOLD	The tradeline has been transferred or sold
EXTERNAL_CALAMITY	Unforeseen circumstances such as natural disasters potentially affected repayment
RESTRUCTURED	The account has been financially restructured
PARTIAL	The tradeline has been partially paid off
DECEASED	Borrower deceased, and tradeline repayment obligations marked as affected
DEFERRED	Account repayment obligations are currently deferred
FORBEARANCE	Agreement by Lender to delay the account repayment obligation
LOST_STOLEN	Card was stolen or lost
ADJUSTMENT_PENDING	Account status is currently under review pending an adjustment
EXCEPTION	The tradeline is marked as an exception when it is an insurance claim or a medical credit; usually out of control of the borrower's actions
CEASED	The account has been ceased, or the membership has been terminated

current_condition_status

Values of the current_condition_status field. Always defined. If active or inactive tradeline.is_open must be true, if any of the other 2 values it must be false.

Value	Description
ACTIVE	The account is open and recent activity has been reported, where recent is usually within the last 90 days
INACTIVE	The account is open and recent inactivity has been reported, where recent is usually within the last 90 days
CONSUMER_INITIATED	The account was closed at the consumer's request
LENDER_INITIATED	The account was closed at the Lender's request

payment_obligation_frequency

Values of the payment_obligation_frequency field. Repayment frequency agreed by Issuer and Consumer.

Value	Description
ANNUAL	Every year
SEMI_ANNUAL	Twice a year
TRI_ANNUAL	Three times a year
QUARTERLY	Every quarter
BI_MONTHLY	Every two months
MONTHLY	Every month
SEMI_MONTHLY	Twice a month
BI_WEEKLY	Every two weeks
WEEKLY	Every week
DAILY	Every day
FIXED_AMOUNT	One single reported value
PERIODICALLY	No specific frequency specified
DEFERRED	Account repayment obligations are currently deferred

history_frequency

Values of the history_frequency field.

Value	Description
ANNUAL	Every year
QUARTERLY	Every quarter
BI_MONTHLY	Every two months
MONTHLY	Every month
BI_WEEKLY	Every two weeks
WEEKLY	Every week
FIXED_AMOUNT	One single reported value

Error Codes & Responses

At Nova Credit, we distinguish between two status message deliveries:

1. Delivered by Nova Credit to the webhook
2. If you call a resource endpoint Nova Credit provides a status in the response

Resource Endpoint Errors

When an error occurs while calling the endpoints the Nova servers send back a JSON object with the following format:

{
  error: 'UNKNOWN_CUSTOMER',
  terminated: true,
}

Error Codes

The Nova endpoints return the following HTTP status codes and error messages:

Code	Text	Description
200	-	Everything went well and the requested resource is either in the body or in the generic text field depending on the content-type
400	MALFORMED_HEADERS	The request headers are incorrectly formatted
400	MISSING_INPUT	An input is missing that the endpoint expected
408	REQUEST_TIMEOUT	The request timed out
403	UNKNOWN_CUSTOMER	The public_id or client_id Nova received in the request from is not recognized
403	UNAUTHORIZED	The client_id and secret_key combination is not recognized. Please email support via support@novacredit.com
403	ORIGIN_UNAUTHORIZED	The origin of the request is not whitelisted on the Nova servers for CORS
401	EXPIRED_TOKEN	The access_token you're sending in the request headers has expired. Please request a new one
404	INVALID_EXTERNAL_ID	The external ID is not valid
400	INVALID_PUBLIC_ID	The public ID is not valid
404	INVALID_TOKEN	The public_token or access_token is not valid for reasons other than expiration
404	PDF_NOT_FOUND	The PDF you're requesting cannot be found when hitting the PDF retrieval endpoint
404	PDF_PENDING	The PDF is still being generated and not yet available for review when hitting the PDF retrieval endpoint
500	INTERNAL_ERROR	Something went wrong. Please send a note to support@novacredit.com with additional details so we can investigate

Sample Response

{
    "meta": {
        "public_token": "63fec53d-b992-4f7e-9096-e1ee649da554",
        "pdf_name": "raj_du_fb8058229bfd.pdf",
        "callback_URL": "https://test.com/fake_route",
        "created_at": "2019-11-01T23:06:44.784Z",
        "country": "IND",
        "country_destination": "USA",
        "company_code": "IND_CHM",
        "consent_version": "1.4.80",
        "api_version": "3.0.0",
        "bureau_report_id": "214abi4fop1a4"
    },
    "product": {
        "product_id": "3d5be8fc-b0dc-47f0-88a9-f00495c77db2",
        "name": "Test Credit Card"
    },
    "personal": {
        "full_name": "Raj Du",
        "email": "rajdu@email.com",
        "telephone": "2233334444",
        "date_of_birth": "1989-10-25",
        "is_deceased": false,
        "foreign_id": "ADIPA8123J",
        "foreign_id_type": "PERMANENT_ACCOUNT_NUMBER"
    },
    "tradelines": [
        {
            "tradeline_id": "9876d00f-b04b-4421-b8e3-83ecc2b7e9f7",
            "institution": null,
            "date_opened": "2016-12-14",
            "date_last_reported": "2019-01-11",
            "past_due_balance": 0,
            "history": [
                {
                    "year": 2019,
                    "payments": [
                        null,
                        null,
                        null,
                        null,
                        null,
                        null,
                        null,
                        null,
                        null,
                        null,
                        null,
                        0
                    ]
                },
                {
                    "year": 2018,
                    "payments": [
                        0,
                        0,
                        0,
                        0,
                        0,
                        0,
                        0,
                        0,
                        0,
                        0,
                        0,
                        0
                    ]
                },
                {
                    "year": 2017,
                    "payments": [
                        0,
                        0,
                        0,
                        0,
                        0,
                        0,
                        0,
                        0,
                        0,
                        0,
                        0,
                        0
                    ]
                }
            ],
            "responsibility": "INDIVIDUAL",
            "balance": 0,
            "high_balance": 1989,
            "credit_limit": 3535,
            "original_currency": "INR",
            "account_type": "CREDIT_CARD",
            "portfolio_type": "REVOLVING",
            "current_pay_status": "CURRENT",
            "current_condition_status": "ACTIVE",
            "history_frequency": "MONTHLY",
            "is_open": true,
            "is_collateralized": false
        },
        {
            "tradeline_id": "ac6e7c0e-c63a-40c2-88ff-6c39aadba37e",
            "institution": null,
            "date_opened": "2011-07-28",
            "date_last_reported": "2019-01-02",
            "past_due_balance": 0,
            "history": [
                {
                    "year": 2017,
                    "payments": [
                        null,
                        null,
                        0,
                        0,
                        0,
                        0,
                        0,
                        0,
                        0,
                        0,
                        0,
                        0
                    ]
                },
                {
                    "year": 2016,
                    "payments": [
                        0,
                        0,
                        0,
                        0,
                        0,
                        0,
                        0,
                        0,
                        0,
                        0,
                        0,
                        0
                    ]
                },
                {
                    "year": 2015,
                    "payments": [
                        0,
                        0,
                        0,
                        0,
                        0,
                        0,
                        0,
                        0,
                        0,
                        null,
                        null,
                        null
                    ]
                }
            ],
            "responsibility": "JOINT",
            "balance": 0,
            "original_currency": "INR",
            "account_type": "STUDENT",
            "portfolio_type": "INSTALLMENT",
            "scheduled_payment": 319,
            "current_pay_status": "CURRENT",
            "current_condition_status": "INACTIVE",
            "payment_obligation_frequency": "MONTHLY",
            "history_frequency": "MONTHLY",
            "is_open": true,
            "is_collateralized": false,
            "original_loan": 14482
        },
        {
            "tradeline_id": "dc87a82f-6eae-41ad-a234-fcb10f24e303",
            "institution": null,
            "date_opened": "2015-08-25",
            "date_last_reported": "2018-12-31",
            "past_due_balance": 0,
            "history": [
                {
                    "year": 2018,
                    "payments": [
                        0,
                        0,
                        0,
                        0,
                        0,
                        0,
                        0,
                        0,
                        0,
                        0,
                        0,
                        0
                    ]
                },
                {
                    "year": 2017,
                    "payments": [
                        0,
                        0,
                        0,
                        0,
                        0,
                        0,
                        0,
                        0,
                        0,
                        0,
                        0,
                        0
                    ]
                },
                {
                    "year": 2016,
                    "payments": [
                        0,
                        0,
                        0,
                        0,
                        0,
                        null,
                        null,
                        null,
                        null,
                        null,
                        null,
                        null
                    ]
                }
            ],
            "responsibility": "INDIVIDUAL",
            "balance": 155058,
            "original_currency": "INR",
            "account_type": "MORTGAGE",
            "portfolio_type": "REAL_ESTATE",
            "scheduled_payment": 453,
            "current_pay_status": "CURRENT",
            "current_condition_status": "ACTIVE",
            "payment_obligation_frequency": "MONTHLY",
            "history_frequency": "MONTHLY",
            "is_open": true,
            "is_collateralized": true
        },
        {
            "tradeline_id": "fadebd5c-8d46-4889-8e17-bac2c4de01ca",
            "institution": null,
            "date_opened": "2018-09-12",
            "date_last_reported": "2018-12-28",
            "past_due_balance": 0,
            "history": [
                {
                    "year": 2018,
                    "payments": [
                        0,
                        0,
                        0,
                        0,
                        null,
                        null,
                        null,
                        null,
                        null,
                        null,
                        null,
                        null
                    ]
                }
            ],
            "responsibility": "INDIVIDUAL",
            "balance": 0,
            "original_currency": "INR",
            "account_type": "OVERDRAFT",
            "portfolio_type": "INSTALLMENT",
            "current_pay_status": "CURRENT",
            "current_condition_status": "ACTIVE",
            "payment_obligation_frequency": "MONTHLY",
            "history_frequency": "MONTHLY",
            "is_open": true,
            "is_collateralized": false,
            "original_loan": 118
        },
        {
            "tradeline_id": "9f449db0-c98a-47b1-9441-61c8c23b542c",
            "institution": null,
            "date_opened": "2016-09-10",
            "date_last_reported": "2018-11-14",
            "past_due_balance": 0,
            "history": [
                {
                    "year": 2018,
                    "payments": [
                        null,
                        0,
                        0,
                        0,
                        0,
                        0,
                        0,
                        0,
                        0,
                        0,
                        0,
                        0
                    ]
                },
                {
                    "year": 2017,
                    "payments": [
                        0,
                        0,
                        0,
                        0,
                        0,
                        0,
                        0,
                        0,
                        0,
                        0,
                        0,
                        0
                    ]
                },
                {
                    "year": 2016,
                    "payments": [
                        0,
                        0,
                        0,
                        null,
                        null,
                        null,
                        null,
                        null,
                        null,
                        null,
                        null,
                        null
                    ]
                }
            ],
            "responsibility": "INDIVIDUAL",
            "balance": 0,
            "high_balance": 62,
            "original_currency": "INR",
            "account_type": "UTILITY_TELCO_CABLE",
            "portfolio_type": "UNSPECIFIED_LIMIT",
            "current_pay_status": "CURRENT",
            "current_condition_status": "ACTIVE",
            "history_frequency": "MONTHLY",
            "is_open": true,
            "is_collateralized": false
        },
        {
            "tradeline_id": "4a561ba3-428f-41fc-b305-9ca40a056094",
            "institution": null,
            "date_opened": "2015-07-26",
            "date_last_reported": "2018-10-01",
            "date_closed": "2018-09-21",
            "past_due_balance": 0,
            "history": [
                {
                    "year": 2018,
                    "payments": [
                        null,
                        null,
                        null,
                        0,
                        0,
                        0,
                        0,
                        0,
                        0,
                        0,
                        0,
                        0
                    ]
                },
                {
                    "year": 2017,
                    "payments": [
                        0,
                        0,
                        1,
                        0,
                        0,
                        0,
                        0,
                        0,
                        0,
                        0,
                        0,
                        0
                    ]
                },
                {
                    "year": 2016,
                    "payments": [
                        0,
                        0,
                        0,
                        0,
                        0,
                        0,
                        0,
                        0,
                        0,
                        0,
                        0,
                        0
                    ]
                }
            ],
            "responsibility": "JOINT",
            "balance": 0,
            "original_currency": "INR",
            "account_type": "VEHICLE",
            "portfolio_type": "INSTALLMENT",
            "scheduled_payment": 255,
            "current_pay_status": "CURRENT",
            "current_condition_status": "CONSUMER_INITIATED",
            "payment_obligation_frequency": "MONTHLY",
            "history_frequency": "MONTHLY",
            "is_open": false,
            "is_collateralized": false,
            "original_loan": 8023
        }
    ],
    "inquiries": [
        {
            "inquiry_id": "9041af83-4337-42a9-9d72-d1eeb6d97c2f",
            "inquiry_date": "2018-10-02",
            "company_name": null,
            "is_credit_seeking": true,
            "inquiry_account_type": "MORTGAGE",
            "is_collateralized": true,
        },
        {
            "inquiry_id": "06c0b88d-aeca-4047-971a-dda1da601aae",
            "inquiry_date": "2018-09-14",
            "company_name": null,
            "is_credit_seeking": true,
            "inquiry_account_type": "CREDIT_LINE",
            "is_collateralized": false,
        },
        {
            "inquiry_id": "c53a415c-b81d-4686-8438-36e54a0722fd",
            "inquiry_date": "2016-12-12",
            "company_name": null,
            "is_credit_seeking": true,
            "inquiry_account_type": "OTHER",
            "is_collateralized": false,
        },
        {
            "inquiry_id": "49a9e029-4630-47de-a078-2634919a9c57",
            "inquiry_date": "2015-08-02",
            "company_name": null,
            "is_credit_seeking": true,
            "inquiry_account_type": "CREDIT_CARD",
            "is_collateralized": false,
        }
    ],
    "bank_accounts": [
        {
            "bank_account_id": "1d098afc-3984-42bc-bc32-bde508876a38",
            "bank_account_type": "CHECKING",
            "institution": null,
            "date_last_reported": "2019-05-30",
            "court_name": "ABERDARE",
            "date_opened": "2010-11-11",
            "date_closed": "2019-05-30",
            "responsibility": "INDIVIDUAL",
            "balance": 500,
            "original_currency": "INR",
            "is_overdrawn": true,
            "is_overdraftable": true
        }
    ],
    "public_records": [
        {
            "public_record_id": "03d66b7f-3a59-40a6-9119-31da9635abe2",
            "date_filed": "2019-03-30",
            "date_last_reported": "2019-06-04",
            "court_name": "ABERDARE",
            "public_record_type": "BANKRUPTCY",
            "is_resolved": true,
            "comments": [{ "key": "EX", "value": "Example comment" }]
        }
    ],
    "nonsufficient_funds": [
       {
            "nonsufficient_fund_id": "9b1f2ad0-e00b-406e-8056-7cdbd75aeb1b",
            "nonsufficient_date": "2016-04-20",
            "comments": [{ "key": "EX", "value": "Example comment" }]
       }
   ],
    "frauds": [
        {
            "fraud_id": "1327df2b-a632-4e8a-b2b1-799c2dfa4e47",
            "date_reported": "2017-02-14",
            "is_fraudster": true,
            "comments": [{ "key": "EX", "value": "Example comment" }]
        }
    ],
    "collections": [
        {
            "collection_id": "68b4eff7-3e1a-488b-8fff-9ed0eda740b9",
            "is_paid": true,
            "date_filed": "2015-01-30",
            "date_last_reported": "2016-02-01",
            "comments": [{ "key": "EX", "value": "Example comment" }]
        }
    ],
    "disputes": [
        {
            "dispute_id": "803a02e7-d817-4f6c-90d7-db90553293a4",
            "date_reported": "2017-05-20",
            "comments": [{ "key": "EX", "value": "Example comment" }]
        }
    ],
    "notices": [
        {
            "notice_id": "fe92656c-fd2d-4149-b840-0b7d78247aac",
            "notice_type": "BUREAU_COMMENT",
            "date_reported": "2018-11-11",
            "statement": "some statement"
        }
    ],
    "metrics": [
        {
            "metric_name": "AGE_TRADELINE_OLDEST",
            "metric_source": "NOVA",
            "metric_status": "AVAILABLE",
            "metric_value": 99,
            "metric_type": "AGE_MONTHS",
            "metric_label": "Age of Oldest Tradeline (months)",
            "metric_format": "NUMERIC"
        },
        {
            "metric_name": "COUNT_INQUIRIES_LAST_SIX_MONTHS",
            "metric_source": "NOVA",
            "metric_status": "AVAILABLE",
            "metric_value": 0,
            "metric_type": "INTEGER",
            "metric_label": "Inquiries Last 6 Months",
            "metric_format": "NUMERIC"
        },
        {
            "metric_name": "COUNT_TRADELINES_OPEN",
            "metric_source": "NOVA",
            "metric_status": "AVAILABLE",
            "metric_value": 5,
            "metric_type": "INTEGER",
            "metric_label": "Open Tradelines",
            "metric_format": "NUMERIC"
        },
        {
            "metric_name": "COUNT_TRADELINES_PAST_DUE_1_OR_MORE_PAY_CYCLES_LAST_12_MONTHS",
            "metric_source": "NOVA",
            "metric_status": "AVAILABLE",
            "metric_value": 0,
            "metric_type": "INTEGER",
            "metric_label": "Tradelines Past Due 1+ Cycles in the Past 12 Months",
            "metric_format": "NUMERIC"
        },
        {
            "metric_name": "COUNT_TRADELINES_PAST_DUE_3_OR_MORE_PAY_CYCLES",
            "metric_source": "NOVA",
            "metric_status": "AVAILABLE",
            "metric_value": 0,
            "metric_type": "INTEGER",
            "metric_label": "Tradelines Past Due 3+ Cycles",
            "metric_format": "NUMERIC"
        },
        {
            "metric_name": "RATIO_CREDIT_UTILIZATION_REVOLVING",
            "metric_source": "NOVA",
            "metric_status": "AVAILABLE",
            "metric_value": 0,
            "metric_type": "RATIO",
            "metric_label": "Revolving Credit Utilization Ratio",
            "metric_format": "NUMERIC"
        },
        {
            "metric_name": "TOTAL_DEBT_ALL_OPEN",
            "metric_source": "NOVA",
            "metric_status": "AVAILABLE",
            "metric_value": 153108,
            "metric_type": "CURRENCY",
            "metric_label": "Total Debt (All) Open",
            "metric_format": "NUMERIC"
        },
        {
            "metric_name": "TOTAL_SCHEDULED_PAYMENT_OBLIGATIONS_ALL_OPEN",
            "metric_source": "NOVA",
            "metric_status": "AVAILABLE",
            "metric_value": 448,
            "metric_type": "CURRENCY",
            "metric_label": "Total Scheduled Payment Obligations Open",
            "metric_format": "NUMERIC"
        }
    ],
    "addresses": [
        {
            "address_id": "5e68cc11-d06e-4579-b488-1caa2d715460",
            "address": "2 This Street, SF, CA 9124",
            "street": "2 This Street",
            "neighborhood": "Haight",
            "city": "SF",
            "district": "Haight",
            "zipcode": "94103",
            "state": "CA",
            "date_reported": "2019-07-15"
        }
    ],
    "employers": [
        {
            "employer_id": "04c2148f-8622-4699-9058-ff6cfefedeb1",
            "company_name": null,
            "job_title": "Senior Analyst",
            "annual_salary": 100000,
            "date_reported": "2019-05-16"
        }
    ],
    "scores": [
        {
            "score_type": "FOREIGN_SCORE",
            "value": 472,
            "adverse_action_codes": []
        },
        {
            "score_type": "NOVA_SCORE_BETA",
            "value": 793,
            "risk_indicator": "VERY_LOW_RISK",
            "score_version": "1.3.45-rc.0"
        }
    ],
    "currencies": [
        {
            "currency_id": "77aba387-107f-431f-b991-fef377ad6080",
            "original": "INR",
            "target": "USD",
            "date": "2018-03-14T00:00:00.000Z",
            "rate": 0.015423,
            "source": "ECB"
        }
    ],
}

This is a sample response of the Nova Credit Passport. Not all possible data values are present.

Changelog

We're always working to improve the Nova Credit platform! Here's a snapshot of API features we're shipping and bugs we're squashing.

Important updates

info

The latest version of our API is V4. This version (V3) is not receiving updates and does not support the latest features of the Nova Credit Passport. See details here.

• Changes in V3 of our API include improved metrics, mappings, and API structure.

Changelog History

October 2024

• Added year_of_birth to field options in report

August 2024

• Added clarifying notes about is_fraudster

June 2024

• Removed UNDESIGNATED from responsibility (scoped for USA_XP but never implemented)
• Added OTHER to responsibility (used by IND_CHM, UKR, and ZAF)

April 2024

• Added new metric AGE_SINCE_TRADELINE_MOST_RECENTLY_REPORTED
• Updated score_version from "Only applies if score_type is NOVA_SCORE_BETA" to "Only applies if score_type is not FOREIGN_SCORE"
• Updated institution, translated_institution, company_name, and translated_company_name examples to null from documentation for tradelines, inquiries, and employers.

March 2024

• Converted the Label column to Description in the metric\_name table

Nov 2023

• Added additional AUS_EFX adverse action codes

June 2023

• Added INVALID_EXTERNAL_ID and INVALID_PUBLIC_ID errors in Error Codes section
• Added externalId field to the webhook body
• Added external_id field in the meta node

April 2023

• Added additional MEX_BDC adverse action codes
• Added additional KOR_NICE adverse action codes

March 2023

• Removed exclusion codes from MEX_CDC adverse action codes list

February 2023

• Added foreign_id_type field enum

January 2023

• Marked collections as available for MEX_CDC and MEX_BDC.
• Translated DOM_TU sandbox KBA answers to english
• Added PARTIAL as a possible value for the current_condition_type field
• Added DAILY to payment_obligation_frequency

December 2022

• Added foreign_id and foreign_id_type information
• Added publicId and publicIdAlias to the webhook body
• Added Driver's License Card Number for AUS_EFX sandbox user Noah

November 2022

• Added comments as a field in the employers node
• Added a Common Fields section to define fields that can be found across various nodes and moved the comments and linked_entries fields into that section

September 2022

• Added USA_XP supported / unsupported information to
  • country_specifics
  • credit passport bank accounts
  • credit passport disputes
  • credit passport employers
  • credit passport frauds
  • credit passport inquiries
  • credit passport nonsufficient_funds
  • credit passport notices
  • credit passport public_records
  • credit passport tradelines
• Added USA to the country values list
• Added USA_XP to the company_code values list

July 2022

• Added RETAIL, MEDICAL, and INSURANCE_CLAIM as inquiry_account_type values
• Added USA_XP adverse action codes
• Added UNDESIGNATED as a responsibility value
• Added DEFERRED as a payment_frequency_obligation value
• Added charge_off_amount as a tradeline field

May 2022

• Added CEASED as a possible value for the current_condition_type field

March 2022

• Updated metric_value to be numeric or boolean
• Fixed incorrect date on KOR sandbox user Soojin

February 2022

• Removed IND_CIBIL exclusion codes which were unused and incorrect
• Fixed typo in universal IND sandbox user birth date

January 2022

• Updated Voter IDs for IND_CHM sandbox users.
• Added inquiry_account_type and is_collateralized as new fields for the inquiry node

November 2021

• Phone numbers changed for IND_CHM sandbox users. However, the old numbers should continue to work for compatibility reasons.
• Updated adverse action codes information for IND_CHM

August 2021

• Added OTHER as a possible field for the account_type field

February 2021

• Changed Australian Medicare Card valid to date to 04-2051 for Default (Low Risk) User and 05-2051 for Medium Risk user.
• Add negative metrics to metric_name table.
• Removed Philippines PHL_CRIF, Spain ESP_EFX, Austria AUT_CRIF, Germany DEU_CRIF, and Switzerland CHE_CRIF as supported bureaus. These bureaus are supported v4+.

January 2021

• Added date_negative_reported field in the tradelines subnodes
• Remove KBA answers for PHL_CRIF sandbox users

December 2020

• Added Spain ESP_EFX, Austria AUT_CRIF, Germany DEU_CRIF, and Switzerland CHE_CRIF as supported bureaus
• Removed worst_arrears_amount from example tradeline - field not possible in this version
• Updated AUS_EFX to be positive reporting and KOR_NICE to be negative reporting to reflect most recent bureau reporting status

November 2020

• Added eventType to the webhook body along with some new body keys and statuses associated with each webhook event type

October 2020

• Added substatus to the history object within the webhook body

August 2020

• Added addresses and three extra KBA answers for PHL_CRIF sandbox users

July 2020

• Added BRA_XP adverse action codes
• Added GBR_EFX adverse action codes
• Added IND_CHM adverse action codes
• Added IND_CIBIL adverse action codes

May 2020

• Added PHL_CRIF as a supported bureau
• Added RATIO_EXTERNAL_CALAMITY as a metric

April 2020

• Deprecated prob_default for scores node

March 2020

• Added voter ID property to sandbox users in IND CHM
• To follow standard industry practice, we now remove any inquiry that is older than 2 years old

February 2020

• Added DOM_TU as a supported bureau

January 2020

• Updated date of birth input formats for sandbox users to be MM-DD-YYYY (US Standard Date Format) instead of local date format
• Updated GBR_EFX sandbox user addresses for Nathan and Allie
• Updated CAN_TU sandbox user John Fence, who drank from the fountain of youth, to have a more recent birth year

December 2019

• Added RANGE as a possible field for the metric_format field
• Added metric_range property for metrics node
• Added CHN_CCX as a supported bureau
• Added KEN_CI as a supported bureau
• Added a new KOR_NICE sandbox user and updated other sandbox users' birthdays and phone numbers

November 2019

• Updated the default metrics that are included in every response to be the following 8 metrics: AGE_TRADELINE_OLDEST, COUNT_TRADELINES_OPEN, COUNT_TRADELINES_PAST_DUE_1_OR_MORE_PAY_CYCLES_LAST_12_MONTHS, COUNT_TRADELINES_PAST_DUE_3_OR_MORE_PAY_CYCLES, RATIO_CREDIT_UTILIZATION_REVOLVING, COUNT_INQUIRIES_LAST_SIX_MONTHS, TOTAL_DEBT_ALL_OPEN, and TOTAL_SCHEDULED_PAYMENT_OBLIGATIONS_ALL_OPEN
• Added history property to the webhook body

October 2019

• Updated JSON responses and PDF reports for CAN_EFX sandbox users to incorporate more improvements in assessing accurate credit risk
• Updated the default four metrics that are included in every response
• Updated the definition of JUDGMENT for public_record_type

September 2019

• Updated inquiries nodes to only return hard inquiries (only inquiries with is_credit_seeking as true will be returned)
• Added translated_institution as a possible field to the bank_accounts node
• Removed OTHER from the values of the responsibility field
• Added GUARANTOR as a possible value for the responsibility field

August 2019

• Added supported bureaus for inquiries node
• Removed numbers associated to each table

July 2019

• Removed history from bank_accounts node
• Updated account_type table with new value of OVERDRAFT
• Updated adverse_action_codes table for MEX_CDC and AUS_EFX
• Updated CAN_TU as a supported bureau for disputes node
• Renamed AUS_EFX sandbox users: Muhammad Mohebbi to Charlotte Williams, Saiid Abass to Noah Taylor
• Updated JSON responses and PDF reports for sandbox users from MEX_CDC, IND_CHM, CAN_TU, GBR_EFX, and AUS_EFX to incorporate more improvements in assessing accurate credit risk
• Updated answers to KBA questions for CAN_TU sandbox users
• Updated IND_CHM and AUS_EFX as unsupported bureaus for bank_accounts node

Changes from v2 to v3

• Removed the following nodes: identifiers, other_assets, other_incomes
• Updated the comments field in various nodes to be an array of objects rather than an array of strings
• Updated the addresses node:
  • Removed fields:
    • address_type
    • date_move_in
    • date_move_out
• Updated the bank_accounts node:
  • Removed fields:
    • bank_account_status
    • bank_account_subtype
    • creditor_industry
    • history
    • history_frequency
    • institution_phone
    • start_balance
  • Added fields:
    • current_pay_status
    • current_pay_substatus
    • is_overdraftable
    • is_overdrawn
  • Renamed current_balance to balance
• Updated the collections node:
  • Removed fields:
    • creditor_industry
    • creditor_name
    • collection_status
    • date_paid_off
    • original_amount
    • reason
  • Added fields:
    • is_paid
    • linked_entries (also added to v1 and v2 in October 2019)
  • Renamed fields:
    • balance_amount to balance
    • date_assigned to date_filed
• Updated the disputes node:
  • Removed fields:
    • amount_protested
    • city
    • date_resolved
    • dispute_subtype
    • dispute_type
    • original_currency
    • state
  • Added field linked_entries (also added to v1 and v2 in October 2019)
• Updated the employers node:
  • Removed fields:
    • address
    • city
    • date_started
    • date_terminated
    • district
    • neighborhood
    • state
    • street
    • telephone
    • zipcode
• Updated the frauds node:
  • Removed fields:
    • case_id
    • case_number
    • fraud_status
    • fraud_subtype
    • fraud_type
    • fraudster_role
    • initial_reason_reported
    • report_type
  • Added fields:
    • is_fraudster
    • linked_entries (also added to v1 and v2 in October 2019)
• Updated the inquiries node:
  • Removed fields:
    • address
    • country
    • district
    • inquiry_subtype
    • inquiry_type
    • inquiry_value
    • neighborhood
    • original_currency
    • state
    • street1
    • street2
    • telephone1
    • zipcode
  • Added field is_credit_seeking
• Updated the notices node:
  • Removed fields:
    • comments
    • date_to_be_purged
    • notice_subtype
    • notifier_phone
• Updated the nonsufficient_funds node:
  • Removed fields:
    • account_number
    • creditor_name
    • creditor_phone
    • date_opened
    • date_overdrafted
    • duration_of_account
    • nonsufficient_amount
    • original_currency
    • overdraft_balance
    • responsibility
  • Added field linked_entries (also added to v1 and v2 in October 2019)
  • Renamed date_reported to nonsufficient_date
• Updated the personal node:
  • Removed fields:
    • comments
    • date_last_reported
    • education
    • father_first_name
    • father_full_name
    • father_last_name
    • mother_first_name
    • mother_full_name
    • mother_last_name
• Updated the public_records node:
  • Removed fields:
    • amount
    • case_number
    • city
    • credit_industry
    • date_matured
    • date_satisfied
    • date_verified
    • defendant_name
    • garnishee_name
    • lawyer_name
    • original_currency
    • plaintiff_name
    • public_record_status
    • state
  • Added fields:
    • is_resolved
  • Updated possible values for public_record_type
• Updated the tradelines node:
  • Removed fields:
    • address
    • collateral_items
    • country
    • credit_type
    • date_first_payment
    • date_first_payment_history
    • date_last_balance_zero
    • date_last_payment
    • date_last_payment_history
    • date_maturity
    • date_worst_arrears
    • days_past_due
    • district
    • installment_amount
    • installments_at_open
    • neighborhood
    • number_payments_since_open
    • opening_balance
    • sanctioned_amount
    • settlement_amount
    • street1
    • street2
    • state
    • telephone
    • tradeline_status
    • tradeline_substatus
    • worst_arrears_amount
    • written_off_amount
    • zipcode
  • Added fields:
    • account_type
    • current_condition_status
    • current_condition_type
    • current_pay_status
    • current_pay_substatus
    • payment_obligation_frequency
    • portfolio_type
    • scheduled_payment
  • Renamed fields:
    • tradeline_open to is_open
    • collateralized to is_collateralized
    • opening_balance/sanctioned_amount to original_loan
    • current_balance to balance
• Updated history in the tradelines node:
  • Removed fields:
    • cash_advances
    • credit_limit_changes
    • minimum_payments
    • payment_amounts
    • promotional_rates
    • statement_balances
    • overdraft_balances