API v1 Reference

info

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/v1/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

We highly recommend you switch to our latest version! Read the docs and see what's different 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

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	2233334444	1234567892	2580066232
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
Voter ID number	86953789734322	866849897356234	95134121422221
PAN number	ADIPA8123J	AFUPJ7365N	AAWPH3050M
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

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

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": [
    ...
  ],
  "other_assets": [
    ...
  ],
  "public_records": [
    ...
  ],
  "frauds": [
    ...
  ],
  "collections": [
    ...
  ],
  "nonsufficient_funds": [
    ...
  ],
  "identifiers": [
    ...
  ],
  "addresses": [
    ...
  ],
  "employers": [
    ...
  ],
  "other_incomes": [
    ...
  ],
  "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]
• identifiers [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]
• other_assets [array]
• employers [array]
• other_incomes [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": "1.0.1",
    "consent_version": "1.0.1",
    "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",
      "father_last_name": "Du",
      "email": "rajdu@email.com",
      "telephone": "+9146270422",
      "date_of_birth": "1989-10-25"
    },
  ...
}

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
father_last_name	String
father_first_name	String
father_full_name	String	Only provided if name not given as separate fields
mother_last_name	String
mother_first_name	String
mother_full_name	String	Only provided if name not given as separate fields
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
education	String	Highest education the applicant completed. See See education
is_deceased	Bool
date_of_death	Full Date or short date	Only provided if is_deceased is true
date_last_reported	Full Date
comments	Array

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 returned from the foreign bureau 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": "RATIO_CREDIT_UTILIZATION",
      "metric_value": 0.40103270223752152,
      "metric_label": "Credit Utilization Ratio",
      "metric_format": "NUMERIC",
      "metric_type": "RATIO"
    },
    {
      "metric_status": "AVAILABLE",
      "metric_source": "NOVA",
      "metric_name": "RATIO_ON_TIME_PAYMENTS",
      "metric_value": 0.83695652173913049,
      "metric_label": "On Time Payment Ratio",
      "metric_format": "NUMERIC",
      "metric_type": "RATIO"
    },
    {
      "metric_name": "KOR_NICE_COUNT_CREDIT_CARDS",
      "metric_source": "BUREAU",
      "metric_status": "AVAILABLE",
      "metric_type": "INTEGER",
      "metric_label": "Open Credit Card Tradelines",
      "metric_format": "TIMESERIES",
      "most_recent_date": "2019-01-01T00:00:00.000Z",
      "metric_timeseries": {
        "values": [
          2,
          2,
          2,
          3,
          3,
        ],
        "interval": "MONTHLY"
      },
    },
  ],
  ...
}

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, four metrics are included in every response:

• RATIO_CREDIT_UTILIZATION
• RATIO_ON_TIME_PAYMENTS
• COUNT_INQUIRIES_LAST_TWELVE_MONTHS
• TOTAL_MONTHLY_INSTALLMENTS

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_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": "CITIBANK",
    "telephone": "+912242142602",
    "address": "322 West View Building, Linking Road, Khar West, Mumbai, 400052, Maharashtra",
    "credit_type": "REVOLVING",
    "original_currency": "INR",
    "date_opened": "2012-12-22",
    "date_last_reported": "2017-01-01",
    "date_first_payment": "2011-01-01",
    "date_last_payment": "2016-12-30",
    "date_worst_arrears": "2013-11-14",
    "worst_arrears_amount": "3921",
    "past_due_balance": 0,
    "number_payments_since_open": 62,
    "tradeline_type": "CREDIT_CARD",
    "tradeline_status": "ACTIVE",
    "tradeline_open": true,
    "responsibility": "INDIVIDUAL",
    "current_balance": 1104,
    "high_balance": 1502,
    "credit_limit": 4100,
    "payment_frequency": "MONTHLY",
    "collateral_items": [{
      ...
    }, {
      ...
    }],
    "payment_history": [{
      ...
    }, {
      ...
    }]
  }]
}

Tradelines refer to the applicant's previous and current credit-related products, which they've held over 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	Name of the lending institution
translated_institution	String	Translated name of the lending institution
telephone	String	Telephone of the lending institution
address	String	The entire address of the lending institution, only if it was returned in one blob
street1	String
street2	String
neighborhood	String
district	String
country	String
zipcode	String
state	String
credit_type	String	See credit_type
payment_frequency	String	See payment history
original_currency	ISO 4217
date_opened	Full Date or Short Date
date_last_reported	Full Date or Short Date
date_closed	Full Date or Short Date
date_first_payment	Full Date or Short Date
date_last_payment	Full Date or Short Date
last_payment_amount	Integer
date_first_payment_history	Full Date or Short Date
date_last_payment_history	Full Date or Short Date
date_worst_arrears	Full Date or Short Date	The date the longest held delinquency was paid back or the current date if the longest held delinquency is still in arrears
worst_arrears_amount	Integer	The delinquency, of any amount, that stayed delinquent the longest
date_last_balance_zero	Full Date or Short Date
past_due_balance	Integer
number_payments_since_open	Integer
tradeline_type	String	See tradeline_type
tradeline_subtype	String	See tradeline_subtype
tradeline_status	String	See tradeline_status
tradeline_substatus	String	See tradeline_substatus
responsibility	String	See responsibility
collateralized	Bool
tradeline_open	Bool
settlement_amount	Integer
written_off_amount	Integer
current_balance	Integer
high_balance	Integer
opening_balance	Integer
credit_limit	Integer
sanctioned_amount	Integer
installment_amount	Integer
installments_at_open	Integer
collateral_items	Array	See collateral_items
payment_history	Array	See payment history
comments	Array	See comments

payment_history

Monthly payment_history example over three years:
  {
    "payment_history": [{
    "payments": [2, 2, 2, 3, 3, 3, 2, 2, 0, 0, 0, 0],
    "year": "2016"
  }, {
    "payments": [2, 2, 2, 2, 2, 2, 2, 2, 2, 3, 3, 3],
    "year": "2015"
    }, {
    "payments": [0, 0, 0, 0, 0, 0, 0, 2, 2, 2, 2, 2],
    "year": "2014"
  }]
}

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

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

Field	Format	Notes
payments	Array	0 = N/A payment, out of range 1 = reported but unknown specifics 2 = paid on time 3 = Less than or equal to 30 days past due 4 = Less than or equal to 60 days past due 5 = Less than or equal to 90 days past due 6 = Less than or equal to 120 days past due 7 = More than 120 days past due
year	Integer{4}	YYYY

