Connect API Reference

info

View general Nova Credit API docs

API Reference Overview

Introduction

This document provides information on how to interact with the Connect API to pull a consumers credit report and then use the Passport API to obtain a Nova Credit Passport®.

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.

Long Polling

Each Connect API /progress endpoint utilizes long polling, which keeps the request open to wait for information from the bureau or next steps that may not have been immediately available when the /progress request was initially made. The response will be returned as soon as it is available, however, if the data is still not available after 15 seconds, a 202 response will be returned. The 202 response signifies that the same /progress endpoint should be called again.

Connect API Available Countries

Australia, Austria, Brazil, Canada, Dominican Republic, Germany, Ghana, India, Kenya, Mexico, Nigeria, Philippines, South Africa, Spain, Switzerland, United Kingdom, Ukraine, United States of America

Sandbox Information

In order to test both the Connect and Passport API, Nova provides a Sandbox environment (see below). For each bureau we provide a number of test users that you can use to analyze a response.

Sandbox Mode

Sandbox Users for Credit Bureau Inputs 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
International Passport issuing country	Canada
International Passport Number	AA123456

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

Credit Reference Center of the People's Bank of China (CHN_CCRC) - In development

Inputs	Default (Low Risk) User	Medium Risk	High Risk
Name	美丽	上官云开	立修
Email	mei@email.com	shangguan@email.com	zhou@email.com
Date of birth	09-25-1989	01-02-1990	09-13-1988
CCRC report	Download file	Download file	Download file

China Chengxin Credit (CHN_CCX)

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

Great Britain Equifax (GBR_EFX)

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

India Crif High Mark (IND_CHM)

Inputs	Default (Low Risk) User	Medium Risk	High Risk
First name	Raj	Diya	Sona
Last name	Du	Puja	Arati
Date of birth	10-25-1989	02-06-1976	10-11-1966
Father's last name	Du	Puja	Arati
Email address	rajdu@email.com	diya@email.com	sona@email.com
Indian phone number	6233334444	7234567892	8580066232
Street address	2 Community Center	55 Park Street	1 Juhu Tara Road
City	New Delhi	Kolkata	Mumbai
State	Delhi (DL)	West Bengal (WB)	Maharashtra (MH)
Pincode	110017	700017	400049
PAN number	ADIPA8123J	AFUPJ7365N	AAWPH3050M
Voter ID number	AB953789734322	CC6849897356234	NMA34121422221
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

India Universal (works for both IND_CIBIL and IND_CHM)

info

Please note the following:

• If the correct security code is entered, other security questions will not be asked.
  
• A report has not yet been finalized for this user, though the user is available to test NovaConnect and the Connect API

Inputs	Default (Low Risk) User
First name	Ishaan
Last name	Mohan
Father's Last Name	Mohan
Date of birth	11-26-1992
Gender	Male
Email address	ishaan@email.com
Indian phone number	9773949726
Street address	2 3218 STREET NO 2 BALBIR NAGARSHAHDRA
City	Delhi
State	Delhi (DL)
Pincode	110009
PAN number	YEHPG0098E
Passport number	A1234567
Security code	092090
Question 1 (CIBIL)	Scb
Question 2 (CIBIL)	1500001
Question 3 (CIBIL)	147000
Question 4 (CIBIL)	Pnb Hsg
Question 5 (CIBIL)	Bajaj Fin Ltd
Question 1 (CHM)	RBL Bank
Question 2 (CHM)	New Delhi
Question 3 (CHM)	2005

Mexico Universal (works for both MEX_BDC and MEX_CDC)

info

Please note the following:

• In order to trigger a cascade with the universal user, enter an incorrect Father's last name for the user below for the first try (MEX_BDC). When NovaConnect cascades to MEX_CDC, enter the correct Father's last name along with the corresponding First name(s) value.

Inputs	Default (Low Risk) User
First name (MEX_BDC)	Lara
Second name (MEX_BDC)	del Rosario
First name(s) (MEX_CDC)	Lara del Rosario
Father's last name	Ortega
Mother's last name	Fuentes
Date of birth	05-06-1992
Email address	lara@email.com
Street name and number	Jaime Balmes #8
City	Ciudad de México
District/Town	Los Morales Polanco
Zipcode	11510
State	Ciudad de México (CDMX)
Do you have an active mortgage in Mexico?	Yes
Have you had an auto loan in the last 2 years in Mexico?	No
Do you have an active credit card in Mexico?	Yes
Provide the last 4 digits of any of your Mexican credit cards	1234

Mexico Circulo de Credito (MEX_CDC)

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

Mexico Buro de Credito (MEX_BDC)

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

Korea NICE (KOR_NICE)

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

Nigeria CRC (NGA_CRC)

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

Brazil Experian (BRA_XP)

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

Kenya Creditinfo (KEN_CI)

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

Dominican Republic TransUnion (DOM_TU)

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

ASNEF-Equifax, S.L., and Equifax Ibérica, S.L. Spain (ESP_EFX)

Inputs	Default (Low Risk) User
First name	Carlos Antonio
Last name	Fernández Soto
Date of birth	03-25-1962
Gender	Male
Email address	carlos@email.com
DNI Number	99999999R
Passport Number	9999999999999

