Get a list of all current and Metro2 credit reports for a specific account

GET /accounts/{account_id}/credit_reports/list

List of Metro2 credit reports for the account. To view line items for a specific credit report, use the /accounts/{account_id}/credit_reports/{credit_report_id} route

Path parameters

Query parameters

  • limit integer

    The maximum number of accounts to be returned. Defaults to 100.

Responses

  • • 200 object
    • results array[object]

      Metro 2 credit report overview

      Not more than 100 elements.

      • account_id string Required

        The Canopy-generated ID for the account

      • credit_report_id string Required

        The Canopy-generated ID for the statement

      • cycle_summary object
        • cycle_inclusive_start string(date-time) | null Required

          The inclusive starting Date-Time that defines the cycle for which the report was generated.

        • cycle_exclusive_end string(date-time) | null Required

          The exclusive ending Date-Time that defines the cycle for which the report was generated.

      • bureau_reports_included object
        • equifax boolean

          Indicates whether a Metro2 file to send to Equifax was generated as part of this report. This is expected to be true if you have configured an Equifax Program Identifier for your organization as of the time the report was generated.

        • experian boolean

          Indicates whether a Metro2 file to send to Experian was generated as part of this report. This is expected to be true if you have configured an Experian Program Identifier for your organization as of the time the report was generated.

        • transunion boolean

          Indicates whether a Metro2 file to send to TransUnion was generated as part of this report. This is expected to be true if you have configured an TransUnion Program Identifier for your organization as of the time the report was generated.

  • • 401

    Unauthorized.

  • • 403

    Forbidden.

  • • 404

    Statements not found

  • • 429

    Too many requests.

  • • default

    Unexpected Error.

GET /accounts/{account_id}/credit_reports/list 
curl \
 -X GET https://<your_environment_name>-uat-api.canopyservicing.com/accounts/can_52322/credit_reports/list \
 -H "Authorization: Bearer $ACCESS_TOKEN"
Response example (200) 
{
  "results": [
    {
      "account_id": "31mNprzLd2bKl6koVna68ARM",
      "credit_report_id": "31mNprzLd2bKl6koVna68ARM",
      "cycle_summary": {
        "cycle_inclusive_start": "2023-05-04T09:42:00+00:00",
        "cycle_exclusive_end": "2023-05-04T09:42:00+00:00"
      },
      "bureau_reports_included": {
        "equifax": true,
        "experian": true,
        "transunion": true
      }
    }
  ]
}