payment_frequency explanation

Payment 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.

collateral_items

Example response from the collateral_items array:
  {
    "collateral_items":
    [{
      "collateral_id": "e739e41e-f404-11e6-bc64-92361f002671",
      "collateral_type": "VEHICLE",
      "collateral_value": 5000,
      "date_valuation": "2013-09-21",
      "owners_first_name": "Raj",
      "year_manufacture": 2009,
      "registration_number": "87GDS2"
    }]
  }
}

A child to tradelines, collateral_items refer to items that have been posted as collateral. collateral_items are returned in an array, can have zero objects and there is no upper bound.

Field	Format	Notes
collateral_id	UUID
collateral_type	String	See collateral_type
collateral_value	Integer
date_valuation	Full Date or Short Date
owners_first_name	String
vehicle_type	String
year_manufacture	Integer	YYYY
registration_number	String
engine_number	String
chassis_number	String

bank_accounts []

Example response from the bank_accounts array:
{
  "bank_accounts": [{
    "bank_account_id": "8c46ab70-d485-11e7-a5ca-95dbcbcedd5b",
    "bank_account_type": "CHECKING",
    "bank_account_subtype": "PERSONAL",
    "bank_account_status": "OPEN",
    "creditor_industry": "Credit card, Visa, M/C (issued by bank or trust company)",
    "responsibility": "INDIVIDUAL",
    "date_last_reported": "2017-11-01",
    "date_opened": "2015-07-19",
    "institution": "HSBC",
    "institution_phone": "+912242142602",
    "current_balance": 20048,
    "start_balance": 2655,
    "balance_history_frequency": "MONTHLY",
    "original_currency": "GBP",
    "balance_history": [{
      "year": 2017,
      "balances": [ ... ]
      }],
    "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
bank_account_subtype	String	See bank_account_subtype
bank_account_status	String	See bank_account_status
date_last_reported	Full Date or Short Date
date_opened	Full Date or Short Date
date_closed	Full Date or Short Date
institution	String	Name of the institution providing the account
translated_institution	String	Translated name of the institution providing the account
institution_phone	String
creditor_industry	String
responsibility	String	See responsibility
current_balance	Integer
start_balance	Integer
balance_history_frequency	String
original_currency	ISO 4217
balance_history	Array	See balance_history
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)	✗
Australia Equifax (AUS_EFX)	✗
Korea NICE (KOR_NICE)	✓
Nigeria CRC (NGA_CRC)	✗
Brazil Experian (BRA_XP)	✗

balance_history

Monthly balance_history example over two years:
{
  "balance_history": [{
    "overdraft_balances": [0, 0, 25, 0, 0, 0, 0, 0, 0, 0, 0, 0],
    "year": "2017"
    }, {
    "overdraft_balances": [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],
    "year": "2016"
  }],
}

A child to bank accounts, balance_history refers to the applicant's overdraft balance history. balance_history is returned in an array and can have zero objects or a maximum of 7 objects (years).

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

Field	Format	Notes
overdraft_balances	Array	The bank overdraft balance or null if unknown
year	Integer{4}	YYYY

balance_history_frequency explanation

Balance 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 event 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 event 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 event 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 event 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 event happened, hence Nova defaults to counting from the end of the year onward.

other_assets []

Example response from the other assets array:
{
  "other_assets": [{
    "other_asset_id": "8c465d52-d485-11e7-a5ca-95dbcbcedd5b",
    "other_asset_type": "PROPERTY",
    "start_value": 75679,
    "end_value": 89021,
    "date_started": "2007-01-01",
    "date_ended": "2007-12-31",
    "date_updated": "2007-01-15",
    "original_currency": "GBP",
    "comments": [ ... ]
  }]
}

Other assets refer to the applicant's previous and current non-bank assets, which they've held over the past seven years. other_assets are returned in an array, can have zero objects, and there is no upper bound.

Field	Format	Notes
other_asset_id	UUID	Reference ID of the asset
other_asset_type	String	See other_asset_type
start_value	Integer	The starting value of the asset for the reported period
end_value	Integer	The ending value of the asset for the reported period
date_started	Full Date or Short Date
date_ended	Full Date or Short Date
date_updated	Full Date or Short Date
original_currency	ISO 4217
is_insured	Bool
insurance_expiry_date	Full Date or Short Date	Only provided if is_insured is true
city	String
state	String
percent_owned	Integer	Only provided if the asset is pertaining to company ownership
company_name	String	Only provided if the asset is pertaining to company ownership
comments	Array	See comments

Supported Bureaus

	other_assets
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)	✗
Australia Equifax (AUS_EFX)	✗
Korea NICE (KOR_NICE)	✗
Nigeria CRC (NGA_CRC)	✗
Brazil Experian (BRA_XP)	✓

public_records []

Example response from the public_records array:
{
  "public_records": [{
    "public_record_id": "8c463646-d485-11e7-a5ca-95dbcbcedd5b",
    "public_record_type": "FORECLOSURE",
    "public_record_status": "SATISFIED",
    "amount": 13410,
    "date_filed": "2014-06-01",
    "court_name": "ABERDARE",
    "case_number": "XX123456",
    "date_verified": "2014-08-01",
    "defendant_name": "DAVID JONES",
    "plaintiff_name": "BANK OF SCOTLAND",
    "lawyer_name": "JOHN SMITH",
    "date_satisfied": "2014-08-01",
    "date_last_reported": "2014-08-01",
    "credit_industry": "MORTGAGE",
    "original_currency": "GBP",
    "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
public_record_status	String	See public_record_status
amount	Integer	Amount associated with the public record, if any
date_filed	Full Date or Short Date
court_name	String
case_number	String
date_verified	Full Date or Short Date
defendant_name	String
plaintiff_name	String
lawyer_name	String
garnishee_name	String	Only applies if type is GARNISHMENT See public_record_type
date_satisfied	Full Date or Short Date
date_matured	Full Date or Short Date
date_last_reported	Full Date or Short Date
credit_industry	String	Industry of the lending creditor
city	String	City where the public record was recorded
state	String	State where the public record was recorded
original_currency	ISO 4217
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)	✗
Australia Equifax (AUS_EFX)	✓
Korea NICE (KOR_NICE)	✓
Nigeria CRC (NGA_CRC)	✗
Brazil Experian (BRA_XP)	✓

frauds []

Example response from the frauds array:
{
  "frauds": [{
    "fraud_id": "dc88c991-9ae0-455e-a059-0aee1f34d4f5",
    "fraud_type": "Identity fraud",
    "report_type": "Granted",
    "date_reported": "2016-12-12",
    "initial_reason_reported": "Undeclared convictions",
    "fraudster_role": "True identity (06)",
    "case_id": "L12345680",
    "case_number": "20034B",
    "comments": [ ... ],
    "linked_entries": {
        "tradeline_id": "7fd07aa2-d6a6-43be-8c92-14717f2d3897",
    },
  }],
}

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
fraud_type	String	The type of fraud provided directly by the bureau
fraud_status	String	The status of the fraud provided directly by the bureau
report_type	String	The type of the fraud report provided directly by the bureau
date_reported	Full date
initial_reason_reported	String
fraudster_role	String	Role the applicant played in the fraud
case_id	String	Court case id associated with the fraud
case_number	String	Court case number associated with 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)	✗
Australia Equifax (AUS_EFX)	✗
Korea NICE (KOR_NICE)	✓
Nigeria CRC (NGA_CRC)	✗
Brazil Experian (BRA_XP)	✗

collections []

Example response from the collections array:
{
  "collections": [{
    "collection_id": "850192c9-353d-48e3-9fac-89642cc73604",
    "collection_status": "PAID",
    "agency_name": "METRO RECOVERY",
    "creditor_name": "ROGERS WIRELESS",
    "reason": "Other",
    "date_last_reported": "2015-11-01",
    "original_amount": 642,
    "balance_amount": 176,
    "date_assigned": "2016-07-01",
    "date_last_payment": "2015-11-01",
    "original_currency": "CAD",
    "comments": [ ... ],
    "linked_entries": {
        "tradeline_id": "213bd089-a12b-4764-b48a-2548ec101702",
    },
  }]
}

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
collection_status	String	See collection_status
agency_name	String	Collection agency name
creditor_name	String
creditor_industry	String
reason	String	Reason the creditor assigned the payment to be collected
date_last_reported	Full Date or Short Date
original_amount	Integer	Original amount of purchased loan
balance_amount	Integer	Amount still owed to agency
date_assigned	Full Date or Short Date	Date collection was given to collection agency
date_paid_off	Full Date or Short Date	Date entirely paid off
date_last_payment	Full Date or Short Date
original_currency	ISO 4217
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)	✗
Australia Equifax (AUS_EFX)	✗
Korea NICE (KOR_NICE)	✓
Nigeria CRC (NGA_CRC)	✗
Brazil Experian (BRA_XP)	✗

nonsufficient_funds []

Example response from the nonsufficient funds array:
{
  "nonsufficient_funds": [{
    "nonsufficient_fund_id": "2a644d66-bbed-46d2-a543-cf92755ba272",
    "creditor_name": "BQE ROYALE",
    "creditor_phone": "450-686-3440",
    "date_reported": "2015-03-01",
    "date_last_reported": "2015-07-01",
    "date_opened": "2011-11-11",
    "date_overdrafted": "2015-03-01",
    "nonsufficient_amount": 430,
    "overdraft_balance": 20,
    "duration_of_account": "3 YEARS",
    "original_currency": "GBP",
    "comments": [ ... ],
    "linked_entries": {
        "bank_account_id": "cc32dfd2-30cd-4200-a05a-84cf2b627b6d",
    },
  }]
}

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
creditor_name	String	Creditor of the delinquent account
creditor_phone	String
date_reported	Full Date or Short Date	Date initially reported
date_last_reported	Full Date or Short Date
date_opened	Full Date or Short Date	Date the delinquent account was opened
date_overdrafted	Full Date or Short Date
nonsufficient_amount	Integer
overdraft_balance	Integer	Balance of the account when it went into delinquency
duration_of_account	String	Length of the account's history
original_currency	ISO 4217
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)	✗
Australia Equifax (AUS_EFX)	✗
Korea NICE (KOR_NICE)	✓
Nigeria CRC (NGA_CRC)	✗
Brazil Experian (BRA_XP)	✓

