In order to incorporate new products into Connect API, we will start offering Product Bundles

What you need to know

We are not adding endpoints. This new feature will be supported by /v3/report and related endpoints.

Authentication-related endpoints are not affected by this new feature. This is only for reports.

In order to support multiple products in the same response, we are adding a reports element. Reports for individual products will be put inside reports.

New products such as RentBureau or Background Data will always use the new response structure, no matter if they are provided as part of a bundle or as standalone products.

In order to keep compatibility with current client's implementations, regular Credit Profile products (product IDs 1 and 9) will not be affected. Input and output remain the same.

New JSON Structure

In the current JSON Structure, CreditProfile report is a top-level element:

{
    "success": true,
    "error": null,
    "transactionId": "732927",
    "CreditProfile": {
        "Header": {
        "ReportDate": "01/03/2019",
        "ReportTime": "08:58:23 AM CT"

    },...
                  

We are adding a reports element. Reports for individual products will be put inside reports:

curl -i -H "Accept: application/json" -H "ct-remote-user:capi_demo" "http://localhost:8080/connectapi/v3/report" -d "productId=30&consumerToken=NmE4NDgzNDItYTMwMC00NWFlLTkwZDYtZWNjYzI2NTE1Njgy&purposeType=7"

{

    "success": true,
    "error": null,
    "transactionId": "732935",
    "reports": {
        "BackgroundData": {                                 
            "success": true,                                 
            "error": null,                               
            "report": {  
                ....
                ....    
            }
        },
        "Credit Profile": {                    
	    "success": true,
	    "error": null,
	    "report": {
	        "Header": {
		    "ReportDate": "01/03/2019",
		    "ReportTime": "09:08:07 AM CT"
		},
                ...
                ... 
       }
   }
}

Error Codes

Current Report Error Codes are coupled to Credit Report. These error codes are still valid, but in the case of bundled reports they will be located in the Credit Profile section under reports. We made an update Error Codes document where Generic Report errors and Credit Profile error codes are separated. This new document will be the default one as soon as Product Bundle feature is moved to Production. In the meantime, please see the  updated error codes document.
For more information about Background Data report, see Background Data Guide