CRIF GmbH Austria (AUT_CRIF)

Inputs	Default (Low Risk) User
First name	Sonja
Last name	Baliko
Date of birth	07-15-1968
Gender	Female
Email address	sonja@email.com
Street	Erdberger Lände 12
City	Wien
Postcode	1030
Country	Austria

CRIF AG Switzerland (CHE_CRIF)

Inputs	Default (Low Risk) User
First name	Patrick
Last name	Herrman
Date of birth	04-04-1975
Gender	Male
Email address	patrick@email.com
Street	Riva Giocondo Albertolli 1
City	Lugano
Postcode	6900
Country	Switzerland

CRIF Bürgel GmbH Germany (DEU_CRIF)

Inputs	Default (Low Risk) User
First name	Gabriele
Last name	Moench
Date of birth	07-07-1989
Gender	Female
Email address	gabriele@email.com
Street	Sandstraße 3A
City	Nürnberg
Postcode	90443
Country	Germany

Philippines Universal (works for both PHL_CRIF and PHL_TU)

Inputs	Default (Low Risk) User
First name	Miguel
Middle name
Last name	Reyes
Date of birth	07-31-1997
Gender	Male
Email address	miguel@email.com
Street address	2399 Taft Ave
Barangay
Subdivision	Malate
City / Municipality	Manila
Province	Metro Manila
Post code	1004
Phone Number	9876543210
TIN (Taxpayer Indentification Number)	3312995553
SSS (Social Security System) Number	9877678799
GSIS (Government Service Insurance System) Number	65656512302

Philippines CRIF (PHL_CRIF)

Inputs	Default (Low Risk) User
First name	Carla Rose
Middle name
Last name	Osmena
Date of birth	11-27-1990
Gender	Female
Email address	carlarose@email.com
Street address	No 9006 RMS Apt Unit B St Mary St Maxima
Barangay
Subdivision	Palico 2
City / Municipality	Imus
Province	Cavite
Post code
TIN (Taxpayer Indentification Number)	878765576
SSS (Social Security System) Number	9639948488
GSIS (Government Service Insurance System) Number	77749345432

Philippines TU (PHL_TU)

Inputs	Default (Low Risk) User
First name	Miguel
Middle name
Last name	Reyes
Date of birth	07-31-1997
Gender	Male
Email address	miguel@email.com
Street address	2399 Taft Ave
Barangay
Subdivision	Malate
City / Municipality	Manila
Province	Metro Manila
Post code	1004
Phone Number	9876543210
TIN (Taxpayer Indentification Number)	3312995553
SSS (Social Security System) Number	9877678799
GSIS (Government Service Insurance System) Number	65656512302

Ukraine Creditinfo (UKR_CI)

Inputs	Default (Low Risk) User	Medium Risk	High Risk
First name	Ivan	Lyubov	Olena
Last name	Ivanov	Shevchenko	Melnyk
Date of birth	10-15-1985	08-23-1973	02-01-1990
Email address	ivan@email.com	lyubov@email.com	olena@email.com
Passport Number	CA123456	MN285039	DB223456
TIN (Taxpayer Indentification Number)	1234567890	4144217209	0451799112
ID (Identity Card) Number	123456789		990127761

Experian USA (USA_XP)

Inputs	Default (Low Risk) User	Medium Risk	High Risk
First name	Tina	Brian	Katherine
Middle name			W
Last name	Smith	Blakely	Maxim
Date of birth	07-08-1937	02-08-1967	11-01-1975
Email address	tina@email.com	brian@email.com	katherine@email.com
SSN	520047745	666416169	666412692
Street address	522 County Road 871	1077 S Hayworth Ave	20 Garfield Ave
City	Crane Hill	Los Angeles	Danvers
State	Alabama	California	Massachusetts
Postal code	35053	90035	01923

South Africa TransUnion (ZAF_TU)

Inputs	Default (Low Risk) User	Medium Risk	High Risk
First name	Thabo	Onalerona	Anika
Last name	Khoza	Dlamini	Ackerman
Date of birth	10-25-1989	07-08-1987	06-11-1977
Email address	thabo@email.com	onalerona@email.com	anika@email.com
Id Number	9101010000000	8908070570185	4706113622185
Id Type	SAID	Passport	SAID
Which full title Property did you purchase first (oldest)	NO 2 ENNISKILLEN, SPRINGFIELD, KWAZULU NATAL	same as Thabo	same as Thabo
Which credit provider do you have a joint loan account with	FNB PRIVATE CLIENTS HOME	same as Thabo	same as Thabo
Which of the following accounts have been paid up in the last 12 months	C) IDENTITY	same as Thabo	same as Thabo
Which of the following credit providers do you have active account/s with	A) FNB PRIVATE CLIENTS HOME	same as Thabo	same as Thabo
When did you resign as a principal from the following company: E AND C HARRY HOLDINGS	NONE OF THE ABOVE	same as Thabo	same as Thabo
When did you take a loan against your policy with NEDBANK GROUP BROKERS	NONE OF THE ABOVE	same as Thabo	same as Thabo

Ghana XDS (GHA_XDS) - In development

