Generates and delivers the credit report that you previously ordered through the Order Credit Report call.

Report Formats and Delivery Methods

The report can be generated in a number of different formats: HTML, XML, raw, and so on. It can be delivered in one of two ways:

  • In the body of the response.

  • As an argument to a callback function that's invoked if the report generation is successful (HTTP status 200). To use this delivery method, you must implement a JSONP callback function that takes a single string argument, and pass the name of your function to the onSuccess query parameter.

You specify the desired report format and the delivery method (response body or callback argument) by setting the MIME value of the content-type request header:

FormatBody DeliveryCallback Delivery
XML object. See 1B Credit Report (XML) and 3B Credit Report (XML) for examples.application/xmlapplication/xmlp
JSON object. See 1B Credit Report (JSON) and 3B Credit Report (JSON) for examples. If you ordered a "quick view" report, see 1B Credit Quick View (JSON).application/jsonapplication/javascript
TransUnion three-bureau JSON object. See 3x1b JSON vTUC6 for an example.application/json-tucreportv6application/javascript-tucreportv6p
The report's native format as defined by the bureau.application/rawapplication/rawp

️ Note Well

Although they might look like typos, the MIME values that deliver JSON objects through the callback do, indeed, indicate javascript.

HTML and PDF formats

Although you can request a report in HTML or PDF format by specifying a content-type of text/html or application/pdf (response body delivery, only), it's recommended that you use Return HTML Credit Report or Return PDF Credit Report, instead. This will let you link directly to the report by using the endpoint URL (/api/report/v2/html or /api/report/v2/pdf) as the value of an href attribute.

Bureau Errors

If the operation is successful, it returns 200; however, that doesn't mean that the response body will actually contain a credit report. Accompanying the 200 status are a set of headers that declare the status of the individual bureaus' fulfillments. The headers are:

HeaderDescription
x-array-tui-errorThe status of TransUnion's fulfillment.
X-array-exp-errorThe status of Experian's fulfillment.
x-array-efx-errorThe status of Equifax's fulfillment.

All three headers will always appear. They each take one of these integer values:

ValueDescription
0The report data was successfully retrieved and contributes to the aggregated report that's contained in the response body.
1001The bureau couldn't find a credit report for the customer. This can happen if the report is currently being updated, if the report contains no recently-active accounts, or if the information in the customer's User record (indirectly identified through the displayToken) differs from the identifying information in the report. In the latter case, the customer will need to re-register with more accurate information.
1002The information in the customer's User record differs from the identifying information in the report. To proceed, the customer will need to re-register with more accurate information.
1101A credit report was found, but the report declares that the customer is deceased. To proceed, the customer should make sure that the information in his or her User record is accurate. If the problem persists, the customer will need to file a dispute with the the bureau.
1102A credit report was found, but the bureau is unable to return it for undisclosed reasons. To resolve this impediment, the customer should contact the bureau directly.
1201The bureau was unable to find a credit report that matches the information in the User record. The customer will need to re-register with more accurate information.
1202The customer's User record contains a social security number that's in an unsupported format (such as ITIN). The customer will need to re-register and provide a valid social security number.
2000The bureau experienced an unspecified error while transmitting the report. Try again later.
2001The bureau experienced an unspecified error while transmitting the report. Try again immediately.
2002The bureau experienced an unspecified error while transmitting the report. Wait 24 hours or more and try again.
Language
Click Try It! to start a request and see the response here!