Skip to main content

Connect API Reference

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

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​

Passport API​