Inputs	Default (Low Risk) User	Medium Risk	High Risk
Full name	Ashanti Kanor	Najilan Mawusi	Ohene Edusei
Date of birth	10-25-1989	04-12-1973	12-24-1998
Document type	National Id	National Id	Passport
Document number	GHA0123456789	GHA8492739473	8842701234
Email address	ashanti@email.com	najilan@email.com	ohene@email.com

Colombia TransUnion (COL_TU)

Inputs	Default (Low Risk) User	Medium Risk	High Risk
First Name	Celia	Sofia	Jhon
Last Name	Gallegos	Alvarez	Rojas
Date of birth	10-25-1989	03-17-1963	06-05-1991
Most Recent Phone	3205368030	3436289931	3505432684
Document Type	Citizenship Card	Citizenship Card	Citizenship Card
Document Number	12343542	9384794	23455432
Document Issue Date	03-22-2013	07-15-2001	08-20-2018
Email Address	celia@email.com	sofia@email.com	jhon@email.com
Security Code	1234	1234	1234
Question 1	Ninguna de las anteriores	Ninguna de las anteriores	Ninguna de las anteriores
Question 2	CUENTA CORRIENTE Y TARJETA DE CREDITO	CUENTA CORRIENTE Y TARJETA DE CREDITO	CUENTA CORRIENTE Y TARJETA DE CREDITO
Question 3	DANN REGIONAL S.A.	DANN REGIONAL S.A.	DANN REGIONAL S.A.

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 the Credit Bureau Flow 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
expiresoon	Simulates the EXPIRED status after 5 minutes instead of 72 hours (triggred by prefill.lastName only)
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

KYC Sandbox Simulation

If you have KYC enabled for your account, you may use our built-in KYC sandbox to test an applicant's journey through our verification flow.

The sandbox will, by default, simulate a successfully authenticated passport for a sandbox user from the selected country. Please contact us if you need other sandbox simulations for the verification flow.

Please note that you should have a mobile device nearby in order to take a photo of the document to be verified.

When prompted, take a photo of a real passport or the sample passport below (ICAO9303 specimen):

In the Postman Collection, there are saved Examples for each endpoint which contain a Sandbox user's data formatted:

The contents of "Body" here can be copied to call the /idv endpoint.

Some additional notes about Sandbox mode:

• "Email address" for each sandbox user can be changed to any email, but it will send out the corresponding emails to that consumer.
• Sandbox mode does not interact with the bureaus. For example, the bureau does not send out the OTP code.

Testing cascade

For some countries, we allow consumers to try a second bureau if the first bureau fails - we call this "Cascade".

IND_CIBIL -> IND_CHM Cascade

Testing the IND_CIBIL -> IND_CHM cascade can be done using the Indian universal sandbox user Ishaan. To cascade from IND_CIBIL -> IND_CHM, fail /otp and the first set of /kba questions. It will then cascade to IND_CHM which will ask you another set of /kba questions that you should answer correctly to generate a pull. If you want to generate a IND_CIBIL pull with Ishaan, submit the correct /idv and /otp inputs.

MEX_BDC -> MEX_CDC Cascade

Testing the MEX_BDC -> MEX_CDC cascade can be done using the Mexican universal sandbox user Lara. In order to trigger a cascade with the universal user, enter an incorrect Father's last name for the user in the /idv step. Use all other correct sandbox values accordingly. Using the universal user with an incorrect Father's last name will result in a NOT_FOUND on MEX_BDC and successful cascade to MEX_CDC.

PHL_TU -> PHL_CRIF Cascade

Testing the PHL_TU -> PHL_CRIF cascade can be done using the Filipino universal sandbox user Miguel. To cascade from PHL_TU -> PHL_CRIF you will need to pass the document capture by uploading a valid passport but fail the selfie capture by submitting photos of things that aren't selfies. Since a selfie is required for PHL_TU it will result in a NOT_AUTH and cascade to PHL_CRIF. If you want to generate a PHL_TU pull with Miguel, submit a valid passport and a valid selfie.

Testing non-Success Cases

Here are some examples of how to trigger non-success cases within Sandbox mode.

Endpoint	Outcome	Substatus	How to replicate
init	BUREAU_UNRESPONSIVE		Submit /init endpoint with an X-SANDBOX-OVERRIDES header that contains the following value: { "bureauDown": true }. This will trigger a BUREAU_UNRESPONSIVE result. Note that this header only works in sandbox mode. It will be ignored on production if provided.
idv	NOT_FOUND		Submit consumer information that passes validation but does not match any Sandbox user. For example, take an existing sandbox user but change the dob or address.
idv	NOT_AUTHENTICATED	MISMATCHED_PII	Submit consumer information for AUS that contains the correct PII, but the incorrect document information.
idv	BUREAU_UNRESPONSIVE		As described here, use bureaudown in the personal.lastName field (or personal.fatherLastName if lastName is not used).
idv	ERROR		As described here, use error in the personal.lastName field (or personal.fatherLastName if lastName is not used).
kba	NOT_AUTHENTICATED	FAILED_KBA	Submit incorrect answers to KBA questions

Testing 202 responses

In order to simulate 202 responses on a GET /{sourceCountry}/idv/progress endpoint in Sandbox mode you need to pass a personal.email containing the text idvprogress202 to the corresponding POST /{sourceCountry}/idv endpoint. That will force the GET /{sourceCountry}/idv/progress endpoint to return 202 responses for a period of 30 seconds, after the POST /{sourceCountry}/idv endpoint is called. Example emails:

