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's API is to have your customers use NovaConnect, an easy-to-use and secure JavaScript module. Visit our Quickstart guide for all details on how to get Nova API credentials and integrate NovaConnect into your app or website today.

Framework and Protocol

The Nova 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 the /connect/passport/v1/pdf which returns a pdf.

Endpoints

Our API host is:

• api.neednova.com

Our resource URL patterns are:

• /connect/accesstoken
• /connect/passport/v1/json
• /connect/passport/v1/pdf

We highly recommend you switch to our latest version, v2! Read the docs and see what's different here.

Country Specifics

Response Information by Country

Each foreign bureau that Nova works with differs slightly in terms of the information they return. Nova will provide all information that's returned from the foreign bureau and will ensure it's delivered in a compliant manner. As such, certain information will be removed from the report. Such information includes, but is not limited to:

• Any specific reference to the applicant's race, sex, age, national origin, or marital status, or any other class protected under the Equal Credit Opportunity Act (ECOA)
• Any tradeline or inquiry information that is older than seven years, per the Fair Credit Reporting Act (FCRA)

Unique Parameters

Data Returned	Australia Equifax (AUS_EFX)	Canada Transunion (CAN_TU)	Canada Equifax (CAN_EFX)	Great Britain Equifax (GBR_EFX)	India Crif High Mark (IND_CHM)	Mexico Circulo de Credito (MEX_CDC)
Applicant's personal details	✓	✓	✓	✓	✓	✓
Applicant's credit score	✓	✓	✓	✓	✓	✓
Traditional tradeline information*	✓	✓	✓	✓	✓	✓
Payment history information	✓	✓	✓	✓	✓	✓
Credit inquiry history	✓	✓	✓	✓	✓	✓
Adverse action codes	✓	✓	✓	✗	✗	✓
Past employment history	✓	✓	✓	✗	✗	✓
Positive reporting**	✗	✓	✓	✓	✓	✓
Negative reporting***	✓	✓	✓	✓	✓	✓

*Traditional tradeline information consists of everything but historical information of the individual tradeline attributes. Items include, among others, high balance, credit limit, status and date opened.

**Positive reporting refers to reports that contain a record of successful payments made. Negative reporting refers to payments that were missed or late. Some countries are limited in their ability to return positive reporting data and only return negative data.

***This bureau collects information about negative delinquency records and other negative behavior, but may have limited or no positive payment history information.

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.

Australia Equifax (AUS_EFX)

Inputs	Default User
First name	Samantha
Last name	O'Connor
Date of birth	30-03-1991
Email address	samantha@email.com
Gender	Female
Street address	10 Seahorse Court
Suburb	Indented Head
State	Victoria
Postcode	3223
Australian driver's license State of issue	Victoria
Australian driver's license License number	98056840
Australian passport Passport number	PA0000128

Canada Transunion (CAN_TU)

Inputs	Default User	User 2 (delinquent)	User 3
First name	Olivia	Fernando	John
Last name	Tremblay	Isabell	Fence
Email	olivia@email.com	fernando@email.com	john@email.com
Date of birth	25-04-1973	04-05-1955	11-10-1920
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/5	180 HOLIDAY INN DRIVE	NEWFOUNDLAND	ONTARIO
Question 2/5	225 MYSTERY LAKE RD	NONE OF THE ABOVE	408 SCOOBY RD
Question 3/5	10199 101 STREET NW	208 EMBARCADERO S	154 COVINGTON NW
Question 4/5	1709 BLOOR STREET WEST	458 KING AVE	1441 MAZARINE WEST
Question 5/5	BRITISH COLUMBIA	50124 UNION ST	NONE OF THE ABOVE

Canada Equifax (CAN_EFX)

Inputs	Default User	User 2	User 3
First name	Emma	Allen	Chris
Last name	Smith	Mikey	Jerrold
Email	emma@email.com	allen@email.com	chris@email.com
Date of birth	25-10-1989	16-12-1967	11-01-1954
SIN	111222333
Address	1966 Eglinton Avenue West	10520 111 Avenue Northwest	2320 16 Avenue Northwest
City	Toronto	Edmonton	Calgary
Province	Ontario (ON)	Alberta (AB)	Alberta (AB)
Postal code	M6E 2J9	T5G 0B6	T2N 4H8
Question 1/3 (mortage loan)	None of the above	$3,000 - $3,800	Chartwell Road
Question 2/3 (range of payment)	$275 - $374	2004	$7,000 - $10,000
Question 3/3 (SIN last digits)	4286	8888	0231