inquiries []

Example of two inquiries within the inquiries array:
{
  "inquiries": [
    {
      "inquiry_id": "f9609e9e-f404-11e6-bc64-92361f002671",
      "inquiry_type": "CREDIT",
      "inquiry_value": 5000,
      "inquiry_date": "2016-09-22",
      "company_name": "HSBC INC",
      "telephone": "+913172162721",
      "address": "2212 Highline Building, Lorn Road, Khar East, Mumbai, 400052, Maharashtra",
      "is_credit_seeking": true
    },
    {
      "inquiry_id": "08dd0f88-f405-11e6-bc64-92361f002671",
      "inquiry_type": "MORTGAGE",
      "inquiry_value": 100000,
      "original_currency": "INR",
      "inquiry_date": "2016-09-22",
      "company_name": "BANK OF INDIA",
      "telephone": "+915422162934",
      "street1": "168 Hatfield Square",
      "street2": "Shah Road",
      "neighborhood": "Bandra West",
      "district": "Mumbai",
      "zipcode": "400052",
      "state": "Maharashtra",
      "is_credit_seeking": true
    }
  ],
  ...
}

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.

Note that the address will be returned by default using specific keys (street, zipcode, etc) or using the address field if it was returned as a single string.

Field	Format	Notes
inquiry_id	UUID	Reference ID of the inquiry
is_credit_seeking	Bool	Whether the inquiry is soft (false) or hard (true). Reports generated prior to June 18, 2019 will not contain this field
inquiry_type	String	See inquiry_type
inquiry_subtype	String	See inquiry_subtype
inquiry_value	Integer
original_currency	ISO 4217	The original currency the values were returned in
inquiry_date	Full Date or Short Date
company_name	String
translated_company_name	String
telephone1	String
address	String	The entire address of the lending institution if it was returned in a single string
street1	String
street2	String
neighborhood	String
district	String
country	String
city	String
zipcode	String
state	String
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)	✓
Australia Equifax (AUS_EFX)	✓
Korea NICE (KOR_NICE)	✗
Nigeria CRC (NGA_CRC)	✓
Brazil Experian (BRA_XP)	✓

employers []