• idvprogress202@email.com
• name+idvprogress202@email.com
• name@idvprogress202.com
• nameidvprogress202etc@email.com
• any other email containing the text idvprogress202

OpenAPI Specs

Asterisk symbol (*)

The request parameters and fields with an asterisk next to them are required.

The response fields with an asterisk next to them are always returned.

Connect API

Connect India API

Passport API

Credentials API

Change Log

2025 September

• Added minLength and maxLength annotations to CreditPassportJSONv4 fields of Passport API spec
• Added optional support for teams in the Credentials API
• Updated /credentials endpoint
  • Marked active field as required
• Updated is_deceased description and availability

2025 August

• Updated /json response example to more closely align with a report that would be returned.

2025 April

• Added Credentials API OpenAPI spec
• Updated Passport API spec
  • Corrected name and description of credit_bureaus.bank_accounts.current_pay_status_mop field, the correct name is current_pay_status
  • Corrected name and description of credit_bureaus.tradelines.current_pay_status_mop field, the correct name is current_pay_status
  • Corrected name, type and description of credit_bureaus.tradelines.history.payments_mop field, the correct name is payments and the type is array of numbers
  • Updated example of sources.partner_report_id field to clarify that it is a string rather than UUID
  • Updated example and format of credit_bureaus.meta.bureau_report_id field to clarify that it is a string rather than UUID
  • Removed format of scores.history.score_version field

2025 January

• Updated references to X-ENVIRONMENT headers and added information about the new sandbox URL. Note that this header is backwards compatible, and therefore will still work.

2024 October

• Added GHA to sourceCountry enum in Connect API /init endpoint
• Added GHA_XDS to meta.company_code enum in Passport API spec
• Added GHA to sources.country enum in Passport API spec
• Added GHA Connect API endpoints:
  • /gha/idv
  • /gha/idv/progress
  • /gha/kba
  • /gha/kba/progress
• Added ZAF (South Africa) to docs
• Fixed UKR (Ukraine) list of endpoints
• Updated documentation for type of score values to integer
• Added year_of_birth to field options in report

2024 June

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

2024 April

• Added the Long Polling section with details on 202 responses from /progress endpoints.
• Updated /aus/idv endpoint
  • Updated personal.firstName, personal.middleName, and personal.lastName fields pattern
  • Updated personal.dob field must be between 18 and 100 years ago
  • Updated documents.immigrationCard.number field length to 1-9 characters
• Updated /aut/idv endpoint personal.firstName, personal.lastName, address.street, address.city, and address.postalCode fields min length is 1 character
• Updated /bra/idv endpoint documents.CPF.number field is required
• Updated /can/idv endpoint
  • Updated address.city field max length to 27
  • Added address.postalCode field pattern
• Updated /dom/idv endpoint documents.nationalId.number field is required
• Updated /ind/idv endpoint
  • Marked documents.PAN.number field as required
  • Marked documents.passport.number field as required
  • Updated documents.passport.number field length to 8-11 characters
  • Updated documents.voterId.number field max length to 50 characters
• Updated /ken/idv endpoint documents.nationalId.number field is required
• Updated /nga/idv endpoint documents.BVN.number field is required
• Updated /phl/idv endpoint
  • Marked documents.TIN.number field as required
  • Marked documents.GSIS.number field as required
  • Marked documents.SSS.number field as required
• Updated /ukr/idv endpoint
  • Added documents.passport.number field pattern
  • Updated documents.passport.number field length to 8 characters
• Updated /usa/idv endpoint personal.lastName field min length to 2 characters
• Updated score_version from "Only applies if score_type is NOVA_SCORE_BETA" to "Only applies if score_type is not FOREIGN_SCORE"

2024 March

• Corrected PHL_TU sandbox users, the medium and high risk users were inverted

2024 January

• Updated validation logic for the CPF value in /bra/idv

2023 December

• Updates to ind state codes
  • Updated /ind/idv endpoint state enum
    • new code 'LA' for Ladakh
  • Updated /ind/idv endpoint state enum descriptions
    • 'PY' updated from Pondicherry to Puducherry
    • 'OR' updated from Orissa to Odisha
  • State values in reports from IND_CIBIL and IND_CHM will now contain Puducherry or Odisha instead of Pondicherry or Orissa respectively.

2023 October

• Added consumer_notices information to the passport JSON spec
• Added UKR to sourceCountry enum in Connect API /init endpoint
• Added UKR_CI to meta.company_code enum in Passport API spec
• Added UKR to sources.country enum in Passport API spec
• Added UKR Connect API endpoints:
  • /ukr/idv
  • /ukr/idv/progress

2023 September

• Update CIBIL idv street maxLength from 40 to 80

2023 August

• Marked INVALID_PII as deprecated in the list of substatuses.

2023 July

• Added 400 response examples to Connect API /init endpoint
  • Malformed Body, input failed validation
  • Duplicate External ID
• Added 400 response examples to Passport API /status, /json, /pdf, /sourceFiles and /sourceFiles/{fileId} endpoints
  • Malformed Headers
  • Invalid API Version
  • Invalid Token
  • Invalid External ID
  • Invalid Public ID

