Skip to main content
Connect discovers liabilities using the user’s credit report. Teams with raw credit report access enabled can also receive that underlying bureau report itself, as a downloadable raw credit report JSON and/or credit report PDF returned as Files. Files give you a durable copy of the report (e.g. for compliance archives or underwriting reviews) that can be re-downloaded at any time.

Prerequisites

  • Raw credit report features are enabled on a case-by-case basis. Contact Method to enable these.
  • The Entity must be verified and must not have withdrawn consent.

Requesting the raw report

1

Create a Connect with artifacts

Pass bureau and artifacts when creating a Connect:
Each Connect pulls from a single bureau. To receive credit reports from both bureaus, you will need to make 2 separate Connect calls.
2

Read the response

The Connect response includes the requested artifacts in files:
3

Download the file artifacts

Note the file_ids in the above response and use Retrieve a File to get the File’s metadata, including a temporary download_url to its contents:
Fetch the download_url. A new URL is generated on every retrieve and expires at download_expires_at.Additionally, you can stream a File’s contents directly with Download a File:

Retrieving the raw report later

Files persist after the Connect completes. Retrieve the Connect at any time to read its files array, then download the contents via the Files API.

Webhooks

Connects with products or subscriptions (or the Prefer: respond-async header) process asynchronously. Listen for connect.available to know when an async Connect (including its artifacts) is ready, and connect.create for synchronous completions. See Connect webhooks.

Errors

See Connect errors and File errors for the full list.
Handling sensitive data. The raw credit report contains the consumer’s full bureau file. Treat it as highly sensitive: store it encrypted, restrict access, and only retain it as long as your compliance obligations require.
For the full API surface, see the Connect reference and the Files reference.