Great Britain Equifax (GBR_EFX)

Inputs	Default User	User 2	User 3
First name	David	Nathan	Allie
Last name	Jones	Smith	Gretchen
Email	david@email.com	nathan@email.com	allie@email.com
Date of birth	25-10-1989	04-01-1988	30-12-1987
Street address	177 Brompton Road	310 Kensington	101 The Horsefair
Post town	London	Liverpool	Bristol
Post code	SW31NF	L7 2RN	BS1 3JR
Question 1/3 (mobile phone/cable)	O2	Barclays	Barclays
Question 2/3 (current account opened)	G E Capital (House of Fraser)	£ 700 - £ 800	£ 400 - £ 500
Question 3/3 (overdraft limit)	£ 2500 to £ 2999	£ 2500 to £ 2999	£ 50 - £ 100

India Crif High Mark (IND_CHM)

Inputs	Default User	User 2	User 3
First name	Raj	Diya	Sona
Last name	Du	Puja	Arati
Date of birth	25-10-1989	06-02-1976	11-10-1966
Father's last name	Du	Puja	Arati
Indian phone number	2233334444	1234567892	2580066232
Email address	rajdu@email.com	diya@email.com	sona@email.com
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	400047
PAN number	ADISA8123J	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

Mexico Circulo de Credito (MEX_CDC)

Inputs	Default User	User 2	User 3
First name	Juan	Xavier	Alexis
Mother's last name	Gonzales	Barrios	Quipa
Date of birth	25-10-1989	12-12-1972	03-06-1982
Father's last name	Garcia	Jose	Elena
Email address	juan@email.com	xavier@email.com	alexis@email.com
Street address	357 Avenida Insurgentes Sur	2 Calle James Sullivan	1 Miguel Laurent
City	Ciudad de México	Ciudad de México	Ciudad de México
Neighborhood/Borough	Hipódromo	San Rafael	Tlacoquemecatl del Valle
Zipcode	06100	06470	03200
State	Ciudad de México (CDMX)	Ciudad de México (CDMX)	Ciudad de México (CDMX)
Have you ever had a credit card in Mexico?	Yes	Yes	No
Provide the last 4 digits of any of your Mexican credit cards	0000	4827
Have you ever had an auto load in Mexico?	Yes	Yes	No
Have you ever had a mortage in México?	No	No	Yes

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.

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

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.

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	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) RFC 3986z
Short Version	(String) Version number is predicated with "V" e.g. "V1" or "V2". 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

Webhook

The webhook will be called with the following format: { status: 'SUCCESS', publicToken: '6b986690-458b-11e7-98fb-a71570ea65a6', userArgs: '235234224' } The Nova Credit webhook will provide one of the following status messages:

Text	Description
SUCCESS	The applicant has been found in the database overseas. A Nova Credit Passport™ has been generated which you can retrieve with the public_token in the body of this request.
NOT_FOUND	The applicant could not be found in the database overseas. There is no Nova Credit Passport™ to retrieve
NOT_AUTHENTICATED	The applicant was found but could not be authenticated. There is no Nova Credit Passport™ to retrieve
ERROR	An internal error occurred and the Nova Credit Passport™ could not be compiled. Please send a message to support@neednova.com with the public_token.

(1) For Nova to inform you that a credit file is ready for pick-up we call a webhook that you provide. The POST call we make contains a status code in its JSON body. For more information visit the server integration section in our NovaConnect Quickstart guide.

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. Such items include:

• 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]

Passport™ Body

meta {}

Example meta response:

{
  "meta": {
  "public_token": "ff0886a4-f3ff-11e6-bc64-92361f002671",
  "pdf_name": "raj_du_92361f002671",
  "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",
  "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
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	See Table 1. country
country_destination	ISO 3166-1 alpha-3	See Table 1. country
company_code	String	See Table 2. company
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

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
middle_name	String
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

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_id	UUID
inquiry_type	String	See Table 3. inquiry_type

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 Table 4. currency_source
date	Full Date or Short Date	The date at which the conversion occurred

scores []

Example scores response:
{
  "scores": [{
      "score_type": "NOVA_SCORE_BETA",
      "score_version": "1.0.5",
      "value": 798,
      "risk_indicator": "MEDIUM_RISK",
      "prob_default": 3.12
    },
    {
      "score_type": "FOREIGN_SCORE",
      "value": "992",
      "risk_indicator": "LOW_RISK",
      "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 Table 5. score_type
score_version	Full version	Only applies if score_type is NOVA_SCORE_BETA
value	Integer OR String	Value of the score. Integer if type NOVA_SCORE_BETA, string otherwise.
risk_indicator	String	See Table 6. risk_indicator
prob_default	Percentage
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 Table 7. adverse_action_codes
description	String

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",
    "account_number": "345974563420587453",
    "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.

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

Field	Format	Notes
tradeline_id	UUID	Reference ID of the tradeline
institution	String	Name of the lending institution
telephone	String
address	String	The entire address of the lending institution 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 Table 8. 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
worst_arrears_amount	Full Date or Short Date
date_last_balance_zero	Full Date or Short Date
past_due_balance	Integer
number_payments_since_open	Integer
tradeline_type	String	See Table 9. tradeline_type
tradeline_subtype	String	See Table 24. tradeline_subtype
tradeline_status	String	See Table 10. tradeline_status
tradeline_substatus	String	See Table 25. tradeline_substatus
responsibility	String	See Table 11. responsibility
collateralized	Bool
tradeline_open	Bool
settlement_amount	Integer
written_off_amount	Integer
account_number	String
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

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 (years).

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 Table 12. 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 Table 15. bank_account_type
bank_account_subtype	String	See Table 15a. bank_account_subtype
bank_account_status	String	See Table 16. 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
institution_phone	String
creditor_industry	String
responsibility	String	See Table 11. 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

	Canada Transunion (CAN_TU)	Canada Equifax (CAN_EFX)	Great Britain Equifax (GBR_EFX)	India Crif High Mark (IND_CHM)	Mexico Circulo de Credito (MEX_CDC)	Australia Equifax (AUS_EFX)
bank_accounts	✓	✓	✓	✗	✗	✗

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	Balances 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 balance was reported, hence Nova defaults to counting from the end of the month onward.
BI_MONTHLY (every two months)	Balances 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 balance was reported, hence Nova defaults to counting from the end of the two months onward.
WEEKLY	Balances array length equal to 52. The first element is the last week of the year. Nova cannot distinguish where in that month the balance was reported, hence Nova defaults to counting from the end of the week.
QUARTERLY	Balances 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 balance was reported, hence Nova defaults to counting from the end of the quarter 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 Table 17. 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
comments	Array	See comments

Supported Bureaus

	Canada Transunion (CAN_TU)	Canada Equifax (CAN_EFX)	Great Britain Equifax (GBR_EFX)	India Crif High Mark (IND_CHM)	Mexico Circulo de Credito (MEX_CDC)	Australia Equifax (AUS_EFX)
other_assets	✓	✗	✓	✗	✗	✗

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 Table 18. public_record_type
public_record_status	String	See Table 19. public_record_status
amount	Integer
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 Table 18. 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
original_currency	ISO 4217
comments	Array	See comments

Supported Bureaus

	Canada Transunion (CAN_TU)	Canada Equifax (CAN_EFX)	Great Britain Equifax (GBR_EFX)	India Crif High Mark (IND_CHM)	Mexico Circulo de Credito (MEX_CDC)	Australia Equifax (AUS_EFX)
public_records	✓	✓	✓	✗	✗	✓

frauds []

Example response from the frauds array:
{
  "frauds": [{
    "fraud_id": "03b93250-d48f-11e7-88ec-19158430af0e",
    "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": [ ... ]
  }],
}

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

Supported Bureaus

	Canada Transunion (CAN_TU)	Canada Equifax (CAN_EFX)	Great Britain Equifax (GBR_EFX)	India Crif High Mark (IND_CHM)	Mexico Circulo de Credito (MEX_CDC)	Australia Equifax (AUS_EFX)
frauds	✗	✓	✓	✗	✗	✗

collections []

Example response from the collections array:
{
  "collections": [{
    "collection_id": "be8955a0-d490-11e7-96f4-cf5a894bdd5d",
    "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": [ ... ]
  }]
}

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 Table 20. 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
balance_amount	Integer
date_assigned	Full Date or Short Date
date_paid_off	Full Date or Short Date
date_last_payment	Full Date or Short Date
original_currency	ISO 4217
comments	Array	See comments

Supported Bureaus

	Canada Transunion (CAN_TU)	Canada Equifax (CAN_EFX)	Great Britain Equifax (GBR_EFX)	India Crif High Mark (IND_CHM)	Mexico Circulo de Credito (MEX_CDC)	Australia Equifax (AUS_EFX)
collections	✓	✓	✗	✗	✗	✓

nonsufficient_funds []

Example response from the nonsufficient funds array:
{
  "nonsufficient_funds": [{
    "nonsufficient_fund_id": "be8955a0-d490-11e7-96f4-cf5a894bdd5d",
    "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": [ ... ]
  }]
}

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

Supported Bureaus

	Canada Transunion (CAN_TU)	Canada Equifax (CAN_EFX)	Great Britain Equifax (GBR_EFX)	India Crif High Mark (IND_CHM)	Mexico Circulo de Credito (MEX_CDC)	Australia Equifax (AUS_EFX)
nonsufficient_funds	✗	✓	✓	✗	✗	✗

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"
    },
    {
      "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"
    }
  ],
  ...
}

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

Field	Format	Notes
inquiry_id	UUID	Reference ID of the inquiry
inquiry_type	String	See Table 3. inquiry_type
inquiry_subtype	String	See Table 26. 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
telephone1	String
address	String	The entire address of the lending institution if it was returned in one blob
street1	String
street2	String
neighborhood	String
district	String
country	String
city	String
zipcode	String
state	String

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
telephone	String
address	String
street	String
neighborhood	String
district	String
city	String
zipcode	String
state	String
annual_salary	Integer
date_reported	Full Date or Short Date
date_started	Full Date or Short Date
date_terminated	Full Date or Short Date

Supported Bureaus

	Canada Transunion (CAN_TU)	Canada Equifax (CAN_EFX)	Great Britain Equifax (GBR_EFX)	India Crif High Mark (IND_CHM)	Mexico Circulo de Credito (MEX_CDC)	Australia Equifax (AUS_EFX)
employers	✓	✓	✗	✗	✓	✓

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 Table 13. 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 Table 14. identifier_type
issuer_country	ISO 3166-1 alpha-3
date_issued	Full Date
date_expired	Full 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 Table 21. other_income_frequency
income_source	String	Description of the employment
original_currency	ISO 4217

Supported Bureaus

	Canada Transunion (CAN_TU)	Canada Equifax (CAN_EFX)	Great Britain Equifax (GBR_EFX)	India Crif High Mark (IND_CHM)	Mexico Circulo de Credito (MEX_CDC)	Australia Equifax (AUS_EFX)
other_incomes	✗	✓	✗	✗	✗	✗

disputes []

Example response from the disputes array:
{
  "disputes": [{
    "dispute_id": "03b93250-d48f-11e7-88ec-19158430af0e",
    "dispute_type": "DISPUTE",
    "date_reported": "2016-12-12",
    "statement": "This data has been disputed by the individual concerned.",
  }],
}

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 Table 22. dispute_type
date_reported	Full date
statement	String	Full description of the dispute

Supported Bureaus

	Canada Transunion (CAN_TU)	Canada Equifax (CAN_EFX)	Great Britain Equifax (GBR_EFX)	India Crif High Mark (IND_CHM)	Mexico Circulo de Credito (MEX_CDC)	Australia Equifax (AUS_EFX)
disputes	✗	✗	✓	✗	✗	✓

notices []

Example response from the notices array:
{
  "notices": [{
    "notice_id": "03b93250-d48f-11e7-88ec-19158430af0e",
    "notice_type": "BUREAU COMMENT",
    "date_reported": "2016-12-12",
    "date_to_be_purged": "2022-12-12",
    "notifier_phone": "604-286-3651",
    "statement": "Successful inquiry by other SIC",
    "comments": [ ... ],
  }],
}

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 Table 23. notice_type
date_reported	Full date
date_to_be_purged	Full date	Date the notice should be removed from the credit report
notifier_phone	String
statement	String	Full description of the notice
comments	Array	See comments

Supported Bureaus

	Canada Transunion (CAN_TU)	Canada Equifax (CAN_EFX)	Great Britain Equifax (GBR_EFX)	India Crif High Mark (IND_CHM)	Mexico Circulo de Credito (MEX_CDC)	Australia Equifax (AUS_EFX)
notices	✓	✓	✗	✓	✓	✓

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.

metrics []

Example of two 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_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_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.

By default, four metrics are included in every response: RATIO_CREDIT_UTILIZATION, RATIO_ON_TIME_PAYMENTS, COUNT_INQUIRIES_LAST_TWELVE_MONTHS, and TOTAL_MONTHLY_INSTALLMENTS. You can remove these metrics or add additional metrics to your reports by contacting your Nova Representative.

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 Table 27. metric_name
metric_value	Number	Value of the metric
metric_status	String	See Table 28. metric_status
metric_source	String	See Table 29. metric_source
metric_label	String	See Table 30. metric_label
metric_type	String	See Table 31. metric_type

Tables

Table 1. country

Values of the country field.

Value	Description
CAN	Canada
GBR	Great Britain
IND	India
MEX	Mexico
AUS	Australia

Table 2. 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
MEX_CDC	Mexico Círculo de Crédito
AUS_EFX	Australia Equifax

Table 3. inquiry_type

Values of the inquiry_type field. An inquiry_type is a value set within the Nova Dashboard when creating a product. Please refer to the Product reference in the Quickstart Guide.

inquiry_type is also 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 2/21/18 may contain deprecated values. New reports generated after 2/21/18 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

Table 4. currency_source

Values of the currency_source field.

Value	Description
ECB	European Central Bank
OER	Open Exchange Rates

Table 5. score_type

Values of the score_type field.

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

Table 6. 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

Table 7. adverse_action_codes

Values of the adverse_action_codes field. adverse_action_codes are only returned from CAN_EFX and CDC.

Canada Transunion (CAN_TU)

Value	Description
0	This verbiage is blank
1	Balance increase on credit card account
2	Balance increase on non-mortgage account
3	Balance increase on revolving account
4	Balance on account
5	Balance on bank installment account
6	Balance on credit card account
7	Balance on mortgage accounts
8	Balance on non-mortgage account
9	Balance on open credit card account
10	Balance on open mortgage account
11	Balance on open retail account
12	Balance on revolving account
13	Insufficient credit experience
14	Insufficient mortgage experience
15	Mortgage account opened in last 12 months
16	No account updated in past 12 months
17	No account updated in past 24 months
18	No account updated in past 3 months
19	No bank installment account
20	No bank installment account updated in past 12 months
21	No bank revolving account
22	No credit card account
23	No credit card account updated in past 12 months
24	No credit card or no activity on credit card in past 6 months
25	No mortgage account updated in past 12 months
26	No non-mortgage account
27	No open account
28	No open bank installment account
29	No open credit card account
30	No open mortgage account
31	No open retail account
32	No open revolving account
33	No retail account
34	No retail account updated in past 12 months
35	No revolving account
36	No revolving account recently updated
37	Presence of balance on credit card account in past 12 months
38	Presence of balance on credit card account in past 3 months
39	Presence of balance on credit card accounts
40	Presence of balance on open revolving accounts
41	Presence of balance on retail account
42	Presence of bankruptcy
43	Presence of bankruptcy, delinquency, or derogatory item
44	Presence of collection record
45	Presence of delinquency or derogatory item
46	Presence of inquiry
47	Presence of judgement
48	Presence non-discharged bankruptcy or consumer proposal
49	Presence of consumer proposal
50	Presence of public record
51	Presence of recently opened account
52	Presence of unsatisfactory open accounts
53	Recently opened account
54	Recently opened credit card account
55	Over limit on credit card account

Canada Equifax (CAN_EFX)

Value	Description
1	Average of Months Open on All Trades
2	Number of Trades Currently 90+ DPD
3	Number of Trades 60+DPD within the Last 2 Years
4	Number of Trades Ever 90+DPD Opened within Last 2 Years
5	Number of Rate 1 Trades on File
6	Number of Open Trades
7	Number of Trades with Amount Past Due
8	Number of Trades on File
9	Age of Oldest Trade
10	Percent of Rate 1 Trades to Total Trades on File
11	Worst Current Rate
12	Worst Rate Ever on All Trades
13	Number of Auto Finance Trades on File
14	Rate 1 on Open Auto Finance Trades
15	Number of Auto Finance Inquiries on File
16	Number of Bank Instalment Trades on File
17	Rate 1 on Open Bank Instalment Trades
18	Balance to High Credit on Bank Instalment Trades
19	Worst Current Rate on Bank Instalment Trades
20	Worst Rate Ever on Bank Instalment Trades
21	Number of Bank Inquiries on File
22	Number of Bank Revolving Trades on File
23	Number of Bank Revolving Trades Older than 6 Months
24	Age of Oldest Bank Revolving Trade
25	Rate 1 on Open Bank Revolving Trades
26	Balance to High Credit on Bank Revolving Trades
27	Worst Current Rate on Bank Revolving Trades
28	Worst Rate Ever on Bank Revolving Trades
29	Number of Collection Inquiries on File
30	Months Since Most Recent Collection Inquiry
31	Total Balance on Third Party Collection Items
32	Number of Third Party Collection Items within the Last 3 Years
33	Rate 1 on Open Credit Union Trades
34	Number of Finance Instalment Trades on File
35	Rate 1 on Open Finance Instalment Trades
36	Balance to High Credit on Finance Instalment Trades
37	Number of Personal Finance Inquiries in the Last Year
38	Number of Personal Finance Inquiries on File
39	Number of Finance Revolving Trades on File
40	Balance to High Credit on Finance Revolving Trades
41	Worst Rate Ever on Instalment Trades
42	Number of National Credit Cards Inquiries on File
43	Average of Months Open on National Credit Cards
44	Balance on National Credit Cards
45	Number of National Credit Card Trades Open
46	Rate 1 on Open National Credit Card Trades
47	Number of National Credit Card Trades with Utilization >= 75% of High Credit
48	Number of National Credit Card Trades with Utilization 75-99% of High Credit
49	Number of National Credit Card Trades with Utilization >= 99% of High Credit
50	Balance to High Credit on National Credit Cards
51	Balance to High Credit on National Credit Cards Opened in the Last 6 Months
52	Worst Current Rate on National Card Trades
53	Worst Rate Ever on National Card Trades
54	Number of Other Inquiries on File
55	Months Since Most Recent Public Record
56	Number of Public Records within the Last Year
57	Number of Public Records within the Last 3 Years
58	Balance to High Credit on Personal Finance Trades
59	Number of Revolving Trades with Balance > 0
60	Number of Open Revolving Trades with No Balance
61	Age of Oldest Revolving Trade
62	Number of Revolving Trades with Utilization 75-99% of High Credit
63	Number of Revolving Trades with Utilization >= 99% of High Credit
64	Balance to High Credit on Revolving Trades
65	Balance to High Credit on Revolving Trades Opened within the Last 6 Months
66	Number of Retail Trades with Balance > 0
67	Balance to High Credit on Retail Trades
68	Balance to High Credit on Sales Finance Trades
69	Worst Current Rate on Sales Finance Trades
70	Number of Telco Inquiries in the Last Year
71	Number of Telco Inquiries on File
72	Number of Inquiries on File in the Last Year
73	Number of Auto Finance, Sales Finance, National Cards or Other Inquiries within Last Year
74	Number of Inquiries in the Last 3 Months
75	Number of Inquiries on File
76	Number of Auto Finance, Sales Finance, National Cards or Other Inquiries on File
77	Months Since Most Recent Inquiry
78	Number of Revolving Trades with Utilization >= 75% of High Credit
S	ERS not available, File cannot be scored
F	ERS not available, File under review
D	ERS not available, Subject deceased
I	ERS not available, no recent activity
Q	ERS not available, no qualifying Accounts present
92	Clean, Mature and Very Thick
93	Clean, Mature and Thick
94	Clean and Thick
95	Clean and Thin
96	Prior Delinquency Thick
97	Prior Delinquency Thin
98	Delinquent Thick
99	Delinquent Thin

Mexico Círculo de Crédito (MEX_CDC)

Value	Description
A0	Payment history of the account is too new
A1	Latest report from the account in arrears status
A2	Amount of credit available in revolving accounts
A3	Amount of debt accounts is too high
A4	Amount of debt in the bank national in revolving accounts
A5	Amount of debt ranked in billing
A6	Amount of debt arrears accounts
A7	Amount of debt in accounts recently opened is too high
A8	Amount of debt in revolving accounts recently open of bank national is very high
A9	Amount of debt in accounts recently opened in finance companies to consumer is too high
B0	Amount of debt in accounts recently opened in retail is too high
B1	Amount of debt in revolving accounts recently opened is too high
B2	Amount of debt accounts of financing company in open sales recently is very high
B3	Amount of debt in the accounts of retail
B4	Amount of revolving debt accounts
B5	Amount of debt revolving credit accounts is too high
B6	Amounts overdue accounts
D0	Reported bankruptcy
D1	Date last very recent consultation
D2	Arrears on accounts
D3	Arrears in recently opened accounts
D4	Elimination of public record or collection reported
D5	The frequency of late payments
D6	Level of delinquency on accounts
D7	serious arrears
D8	Serious arrears and public record or collection reported
D9	Serious arrears, public record deleted, or collections reported
E0	Demographic Information
E1	Foul demographic information
E2	Number of consultations
E3	Frequency of consultations
E4	Lack of recent account information
E5	Amount of debt in the public records eliminated
E6	Proportion of blaance of limit accounts
F0	Available Payment history is insufficient
F1	Lack of credit accounts recently created
F2	Lack of revolving accounts recently created
F3	Lack of recent self-financing loan information
F4	Lack of recent auto loan information
F5	Lack of recent information from bank national revolving
F6	Lack of recent information information on accounts of consumer finance companies
F7	Lack of recent loan information
F8	Lack of recent information on mortgage loans
F9	Lack of recent information of non-mortgage loans
G0	Lack of recent retail account information
G1	Lack of recent revolving account information
G2	No mortgages reported
G3	No information revolving balances Latest Banks National
G4	No information of recent non-mortgage balances
G5	No retail account balances
G6	No recent revolving balances
J0	Time Duration of accounts have been established
J1	Time Duration of car accounts have been established
J2	Time Duration of revolving bank accounts nationals have established
J3	Time Duration of the loans of consumer finance companies have been established
J4	Time Duration of the installment loans have been established
J5	Duration Time of the reported mortgage accounts have been established
J6	Time Duration of the open installment loans have been laid
J7	Time Duration of the retailers accounts have been established
J8	Time Duration of the revolving accounts have been established
J9	Time since account activity is too long
K0	Time since arrears is too recent or unknown
K1	Time elapsed since the elimination of the public record or collection is too short
K2	Time since most recent account opening is too short
K3	Time since the most recent automatic account opening is too short
K4	Time elapsed since the opening of revolving account bank national most recent is too short
K5	Time elapsed since the opening account of consumer finance companies latest is too short
K6	Time elapsed since the opening of loan account to most recent deadlines is too short
K7	Time elapsed since account opening retail most recent.
K8	Time elapsed since the most recent revolving account opened
K9	Very little time has elapsed since the most recent account opened of 'sales finance'
M0	It has a number of accounts currently in default
M1	Number of 'marked' unpaid accounts
M2	Number of accounts with unpaid recent
M3	Number of active revolving accounts bank national
M4	Number of active accounts 'retail'
M5	Number of adverse repealed public records
M6	Number of revolving accounts bank national with balances
M7	Number of revolving accounts bank national
M8	Number of revolving accounts or other revolving accounts bank national
M9	Number of registered collections
N0	Number of accounts 'consumerfinancecompany ' set on the length of the history of consumer
N1	Number of consultations by consumer finance companies
N2	Number of established accounts
N3	Number of 'open installment loans '
N4	Number of recently opened accounts with consumer finance companies
N5	Number of accounts 'retail'
N6	Number of accounts 'retail' with balance
N7	Number of revolving accounts
N8	ber of revolving accounts with balances higher than its limit
P0	The proportion of the balance vs. limit auto loan accounts is too high
P1	The proportion of the balance vs. limit on accounts in arrears is very high
P2	The proportion of the balance vs. limit on consumer finance accounts is too high
P3	The proportion of the balance vs. limit on the accounts of 'retail' is very high
P5	The proportion of the balance vs. credit limit on national revolving accounts or other revolving accounts is very high
P6	The proportion of the balance vs. credit limits on revolving accounts is too high
P7	The proportion of the balance vs. limit 'financecompany sales' is very high
P8	The proportion of the balance vs. the mortgage loan is very high
P9	The proportion of loan balance vs the loan amount is very high
Q0	The proportion of revolving balances vs total balances is very high
Q1	The proportion of balances vs to credit limits of revolving accounts bank national is too high
R0	Very few accounts have been paid as agreed
R1	Very few accounts with balances
R2	Very few accounts with recent payment information
R3	Very few active accounts
R4	Very few revolving accounts bank national
R5	Very few revolving accounts bank national with recent payment information
R6	Very few accounts with consumer finance companies with recent payment information
R7	Very few accounts of 'installment '
R8	Very few accounts of 'retail '
R9	Very few accounts of 'retail' with recent payment information
S0	Very few revolving accounts
S1	Very few revolving accounts with recent payment information
S2	Very few accounts of 'financecompany sales' with recent payment information
T0	Many accounts opened recently
T1	Many accounts with balances
T2	Many revolving accounts bank national
T3	Many accounts of consumer finance companies
T4	Many accounts of 'installment '
T5	Many queries in the past 12 months
T6	Many active accounts recently
T7	Many car accounts recently active
T8	Many revolving accounts bank national recently active
T9	Many accounts of consumer finance companies recently active
U0	Many accounts of 'installment loan' recently active
U1	Many accounts of 'retail' recently active
U2	Many accounts 'financecompany sales' recently active
U4	Many recently opened accounts with balances
U5	Many revolving accounts banknational newly opened
U6	Many accounts of consumer finance companies recently opened
U7	Many accounts of 'installment' recently opened
U8	Many accounts of 'retail' recently opened with balances
U9	Many recently opened revolving accounts
V0	Many recently opened revolving accounts with balances
V1	Many accounts 'financecompany sales' recently opened
V2	Many accounts of 'retail'
V3	Many revolving accounts
V4	Many revolving accounts bank national recently active with balances
W3	Number of accounts 'subprime'
W4	Lack of recent information to card charge
W5	No balances to card charge recently
W6	The proportion of the balance vs credit limits on accounts 'charge cards' is very high
W7	Without balances of recent account.
W8	The proportion of 'Cash Advances' vs. 'Cash Advance Limit' is very high
W9	Cash Advance Activity on Accounts
X0	Pending payments on accounts
C1	There is no record
C2	The record found without accounts
C3	The record found is marked as deceased
C4	The record found has no active accounts in the last 24 months
C5	The file is marked as fraudulent or suspect fraud
SC	Score could not be calculated

Table 8. credit_type

Values of the credit_type field.

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

Table 9. 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 2/21/18 may contain deprecated values. New reports generated after 2/21/18 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

Table 10. 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 2/21/18 may contain deprecated values. New reports generated after 2/21/18 will not contain deprecated values.

Value	tradeline_open	Description
ACTIVE	True	Active and nothing past due
CLOSED	False	The tradeline has been closed
DEFAULT_WRITEOFF	False	The applicant refused to make payments and defaulted or the tradeline was written off by the credit grantor (collections unsuccessful)
DISPUTED	False	The tradeline's status is in dispute by the consumer
INACTIVE	False	The tradeline is open but 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	True	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
SUIT		Deprecated
WRITTEN_OFF		Deprecated
DEFAULT		Deprecated

Table 11. responsibility

Values of the responsibility field.

Value	Description
INDIVIDUAL	The individual is solely responsible for the tradeline
JOINT	The individual is jointly responsible
OTHER
JOINT_OBLIGATOR	Deprecated

Table 12. 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

Table 13. 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

Table 14. 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	Any type of vehicle
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
OTHER

Table 15. bank_account_type

Values of the bank_account_type field.

Value	Description
CHECKING	Checking account
SAVINGS	Savings account
OTHER

Table 15a. bank_account_subtype

Values of the bank_account_subtype field.

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

Table 16. 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

Table 17. other_asset_type

Values of the other_asset_type field.

Value	Description
PROPERTY	Property asset
OTHER

Table 18. 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
OTHER

Table 19. 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
DISPUTED	The public record was disputed
OTHER

Table 20. 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

Table 21. other_income_frequency

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

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

Table 22. 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

Table 23. 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

Table 24. 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.

Table 25. 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.

Table 26. inquiry_subtype

Values of the inquiry_subtype field. An inquiry_subtype is a value set within the Nova Dashboard when creating a product and provides more detail to the inquiry_type field. Please refer to the Product reference in the Quickstart Guide.

inquiry_subtype is also 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

Table 27. metric_name

Values of the metric_name field. To configure the set of metrics provided in your API response, contact your Nova Representative.

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 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_PAST_DUE_CURRENTLY_OVER_30_DAYS	Current Payments 30 Days Past Due
COUNT_TRADELINES_PAST_DUE_CURRENTLY_OVER_60_DAYS	Current Payments 60 Days Past Due
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

Table 28. 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
UNAVAILABLE_BUREAU	Metric is unavailable for this report because of bureau-specific constraints

Table 29. 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

Table 30. metric_label

Values of the metric_label field. See Table 27. metric_name

Table 31. 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

Error Codes & Responses

At Nova we distinguish between two status message deliveries: 1. Delivered by Nova to the webhook¹ 2. If you call a resource endpoint Nova 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@neednova.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_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@neednova.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"
    },
    "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",
            "prob_default": 0.93,
            "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_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_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_type": "INTEGER"
        },
        {
            "metric_name": "TOTAL_MONTHLY_INSTALLMENTS",
            "metric_source": "NOVA",
            "metric_status": "AVAILABLE",
            "metric_value": 341,
            "metric_label": "Total Monthly Installments",
            "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

• We recently released V2 of our API! These changes allow you a more intuitive way to parse through tradeline history data. We recommend you update to V2 as soon as possible. See details

Changelog History

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