Example of the employers array:
{
  "employers": [
    {
      "employer_id": "682ed21e-f405-11e6-bc64-92361f002671",
      "company_name": "Google Mexico",
      "street": "445 Calle Montes Urales",
      "neighborhood": "Lomas - Virreyes",
      "district": "Ciudad de México",
      "country": "MEX",
      "zipcode": "11000",
      "state": "Ciudad de México",
      "annual_salary": 50000,
      "date_started": "2012-03-01",
      "date_terminated": "2016-11-30"
    }
  ],
  ...
}

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
job_title	String
telephone	String
address	String	Only provided if the address was provided as a single string
street	String
neighborhood	String
district	String
city	String
zipcode	String
state	String
annual_salary	Integer
original_currency	ISO 4217	Only provided if annual_salary exists
date_reported	Full Date or Short Date
date_started	Full Date or Short Date
date_terminated	Full Date or Short Date

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)	✓
Australia Equifax (AUS_EFX)	✓
Korea NICE (KOR_NICE)	✗
Nigeria CRC (NGA_CRC)	✗
Brazil Experian (BRA_XP)	✓

addresses []

Example of the addresses array:
{
  "addresses": [
    {
      "address_id": "043d133c-f406-11e6-bc64-92361f002671",
      "address": "2 Nhavi Street, Khar East, Mumbai, 400052, Maharashtra",
      "address_type": "HOME",
      "date_move_in": "2013-06-10",
      "date_move_out": "2015-05-12",
      "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
address_type	String	See address_type
date_move_in	Full Date or Short Date
date_move_out	Full Date or Short Date
date_reported	Full Date or Short Date

identifiers []

Example of the identifiers array:
{
  "identifiers": [{
      "identifier_id": "1e9dbb9a-f407-11e6-bc64-92361f002671",
      "identification_type": "PAN",
      "issuer_country": "IND",
      "date_issued": "2011-01-01",
      "date_expired": "2022-01-01"
    }],
  ...
}

Identifiers is a collection of the applicant’s identification documents on file. identifiers are returned in an array, can have zero objects, and there is no upper bound.

Field	Format	Notes
identifier_id	UUID	Reference ID of this identity object
identification_type	String	See identifier_type
issuer_country	ISO 3166-1 alpha-3
issuer_state	String
issuer_city	String
id_status	String	See id_status
date_issued	Full Date or Short Date
date_reported	Full Date or Short Date
date_expired	Full Date or Short Date

other_incomes []

Example of the other incomes array:
{
  "other_incomes": [{
    "other_income_id": "682ed21e-f405-11e6-bc64-92361f002671",
    "date_reported": "2016-12-02",
    "amount": 26000,
    "frequency": "Annual",
    "income_source": "Sales Consulting",
    "original_currency": "CAN"
  }]
}

Other incomes is a history of the applicant’s non-salaried employment. other_incomes are returned in an array, can have zero objects, and there is no upper bound.

Field	Format	Notes
other_income_id	UUID	Reference ID of this other income
date_reported	Full Date or Short Date
amount	Integer
frequency	String	See other_income_frequency
income_source	String	Description of the employment
original_currency	ISO 4217
comments	Array	See comments

Supported Bureaus

	other_incomes
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)	✗
Australia Equifax (AUS_EFX)	✗
Korea NICE (KOR_NICE)	✗
Nigeria CRC (NGA_CRC)	✗
Brazil Experian (BRA_XP)	✗

disputes []

Example response from the disputes array:
{
  "disputes": [{
    "dispute_id": "f69ae0d8-d932-4ff8-b3f1-8983285d3a0a",
    "dispute_type": "DISPUTE",
    "date_reported": "2016-12-12",
    "statement": "This data has been disputed by the individual concerned.",
    "linked_entries": {
        "tradeline_id": "c1994738-aad9-4c76-914d-7ab341f81e5c",
        "public_record_id": "ce3dffbb-1219-4dc1-8251-37660a9da8e4",
        "collection_id": "2e9b8f8e-1ca8-4774-b16e-6aa6b94fa659"
    },
  }],
}

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
dispute_type	String	See dispute_type
date_reported	Full date
statement	String	Full description of the dispute
amount_protested	Integer	Amount the consumer is protesting, if applicable
city	String	City where the consumer filed the dispute
state	String	State where the consumer filed the dispute
date_resolved	Full Date or Short Date
original_currency	ISO 4217	Only provided if amount_protested exists
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)	✗
Australia Equifax (AUS_EFX)	✓
Korea NICE (KOR_NICE)	✗
Nigeria CRC (NGA_CRC)	✗
Brazil Experian (BRA_XP)	✓

comments []

{
  ...,
  "comments": [...]
}

Several nodes of passport contain a comments property, which is an array of 0 or more string values. 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

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
AUS_EFX	Australia Equifax
KOR_NICE	Korea NICE
NGA_CRC	Nigeria CRC
BRA_XP	Brazil Experian

inquiry_type

inquiry_type is returned as part of an array via inquiries. Those marked deprecated are now reported as a combination of inquiry_type and inquiry_subtype. Reports generated prior to 2018-02-21 may contain deprecated values. New reports generated after 2018-02-21 will not contain deprecated values.

Value	Description
CREDIT	Credit
OTHER	Other
UNKNOWN	Unknown
MONITORING	Deprecated
CREDIT_CARD	Deprecated
VEHICLE_AUTO	Deprecated
VEHICLE_OTHER	Deprecated
MORTGAGE	Deprecated
PERSONAL	Deprecated
STUDENT	Deprecated
UTILITY	Deprecated
COMMERCIAL	Deprecated
CONSUMER	Deprecated
TENANT	Deprecated

currency_source

Values of the currency_source field.

Value	Description
ECB	European Central Bank
OER	Open Exchange Rates

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

credit_type

Values of the credit_type field.

Value	Description
REVOLVING	I.e. credit cards
FIXED	I.e. mortgages

tradeline_type

Values of the tradeline_type field. Those marked deprecated are now reported as a combination of tradeline_type and tradeline_subtype. Reports generated prior to 2018-02-21 may contain deprecated values. New reports generated after 2018-02-21 will not contain deprecated values.

Value	Description
CREDIT_CARD	Any credit-card type falls into this category. This can be a secured or unsecured card, retail cards, commercial cards, and more
PERSONAL	Any loan for personal use
REAL_ESTATE	Any loan for a building or building-related uses fall into this category. This can be a mortgage, HTLOC, real estate, warehouse, or a loan for a home improvement
STUDENT	Any loan for educational purposes
UTILITY	Any loan to cover utilities. Examples are mobile usage bills, cable bills, electricity bills, and more
VEHICLE_AUTO	Any loan or lease for a vehicle that is a car
VEHICLE_OTHER	Any loan or lease for a vehicle that is not a car
UNKNOWN
OTHER
COMMERCIAL	Deprecated
CONSUMER	Deprecated
CHANGED_STRUCTURE	Deprecated
MORTGAGE	Deprecated

tradeline_status

Values of the tradeline_status field and its mapping to tradeline_open field. Those marked deprecated are now reported as a combination of tradeline_status and tradeline_substatus. Reports generated prior to 2018-02-21 may contain deprecated values. New reports generated after 2018-02-21 will not contain deprecated values.

Value	tradeline_open	Description
ACTIVE	True	Active and nothing past due
CLOSED	False	The tradeline has been closed
DEFAULT_WRITE_OFF	False	The applicant refused to make payments and defaulted or the tradeline was written off by the credit grantor (collections unsuccessful)
DEFAULT_OUTSTANDING	False	The applicant refused to make payments and defaulted and the credit grantor is waiting to receive money
TRANSFER_SOLD	False	The tradeline has been transferred or sold
DISPUTED		The tradeline's status is in dispute by the consumer
INACTIVE	False	The tradeline is inactive
LOST	False	The tradeline's status is marked as erroneous due to fraudulent activity or lost by consumer
PAST_DUE	True	The applicant currently has past due payments on this tradeline
REPOSSESSION	False	The tradeline has been repossessed by the credit grantor
RESTRUCTURED	True	The tradeline has been financially restructured
SETTLED	False	The applicant and the creditor have agreed to settle with some agreement to close the tradeline
OTHER		There was unexpected behavior with this tradeline. In some cases the tradeline may be open, and in other cases the tradeline may be closed
UNKNOWN		The tradeline's status is unknown
SUIT		Deprecated
WRITTEN_OFF		Deprecated
DEFAULT		Deprecated

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
JOINT_OBLIGATOR	Deprecated

collateral_type

Values of the collateral_type field.

Value	Description
PROPERTY	Some form of property. As an example, this can be a home or a building used for commercial purposes
VEHICLE	Any type of vehicle
EQUITY	Any type of equity or financial products. I.e. options, futures, or other financial contracts
INSURANCE	Backed by an insurance company
OTHER

address_type

Values of the address_type field.

Value	Description
HOME	The address was listed as the individual's home
BUSINESS	A business address
POST_OFFICE_BOX	A mailing address
OTHER

identifier_type

Values of the identifier_type field.

Value	Description
RATION_CARD
DRIVER_LICENSE
PASSPORT
CURP	Unique ID code both citizens and residents of Mexico (Clabe Unica de Registro de Poblacion)
RFC	In Mexico, a legal entity such as a company or a person is assigned two tax ID numbers including the RFC
VOTER_ID
PAN	Permanent Account Number is a code that acts as an identification for Indian nationals, especially those who pay Income Tax
SSN	Social security number
RESIDENT_IDENTITY_CARD	Official document for personal identification in the People's Republic of China
BVN	Business Verification Number in Nigeria
CPF	Brazilian individual taxpayer registry identification
OTHER

bank_account_type

Values of the bank_account_type field.

Value	Description
CHECKING	Checking account
SAVINGS	Savings account
OTHER

bank_account_subtype

Values of the bank_account_subtype field.

Value	Description
PERSONAL	Personal account
JOINT	Joint account
BUSINESS	Business account
OTHER

bank_account_status

Values of the bank_account_status field.

Value	Description
OPEN	Open account
CLOSED	Closed account
INACTIVE	Inactive account
NOT_FOUND	Account not found
OTHER

other_asset_type

Values of the other_asset_type field.

Value	Description
PROPERTY	Property asset
OTHER

public_record_type

Values of the public_record_type field.

Value	Description
BANKRUPTCY	Bankruptcy
FORECLOSURE	Foreclosure (mortgage)
GARNISHMENT	Garnishment
SECURED_LOAN	Secured loan
DIRECTORSHIP	Directorship
DISQUALIFIED_DIRECTORSHIP	Disqualified Directorship
REGISTERED_BUSINESS	Registered Business
REPOSSESSION	Repossession
TAX	Tax
OTHER

public_record_status

Values of the public_record_status field.

Value	Description
SATISFIED	The public record was marked as satisfied
SETTLED	The public record was marked as settled
UNSETTLED	The public record was marked as unsettled
DISMISSED	The public record was marked as dismissed
DISCHARGED	The public record was marked as discharged
DISPUTED	The public record was marked as disputed
OTHER

collection_status

Values of the collection_status field.

Value	Description
PAID	The collection was marked as paid
UNPAID	The collection was marked as unpaid
DISPUTED	The collection was disputed
OTHER

other_income_frequency

Values of the frequency field for other_incomes. This value represents how often the applicant receives non-salaried income.

Value	Description
MONTHLY	The non-salaried employment pays monthly
ANNUAL	The non-salaried employment pays annually
FIXED	The non-salaried employment pays at once, e.g., project-based commissions
OTHER

dispute_type

Values of the dispute_type field for disputes.

Value	Description
DISPUTE	The applicant's credit report was disputed
CORRECTION	The dispute was corrected and reflected in the applicant's credit report
OTHER

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

tradeline_subtype

Values of the tradeline_subtype field.

Value	Description
SECURED	Any loan or lease that is backed by collateral
COMMERCIAL	Any loan or lease for commercial use
CONSUMER	Any loan or lease for consumer use
INSURANCE	Insurance-related tradeline
LEASE_RENTAL	Any credit related to a rental or lease rather than ownership
MORTGAGE	Mortgage-related tradeline
CASH_ADVANCE

tradeline_substatus

Values of the tradeline_substatus field.

Value	Description
CONSUMER	The tradeline's status is attributed to the consumer
CREDITOR	The tradeline's status is attributed to the creditor
UNKNOWN	It is unknown whom the tradeline's status is attributable to
OTHER	There was unexpected behavior with this tradeline

inquiry_subtype

inquiry_subtype is returned as part of an array via inquiries.

Value	Description
CREDIT_CARD	Credit card-related inquiry
REAL_ESTATE	Real estate-related inquiry
PERSONAL	Personal use
VEHICLE	Vehicle-related inquiry
COMMERCIAL	Commercial-related inquiry
INSURANCE	Insurance-related inquiry
MONITORING	Monitoring-related inquiry
TENANT	Tenant-related inquiry

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	Label
AGE_INQUIRY_MOST_RECENTLY_REPORTED	Age of Most Recently Reported Inquiry (months)
AGE_INQUIRY_OLDEST	Age of Oldest Inquiry (months)
AGE_TRADELINE_MOST_RECENTLY_REPORTED	Age of Most Recently Reported Tradeline (months)
AGE_TRADELINE_OLDEST_MORTGAGE	Age of Oldest Mortgage Tradeline (months)
AGE_TRADELINE_OLDEST_REVOLVING	Age of Oldest Revolving Tradeline (months)
AGE_TRADELINE_OLDEST	Age of Oldest Tradeline (months)
COUNT_BANKRUPTCIES	Bankruptcies
COUNT_COLLECTIONS	Number of Collections
COUNT_DISPUTES	Dispute Records
COUNT_FORECLOSURES	Foreclosures
COUNT_FRAUDS	Fraud Records
COUNT_GARNISHMENTS	Garnishments
COUNT_INQUIRIES_LAST_SIX_MONTHS	Inquiries Last 6 Months
COUNT_INQUIRIES_LAST_TWELVE_MONTHS	Inquiries Last 12 Months
COUNT_INQUIRIES	Inquiries
COUNT_PAYMENTS_LATE_120_DAYS	Payments 120 Days Late
COUNT_PAYMENTS_LATE_30_DAYS	Payments 30 Days Late
COUNT_PAYMENTS_LATE_60_DAYS	Payments 60 Days Late
COUNT_PAYMENTS_LATE_90_DAYS	Payments 90 Days Late
COUNT_PAYMENTS_ON_TIME	On Time Payments
COUNT_PAYMENTS_PAST_DUE_12_MONTHS_OVER_60_DAYS	Tradelines 60 Days Past Due in Past 12 Months
COUNT_PAYMENTS_PAST_DUE_12_MONTHS_OVER_90_DAYS	Payments 90 Days Past Due in Past 12 Months
COUNT_PAYMENTS_PAST_DUE_6_MONTHS_OVER_60_DAYS	Payments 60 Days Past Due in Past 6 Months
COUNT_TRADELINES_DELINQUENT_120_DAYS	Tradelines Delinquent 120 Days
COUNT_TRADELINES_DELINQUENT_30_DAYS	Tradelines Delinquent 30 Days
COUNT_TRADELINES_DELINQUENT_60_DAYS	Tradelines Delinquent 60 Days
COUNT_TRADELINES_DELINQUENT_90_DAYS	Tradelines Delinquent 90 Days
COUNT_TRADELINES_DELINQUENT	Tradelines Ever Delinquent
COUNT_TRADELINES_OPEN_COLLATERALIZED	Open Collateralized Tradelines
COUNT_TRADELINES_OPEN_MORTGAGE	Open Mortgage Tradelines
COUNT_TRADELINES_OPEN_REVOLVING	Open Revolving Tradelines
COUNT_TRADELINES_OPEN	Open Tradelines
COUNT_TRADELINES	Tradelines
RATIO_CREDIT_UTILIZATION_REVOLVING	Revolving Credit Utilization Ratio
RATIO_CREDIT_UTILIZATION	Credit Utilization Ratio
RATIO_ON_TIME_PAYMENTS	On Time Payment Ratio
TOTAL_DEBT_MORTGAGE	Total Debt (Mortgage)
TOTAL_DEBT_NON_MORTGAGE	Total Debt (Non-Mortgage)
TOTAL_DEBT_NON_REVOLVING	Total Debt (Non-Revolving)
TOTAL_DEBT_REVOLVING	Total Debt (Revolving)
TOTAL_DEBT	Total Debt
TOTAL_MONTHLY_INSTALLMENTS_MORTGAGE	Total Monthly Installments (Mortgage)
TOTAL_MONTHLY_INSTALLMENTS_NON_MORTGAGE	Total Monthly Installments (Non-Mortgage)
TOTAL_MONTHLY_INSTALLMENTS	Total Monthly Installments
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
SERASA_VALUE_PAYMENT_DEROGS	[Provided by BRA_XP] Value of delinquent payments
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

education

Values of the education field.

Value
GRADE_SCHOOL
HIGH_SCHOOL
HIGHER_EDUCATION
POST_GRADUATE

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

id_status

Values of the id_status field.

Value	Description
ACTIVE	Active
PENDING	Pending
CANCELED	Canceled
SUSPENDED	Suspended

interval

Values of the interval field.

Value
WEEKLY
BI_WEEKLY
SEMI_MONTHLY
MONTHLY
BI_MONTHLY
QUARTERLY
SEMI_ANNUAL
ANNUAL

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

{
    "personal": {
        "first_name": "David William",
        "last_name": "Jones",
        "full_name": "David William Jones",
        "email": "david@email.com",
        "date_of_birth": "1989-10-25"
    },
    "meta": {
        "public_token": "8dfb3377-6c6f-4974-a8ce-b51a3deac8e2",
        "pdf_name": "david_william_jones_b51a3deac8e2.pdf",
        "callback_URL": "https://customerurl.com/nova",
        "created_at": "2018-06-01T23:25:44.861Z",
        "user_args": "22bbd586-12b9-4876-8ec0-d210d081f4a1|email@test.com",
        "country": "GBR",
        "country_destination": "USA",
        "company_code": "GBR_EFX",
        "consent_version": "1.1.44",
        "api_version": "1.3.54",
        "bureau_report_id": "214abi4fop1a4"
        "external_id": "d20f8cb2-969a-4448-97ea-c0680ed4d880",
    },
    "product": {
        "product_id": "c3a37c41-7c62-11e7-8141-19157d9a48c7",
        "name": "Pascoe Gardens Sandbox",
        "inquiry_type": "TENANT"
    },
    "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.44"
        }
    ],
    "currencies": [
        {
            "original": "GBP",
            "target": "USD",
            "date": "2018-06-01",
            "rate": "1.3309",
            "source": "ECB"
        }
    ],
    "tradelines": [
        {
            "tradeline_id": "1b8d8d40-65f3-11e8-8a5e-cfb8cf94e440",
            "institution": "VIRGIN MONEY",
            "credit_type": "REVOLVING",
            "payment_frequency": "MONTHLY",
            "date_opened": "2013-04-20",
            "date_last_reported": "2018-04-12",
            "past_due_balance": 0,
            "tradeline_type": "CREDIT_CARD",
            "tradeline_status": "ACTIVE",
            "tradeline_open": true,
            "current_balance": 580,
            "opening_balance": 0,
            "credit_limit": 1682,
            "payment_history": [
                {
                    "year": 2018,
                    "payments": [
                        0,
                        0,
                        0,
                        0,
                        0,
                        0,
                        2,
                        2,
                        2,
                        2,
                        2,
                        2
                    ]
                },
                {
                    "year": 2017,
                    "payments": [
                        2,
                        2,
                        2,
                        2,
                        2,
                        2,
                        2,
                        2,
                        2,
                        2,
                        2,
                        2
                    ]
                },
                {
                    "year": 2016,
                    "payments": [
                        2,
                        2,
                        2,
                        2,
                        2,
                        2,
                        2,
                        2,
                        2,
                        2,
                        2,
                        3
                    ]
                },
                {
                    "year": 2015,
                    "payments": [
                        2,
                        2,
                        2,
                        2,
                        2,
                        2,
                        2,
                        2,
                        2,
                        2,
                        2,
                        2
                    ]
                },
                {
                    "year": 2014,
                    "payments": [
                        3,
                        0,
                        0,
                        0,
                        0,
                        0,
                        0,
                        0,
                        0,
                        0,
                        0,
                        0
                    ]
                }
            ],
            "collateral_items": [],
            "original_currency": "GBP",
            "metrics": []
        },
        {
            "tradeline_id": "1b8b6a60-65f3-11e8-8a5e-cfb8cf94e440",
            "institution": "HSBC",
            "credit_type": "REVOLVING",
            "payment_frequency": "MONTHLY",
            "date_opened": "2014-07-19",
            "date_last_reported": "2017-11-12",
            "past_due_balance": 0,
            "tradeline_type": "CREDIT_CARD",
            "tradeline_status": "ACTIVE",
            "tradeline_open": true,
            "current_balance": 3467,
            "opening_balance": 0,
            "credit_limit": 4658,
            "payment_history": [
                {
                    "year": 2018,
                    "payments": [
                        0,
                        0,
                        0,
                        0,
                        0,
                        0,
                        2,
                        2,
                        2,
                        2,
                        2,
                        2
                    ]
                },
                {
                    "year": 2017,
                    "payments": [
                        2,
                        2,
                        2,
                        2,
                        2,
                        2,
                        2,
                        2,
                        2,
                        2,
                        2,
                        2
                    ]
                },
                {
                    "year": 2016,
                    "payments": [
                        2,
                        2,
                        2,
                        2,
                        2,
                        2,
                        2,
                        2,
                        2,
                        0,
                        0,
                        0
                    ]
                }
            ],
            "collateral_items": [],
            "original_currency": "GBP",
            "metrics": []
        }
    ],
    "addresses": [
        {
            "address_id": "1b83a233-65f3-11e8-8a5e-cfb8cf94e440",
            "address": "00177 BROMPTON ROAD, LONDON, SW3 1NF, UK",
            "zipcode": "SW3 1NF"
        },
        {
            "address_id": "1b83a232-65f3-11e8-8a5e-cfb8cf94e440",
            "address": "00006 CROMWELL ROAD, ELY, CB6 1AS, UK",
            "zipcode": "CB6 1AS"
        },
        {
            "address_id": "1b83a231-65f3-11e8-8a5e-cfb8cf94e440",
            "address": "00005 CROMWELL ROAD, ELY, CB6 1AS, UK",
            "zipcode": "CB6 1AS"
        }
    ],
    "employers": [],
    "other_incomes": [],
    "inquiries": [
        {
            "inquiry_id": "1b83a230-65f3-11e8-8a5e-cfb8cf94e440",
            "inquiry_type": "OTHER",
            "inquiry_subtype": "INSURANCE",
            "inquiry_date": "2016-12-02",
            "company_name": "CREDIT SUISSE"
        },
        {
            "inquiry_id": "1b837b20-65f3-11e8-8a5e-cfb8cf94e440",
            "inquiry_type": "CREDIT",
            "inquiry_date": "2016-07-01",
            "company_name": "BARCLAYS BANK"
        },
        {
            "inquiry_id": "1b837b22-65f3-11e8-8a5e-cfb8cf94e440",
            "inquiry_type": "OTHER",
            "inquiry_subtype": "INSURANCE",
            "inquiry_date": "2016-06-21",
            "company_name": "DB UK BANK"
        },
        {
            "inquiry_id": "1b837b21-65f3-11e8-8a5e-cfb8cf94e440",
            "inquiry_type": "OTHER",
            "inquiry_subtype": "INSURANCE",
            "inquiry_date": "2016-06-21",
            "company_name": "STANDARD CHARTERED"
        }
    ],
    "identifiers": [],
    "bank_accounts": [
        {
            "bank_account_id": "1b86fd90-65f3-11e8-8a5e-cfb8cf94e440",
            "bank_account_type": "CHECKING",
            "bank_account_subtype": "PERSONAL",
            "bank_account_status": "OPEN",
            "date_last_reported": "2017-11-01",
            "date_opened": "2015-07-19",
            "institution": "HSBC",
            "current_balance": "20096",
            "start_balance": "2662",
            "balance_history_frequency": "MONTHLY",
            "original_currency": "GBP",
            "balance_history": [
                {
                    "year": 2018,
                    "overdraft_balances": [
                        null,
                        null,
                        null,
                        null,
                        null,
                        null,
                        19963,
                        20640,
                        17304,
                        22410,
                        19964,
                        20939
                    ]
                },
                {
                    "year": 2017,
                    "overdraft_balances": [
                        18632,
                        17368,
                        18056,
                        19364,
                        17744,
                        17288,
                        16532,
                        17301,
                        17892,
                        15970,
                        15981,
                        15852
                    ]
                },
                {
                    "year": 2016,
                    "overdraft_balances": [
                        15320,
                        15172,
                        14640,
                        null,
                        null,
                        null,
                        null,
                        null,
                        null,
                        null,
                        null,
                        null
                    ]
                }
            ],
            "comments": []
        },
        {
            "bank_account_id": "1b883610-65f3-11e8-8a5e-cfb8cf94e440",
            "bank_account_type": "CHECKING",
            "bank_account_subtype": "PERSONAL",
            "bank_account_status": "OPEN",
            "date_last_reported": "2017-03-02",
            "date_opened": "2012-08-11",
            "institution": "BARCLAYS BANK",
            "current_balance": "0",
            "start_balance": "0",
            "balance_history_frequency": "MONTHLY",
            "original_currency": "GBP",
            "balance_history": [
                {
                    "year": 2018,
                    "overdraft_balances": [
                        null,
                        null,
                        null,
                        null,
                        null,
                        null,
                        0,
                        0,
                        0,
                        0,
                        0,
                        0
                    ]
                },
                {
                    "year": 2017,
                    "overdraft_balances": [
                        0,
                        0,
                        0,
                        0,
                        0,
                        0,
                        0,
                        null,
                        null,
                        null,
                        null,
                        null
                    ]
                },
                {
                    "year": 2016,
                    "overdraft_balances": [
                        null,
                        null,
                        null,
                        null,
                        null,
                        null,
                        null,
                        null,
                        null,
                        null,
                        null,
                        null
                    ]
                },
                {
                    "year": 2015,
                    "overdraft_balances": [
                        null,
                        null,
                        null,
                        null,
                        null,
                        null,
                        null,
                        null,
                        null,
                        null,
                        null,
                        null
                    ]
                },
                {
                    "year": 2014,
                    "overdraft_balances": [
                        null,
                        null,
                        null,
                        null,
                        null,
                        null,
                        null,
                        null,
                        null,
                        null,
                        null,
                        null
                    ]
                }
            ],
            "comments": []
        }
    ],
    "public_records": [
        {
            "public_record_id": "1b83a234-65f3-11e8-8a5e-cfb8cf94e440",
            "public_record_type": "OTHER",
            "public_record_status": "SATISFIED",
            "amount": "13442",
            "court_name": "ABERDARE",
            "case_number": "XX123456",
            "date_satisfied": "2014-08-01",
            "original_currency": "GBP",
            "comments": [
                "courtCode: 001",
                "oldCaseNumber: YY123456"
            ]
        }
    ],
    "frauds": [],
    "other_assets": [
        {
            "other_asset_id": "1b83c942-65f3-11e8-8a5e-cfb8cf94e440",
            "other_asset_type": "PROPERTY",
            "start_value": "75859",
            "date_started": "2007-01-01",
            "date_ended": "2007-12-31",
            "date_updated": "2007-01-15",
            "original_currency": "GBP"
        },
        {
            "other_asset_id": "1b83c941-65f3-11e8-8a5e-cfb8cf94e440",
            "other_asset_type": "PROPERTY",
            "start_value": "122440",
            "date_started": "2007-01-01",
            "date_ended": "2007-12-31",
            "date_updated": "2007-01-15",
            "original_currency": "GBP"
        },
        {
            "other_asset_id": "1b83c940-65f3-11e8-8a5e-cfb8cf94e440",
            "other_asset_type": "PROPERTY",
            "start_value": "150388",
            "date_started": "2007-01-01",
            "date_ended": "2007-12-31",
            "date_updated": "2007-01-15",
            "original_currency": "GBP"
        }
    ],
    "collections": [],
    "nonsufficient_funds": [],
    "disputes": [],
    "notices": [],
    "metrics": [
        {
            "metric_name": "RATIO_CREDIT_UTILIZATION",
            "metric_source": "NOVA",
            "metric_status": "AVAILABLE",
            "metric_value": 0.6383280757097792,
            "metric_label": "Credit Utilization Ratio",
            "metric_format": "NUMERIC",
            "metric_type": "RATIO"
        },
        {
            "metric_name": "RATIO_ON_TIME_PAYMENTS",
            "metric_source": "NOVA",
            "metric_status": "AVAILABLE",
            "metric_value": 0.9553903345724907,
            "metric_label": "On Time Payment Ratio",
            "metric_format": "NUMERIC",
            "metric_type": "RATIO"
        },
        {
            "metric_name": "COUNT_INQUIRIES_LAST_TWELVE_MONTHS",
            "metric_source": "NOVA",
            "metric_status": "AVAILABLE",
            "metric_value": 0,
            "metric_label": "Inquiries Last 12 Months",
            "metric_format": "NUMERIC",
            "metric_type": "INTEGER"
        },
        {
            "metric_name": "TOTAL_MONTHLY_INSTALLMENTS",
            "metric_source": "NOVA",
            "metric_status": "AVAILABLE",
            "metric_value": 341,
            "metric_label": "Total Monthly Installments",
            "metric_format": "NUMERIC",
            "metric_type": "CURRENCY"
        }
    ]
}

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 (V1) is not receiving updates and does not support the latest features and recently released credit bureaus for the Nova Credit Passport. See details here.