2023 June

• Removed INVALID_PII from the list of substatuses.
• Added externalId field to Connect API /init endpoint
• Added X-EXTERNAL-ID and X-PUBLIC-ID request headers to Passport API /status, /json, /status, /sourceFiles and /sourceFiles/{fileId} endpoints

2023 May

• Marked personal.motherLastName field as optional in /mex/idv endpoint
• Added MEX_BDC to bureaus that return FROZEN_FILE substatus in Connect API spec and Passport API spec
• Added MALFORMED_BODY to OutcomeResponse.status enum in Connect API spec
• Updated /aus/idv endpoint documents.immigrationCard field length to 1-9

2023 April

• Fixed typo in the current_pay_substatus enum where one of the values was spelled REPOSESSION instead of REPOSSESSION (two s's).
• Fixed the ERROR status in Connect API to return 200 instead of 400
• Added INVALID_PII to the list of substatuses.
• Updated /phl/idv endpoint documents.GSIS field length to 11

2023 March

• Updated /phl/idv endpoint documents.SSS field length to 10

2023 February

• Added more example outcomes to /dom/idv/progress and /dom/kba/progress
• Added more example outcomes to /ken/idv/progress
• Added more NOT_AUTHENTICATED example responses to /can/idv/progress endpoint
• Added more cases of NOT_AUTHENTICATED to /can/kba/progress endpoint
• Removed SUCCESS case from /ind/idv/progress endpoint
• Removed SUCCESS case from /ind/kba/progress endpoint
• Added NOT_AUTHENTICATED with substatus THIN_FILE outcome to /ind/idv/progress endpoint
• Added DAILY to payment_obligation_frequency
• Added foreign_id_type field enum

2023 January

• Added CAN_TU to bureaus that return FROZEN_FILE substatus in Passport API spec
• Added MEX universal sandbox user instructions
• Added documentation on how to simulate 202 responses on the GET /{sourceCountry}/idv/progress endpoints
• Added UNSUPPORTED_COUNTRY on /init to distinguish from BUREAU_UNRESPONSIVE
• Updated /bra/idv endpoint documents.cpf field example
• Marked kbaAnswers.questionId and kbaAnswers.answer fields as required
• Added Successful response - next step is Address Search response example to /init endpoint
• Updated /gbr/address-search/progress endpoint addressSearchResults field description to indicate it can be an empty list
• Updated /mex/address-search/progress endpoint addressSearchResults field description to indicate it can be an empty list
• Marked error field in Error type as required
• Updated Success, application is complete response example description to specify the Passport API might not return a success
• Added intro section Asterisk symbol (*) to the top of the OpenAPI Specs section that explains that the asterisk means required for request fields, and always returned for response fields
• Update /doc-capture/progress endpoints extractedData schema
  • Updated identities.gender field enum to [M, F]
  • Marked identities.gender as nullable
  • Marked identities.dob as optional
  • Marked identities.firstName as optional
  • Marked identities.lastName as optional
  • Marked identities.fullName as optional
  • Removed documents.country field enum
  • Updated documents.country field description to specify it is a 3-letter country code
  • Marked documents.dateOfExpiry as required
• Updated /ind/otp endpoint code field
  • Marked as required
  • Added max length of 6
  • Added min length of 6
• Updated /dom/idv endpoint personal.fullName field description to specify it should contain at least 2 words
• Added /dom/idv/progress endpoint response examples
  • Consumer not authenticated, can retry IDV
  • Consumer not authenticated, cannot retry IDV
• Updated /aut/idv endpoint
  • Updated address.apartment field example to empty string
  • Removed address.postalCode field min length and pattern
  • Updated personal.dob field example to 1968-07-15 to match Sonja sandbox user dob
  • Updated personal.firstName field max length to 100
  • Updated personal.lastName field max length to 100
• Updated /che/idv endpoint
  • Updated address.apartment field example to empty string
  • Removed address.postalCode field min length and pattern
  • Updated personal.dob field example to 1975-04-04 to match Patrick sandbox user dob
  • Updated personal.firstName field max length to 100
  • Updated personal.lastName field max length to 100
• Updated /deu/idv endpoint
  • Updated address.apartment field example to empty string
  • Removed address.postalCode field min length and pattern
  • Updated personal.dob field example to 1989-07-07 to match Gabriele sandbox user dob
  • Updated personal.firstName field max length to 100
  • Updated personal.lastName field max length to 100
• Updated /can/idv endpoint address.city field max length to 25
• Updated consent.version for /init across all countries
  • Marked as required
  • Added a regex
• Updated sourceCountry for /init across all countries
  • Marked as required
  • Added USA and DEU to enum
• Updated userIp for /init across all countries
  • Added maxLength validation of 39
• Added PARTIAL as a new possible value for current_condition_type under tradelines in the Passport JSON.
• Clarified that all dob inputs should be in YYYY-MM-DD format
• Specified that for DOM, CAN, NGA, and KEN, dob inputs should be between 18 and 110 years ago.
• Added ADDRESS_SEARCH, DOC_CAPTURE_PROGRESS, POST_BUREAU_DATA, BUREAU_DATA_TRANSFER to the enum of values for next within the OutcomeResponse object
• Clarified that publicToken strings are in uuid format
• Marked publicToken and messageId as required (always present) in 202 /idv responses
• Updated ESP_EFX validations:
  • Updated personal.firstName and personal.lastName to have a max length of 100
  • Updated personal.dob to have a max length of 10
  • Updated the first name, last name, and dob example values to match the sandbox user
• Added MEX flow diagram
• MEX /idv updates:
  • Removed the address.street validation that it must include on number and one letter.
  • Clarified the description for the /idv/progress outcome example.
• Added a description for /idv consent.granted for all countries
• Updated /aus/idv:
  • Updated the documents.driversLicense.state field's description to clear up where to find the AUS states enum.
  • Updated the documents.immigrationCard.birthYear field's description to state that the birth year should lead to an age between 18 and 100 and the length of this field should be 4.
  • Updated the documents.immigrationCard.birthMonth field's documentation to state that the min length is 1 and max length is 2.
  • Updated the request's schema in the documents node to use asterisk if the field is required and absence of asterisk if the field is optional.
• Updated /usa/idv:
  • Updated the personal.middleName field's validation to have a maxLength of 100.
  • Updated the documents.SSN field to be optional instead of required
  • Corrected idv example which had the wrong address and dob for sandbox user Tina
• Updated /gbr/idv:
  • Updated the address.city field's validation to have a maxLength of 28.
  • Updated the address.street field to remove the validation "Must include a letter (including Latin accented characters)"
• Updated /nga/idv:
  • Updated the personal.fullName field to be required
• Marked the following fields as required in the CreditPassportJSONv4 schema from the Passport API OpenAPI spec:
  • comments.key
  • comments.value
  • personal.is_deceased
  • adverse_action_codes.code
  • adverse_action_codes.description
  • exclusion_codes.code
  • exclusion_codes.description
  • scores.history.date_reported
  • scores.history.value
  • metrics.metric_timeseries.interval
  • metrics.metric_timeseries.values
  • credit_bureaus.tradelines.history.year
  • credit_bureaus.tradelines.history.payments_mop
  • credit_bureaus.tradelines.tradeline_id
  • credit_bureaus.bank_accounts.bank_account_id
  • credit_bureaus.bank_accounts.bank_account_type
  • credit_bureaus.bank_accounts.date_last_reported
  • credit_bureaus.bank_accounts.is_overdrawn
  • credit_bureaus.bank_accounts.original_currency
  • credit_bureaus.public_records.public_record_id
  • credit_bureaus.frauds.fraud_id
  • credit_bureaus.frauds.is_fraudster
  • credit_bureaus.collections.collection_id
  • credit_bureaus.collections.is_paid
  • credit_bureaus.collections.balance
  • credit_bureaus.collections.original_currency
  • credit_bureaus.nonsufficient_funds.nonsufficient_fund_id
  • credit_bureaus.inquiries.inquiry_id
  • credit_bureaus.inquiries.inquiry_account_type
  • credit_bureaus.employers.employer_id
  • credit_bureaus.address.address_id
  • credit_bureaus.dispute.dispute_id
  • credit_bureaus.notices.notice_id
  • credit_bureaus.notices.notice_type
  • credit_bureaus.notices.statement
  • credit_bureau.meta.company_code
• Updated the following fields from required to optional in the CreditPassportJSONv4 schema from the Passport API OpenAPI spec:
• For all of the subfields in personal except for match_algorithm, marked unmatched_source_ids as optional
• sources.partner_report_id
• personal.first_name
• personal.last_name
• personal.date_of_birth
• personal.emails
• identities.documents.country
• identities.first_name
• identities.last_name
• identities.full_name
• identities.date_of_birth
• scores.value
• Added score_version to scores in the CreditPassportJSONv4 schema from the Passport API OpenAPI spec
• Indicated that the following fields are nullable in the CreditPassportJSONv4 schema from the Passport API OpenAPI spec:
  • credit_bureaus.bank_accounts.institution
  • credit_bureaus.bank_accounts.translated_institution
  • credit_bureaus.employers.company_name
  • credit_bureaus.inquiries.company_name
  • credit_bureaus.inquiries.translated_company_name
  • credit_bureaus.tradelines.institution
  • credit_bureaus.tradelines.translated_institution
• Added more documentation on how to test cascade for MEX, PHL, and IND.

2022 December

• Updated addressId to be optional for GBR
• Added foreign_id and foreign_id_type information to Passport API spec
• Updated /idv address behavior for GBR to include address suggestions
• Changed the status of USA endpoints to completed
• Added comments as a possible field in the employers node in the Passport JSON response.
• Marked issue_date and expiration_date fields under the identities[].documents[] node as optional.
• AUS_EFX: All driver's licenses updated to require a card number regardless of the document's state.
• Updated phl/idv validations:
  • Updated personal.firstName to have maxLength 30 and minLength 2
  • Updated personal.lastName to have maxLength 30
  • Updated personal.dob example value to match the sandbox user
  • Clarified that personal.phoneNumber must be a numerical string of length 10, if provided
  • Updated address.district to have maxLength 60, address.subdivision to have maxLength 100, address.city to have maxLength 50, address.state to have maxLength of 50, and address.postalCode to have length of exactly 4.
• Updated the DOC_CAPTURE countries (PHL, AUT, CHE, ESP, DEU) to have the proper matched_fields schema in the case where Mitek was successful but the data submitted via /idv was mismatched.
• Added IDLE_SESSION_TIMEOUT, FROZEN_FILE and CLICKED_EXIT_BUTTON to the list of substatuses.

2022 October

• Update USA_XP NOT_FOUND case. NOT_FOUND will be returned during the passport/status call for USA_XP

2022 September

• Added USA_XP in the Sandbox Information section
• Added USA_XP to meta.company_code enum in Passport API spec
• Added Passport API info and openapi spec

2022 August

• Updated AUS IDV documents description and examples in Connect API spec
• Updated AUS snapshots in Nova Connect API Postman Collection to match AUS sandbox users data
• Added metric_value field max length in the Passport API spec.
• Updated PHL Government Service Insurance System Number (GSIS) min and max length

2022 July

• Added JBT to states requiring cardNumber field for driversLicense document in AUS /idv step
• Added cardNumber field for driversLicense document in AUS /idv step
• Updated the Nova Connect API Postman Collection to include driver's license cardNumber field in AUS snapshots
• Added charge_off_amount as a tradeline field
• Added selfie_matched field to the identity information
• Included example outputs to AUS/idv/progress for a NOT_AUTHENTICATED result with retry available.
• Removed OTP example responses from /idv/progress outcome examples for countries that don't have OTP steps.
• Removed MISSING_KYC substatus - replaced by more specific substatuses added in May.
• Added outcome examples with SELFIE_NOT_AUTHENTICATED and DOCUMENT_NOT_AUTHENTICATED subStatuses
• Updated the Nova Connect API Postman Collection to include PHL_TU snapshots/inputs
• Added PHL_TU in the Sandbox Information section
• Changes to the Passport API/report JSON:
• Added RETAIL to inquiry_account_type
• Added DEFERRED to payment_obligation_frequency
• Added UNDESIGNATED to responsibility

2022 June

• Fix nested extractedData issue in /doc-capture/progress outcome
• Added translated_company_name, inquiry_account_type, and is_collateralized to the Inquiries Passport API spec.
• Add flow diagram for PHL Cascade behavior
• Add sandbox overrides for doc-capture
• Update middleNameAsOnCard length to match middleName field in AUS /idv step
• Add min lengths to AUS /idv fields
• Update PHL /idv example to use PHL_TU sandbox user
• Update dob to be required for all mitek countries

2022 May

• Updated the extracted data and relevant documentation for the Doc Capture countries to include separated document and identity information along with additional fields for documentType, documentNumber, country, dateOfIssue, dateOfExpiry, isAuthenticated
• Added USA endpoints to the openapi spec.
• Updated PHL inputs to collect optional phone number for PHL_TU.
• Updated /doc-capture countries to include PII collection in /idv, and mismatch information in /idv/progress
• Updated GBR and MEX to return next: IDV rather than next: ADDRESS-SEARCH
• Updated the AUS medicareCard documentation to rename middleInitialAsOnCard to middleNameAsOnCard and updated regex.
• Updated IND to support BUREAU_DATA_TRANSFER as an outcome of /idv
• Updated the AUS medicareCard documentation to rename middleNameAsOnCard to middleInitialAsOnCard .
• Updated the GBR, DOM, CAN example outputs in their respective /idv/progress and /kba/progress endpoints to include retry on NOT_FOUND and NOT_AUTHENTICATED.
• Updated the KEN example output for the /idv/progress endpoint to include retry on NOT_FOUND.
• Updated the {sourceCountry}/kba/progress example outputs to include retry on NOT_AUTHENTICATED.
• Updated IND first name and last name validations:
  • first and last name must be distinct.
  • Each name cannot contain duplicate words.
• Added new substatuses DOCUMENT_NOT_AUTHENTICATED and SELFIE_NOT_AUTHENTICATED
• Adds CEASED as a new possible value for current_condition_type under tradelines in the Passport JSON.

2022 April

• Updated the AUS medicareCard documentation to have correct validation for middleNameAsOnCard.
• Fixed /doc-capture/progress typo to return extractedData rather than extracted.
• Separated GBR and MEX example outputs in {sourceCountry}/address-search/progress for clarity.
• Updated the Nova Connect API Postman Collection to include AUT, CHE, DEU, and EFX snapshots/inputs.
• Updated Mexico address search outcome to include postalCode.
• Changed the status of AUT, CHE, DEU, ESP, and PHL endpoints to completed.
• Changed the status of the /sourceFiles, /json, and /pdf endpoints to completed.
• Added links to the sandbox users for these 5 countries.
• Added endpoints for Germany to the Connect API OpenApi spec.

2022 March

• Updated the Nova Connect API Postman Collection to include KEN_CI and DOM_TU snapshots/inputs
• Updated Nova Connect API Postman collection to include doc-capture endpoints and PHL examples
• Updated IND_CIBIL street name validations: Must contain at least 3 alphabetical characters.
• Added endpoints for Austria, Spain and Switzerland to the Connect API OpenApi spec.

2022 February

• Update /doc-capture/progress schema to more accurately reflect the possible outcomes
• Updated GBR_EFX first name and last name validations:
  • minLength from 2 to 1
  • Must not have any of these characters adjacent to each other (in parentheses): ('. -)
• Updated GBR address-search response example.
• Updated MEX endpoints:
  • Added /mex/address-search and /mex/address-search/progress endpoints.
  • Included MEX outcome examples to include cascade cases.
• Updated BRA /idv example request.
• Updated NGA /idv outcome examples to include NOT_AUTHENTICATED
• Updated the Nova Connect API Postman Collection to include IND_CHM and MEX_BDC snapshots/inputs

2022 January

• Added PHL and /doc-capture endpoints to the Connect API spec
• Updated the Flow Diagrams folder to contain the new IND flow changes (e.g., a NOT_AUTHENTICATED results in no try again)
• Update KBA outcome examples to include cascade with NOT_FOUND
• updated the IDV Documents name field description with examples to clarify that name is a string and is not currently being validated on Nova Credit's side.
• Updated OtpPromptResponse to correctly return otpMethods instead of otpRetrievalMethods
• Added an enum to define the different name fields that are expected in the IDV Documents schema
• Added DOM endpoints to the Connect API spec
• Added KEN endpoints to the Connect API spec
• Added NGA endpoints to the Connect API spec

2021 December 20

• Update IND Connect API Pre-RBI Flow full diagram to include cascade step for failed KBA
• Added simplified Pre-RBI IND flow diagram to the Flow Diagrams folder
• Added link to universal user for IND (works with both IND_CIBIL and IND_CHM)
• Renamed Passport API payment history fields (current_pay_status, payments) and updated descriptions
• Updated docs to fix inconsistencies: using sourceFiles instead of source-files, and api.novacredit.com rather than api.neednova.com
• Updated Connect API/openapi-ind.yaml GET /ind/bureau-data/progress outcomeResponse to only include possible outcomes (PENDING and ERROR)
• Added BRA endpoints to the Connect API spec
• Updated Connect API endpoint outcomes and examples to be relevant for each specific bureau.
• Adds */idv/progress, */kba/progress to the Connect API spec for each of the source countries, but keeps /{sourceCountry}/idv and /{sourceCountry}/kba as the superset. This is to make clearer what the expected responses are for the different country flows.
• Updated Passport API IND /bureau-data response to rename dateUpdated properties to dateReported in the disputes[] objects in the body response.
• Removed INVITED and UNSUPPORTED_COUNTRY from CreditPassportJSONv4 status description
• Add detail to non-success cases in README
• Update /sourceFiles description to reflect latest country functionality
• Fixed Response Examples link
• Add flow diagrams for IND
• Fix /bureau-data/progress endpoint to be a GET type instead of POST type
• Updated Passport API to include Status descriptions and Substatuses in CreditPassportJSONv4
• Updated Passport API response examples to reflect scrubbed institution names
• Updated bureau-data endpoint types to reflect proper signature and text types

2021 November

• Added more specific validation information for CAN & AUS postal codes.
• Updated information in the readme for GBR
• Reorganized folder structure for postman collections
• Updated Connect API postman collection to include GBR examples
• Update Connect API spec to separate IND API flow into its own doc
• Update Connect API openapi spec to add more detail for the IND flow
• Update connect openapi to include new endpoints for update IND flow
• Update postman collection to include GBR /address-search endpoint

2021 September

• Fix IND examples to include "fatherLastName" field
• Makes it clearer which IND bureau the example references
• Adds IND_CIBIL/IND_CHM global user example

2021 August

• Moves the /source-files endpoint from the Connect API to the Passport API.
• Reorganizes README.
• Cleans up Connect API openapi spec documentation:
• Clarifies response of the OTP and KBA /progress endpoints
• Adds headers to the tables in the /idv documents section
• Reorganized the folder structure and README to correspond to the Connect and Passport APIs.
• New endpoints are ready to be tested:
• Finished /ind/otp
• Added /ind/kba
• Added /progress 202 responses
• Added Passport API openapi spec

2021 July

• Added JSON and PDF response examples from sandbox IND_CIBIL for all 3 sandbox users
• Updated KBA examples to use IND_CIBIL Sandbox examples
• Added /ind/otp (only success case as of now)
• Added /source-files for AUS and IND
• Updated Postman collection with Examples for /ind/otp.
• Updated information in the README around Sandbox Mode and Passport API endpoints.
• Added /ind/otp/* routes
• Added /source-files routes for CAN
• Clarified that Public Tokens must be used within 24 hours.
• For the validations object we added a new INVALID_INPUT reason

2021 May

• AUS endpoints are now ready to be tested. Examples added to Postman collection.
• /init: Remove destinationCountry, add sourceCountry
• /idv:
  • Update NOT_FOUND outcomes to be 200 instead of 400
  • AUS: Fixed document.nameAsOnCard to be document.middleNameAsOnCard
  • MEX: Added missing address.municipality field
• Update NOT_AUTHENTICATED outcomes to be 200 instead of 400 for /kba and /otp
• Added proposal for outcome.validations array when /idv/progress, /otp/progress, or /kba/progress return a 400 MALFORMED_BODY
• Where possible, added more details to the validations we run