Changelog History

April 2024

• Changed score_version from "Only applies if score_type is NOVA_SCORE_BETA" to "Only applies if score_type is not FOREIGN_SCORE"

February 2021

• Changed Australian Medicare Card valid to date to 04-2051 for Default (Low Risk) User and 05-2051 for Medium Risk user.

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

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

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 to have a more recent birth year

December 2019

• Added a new KOR_NICE sandbox user and updated other sandbox users' birthdays and phone numbers

November 2019

• Added history property to the webhook body

October 2019

• Added linked_entries as a possible field to the collections, disputes, frauds, and nonsufficient_funds nodes
• Updated JSON responses and PDF reports for CAN_EFX sandbox users to incorporate more improvements in assessing accurate credit risk

September 2019

• Updated inquiries nodes to only return hard inquiries (only inquiries with is_credit_seeking as true will be returned)
• Updated tradeline_subtype table with new value CASH_ADVANCE
• Updated identifier_type table with new values BVN and CPF
• Updated KOR_NICE as a supported bureau for bank_accounts node
• Added translated_institution as a possible field to the bank_accounts node
• Removed OTHER from the values of the responsibility field
• Updated metric_name table with new label ("Delinquent Tradelines" => "Tradelines Ever Delinquent") for COUNT_TRADELINES_DELINQUENT
• 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

• Updated adverse_action_codes table for MEX_CDC and AUS_EFX
• Updated CAN_TU as a supported bureau for disputes and frauds nodes
• 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

June 2019

• Added translated_institution as a possible field to the tradelines node
• Added translated_company_name as a possible field to the inquiries node
• Added AUTHORIZED_USER as a possible value for the responsibility field in the tradelines node
• Added is_credit_seeking as a possible field to the inquiries node. Reports generated prior to June 18, 2019 will not contain this field

July 2018

• Added bureau_report_id to the meta node

June 2018

• Updated the invite endpoint to accept an array called enabledPrefills, so invites sent via the endpoint can be prefilled for applicants. Learn more