Path parameters

• account_id string Required

  Account ID

• credit_report_id string Required

  The ID of a specific Metro2 credit report you would like returned.

Responses

• 200
  Hide response attributes Show response attributes object

  • account_id string Required

    The Canopy-generated ID for the account

  • credit_report_id string Required

    The Canopy-generated ID for the statement

  • report_transunion string | null

    Transunion Metro2 credit report

  • report_equifax string | null

    Equifax Metro2 credit report

  • report_experian string | null

    Experian Metro2 credit report

  • activity_date string(date) | null

    Signifies date of most recent update to accounts. If accounts are updated on different dates, use most recent. A future date should not be reported.

  • date_created string(date) Required

    Contains the date the media was generated. A future date should not be reported.

  • program_date string(date) | null

    Contains the date your reporting format was developed.

  • program_revision_date string(date) | null

    Contains the last date your reporting format was revised.

  • reporter_name string | null

    Contains the name of the processing company sending the data; i.e., data furnisher or processor.

  • reporter_address string | null

    Contains the complete mailing address of the processing company; i.e., street address, city, state and zip code.

  • reporter_telephone_number string | null

    Contains the telephone number (Area Code + number) of the company sending the data; i.e., data furnisher or processor.

  • consumer_account_number string | null Required

    The account_id for the individual reported. This is the canonical Canopy account id.

  • portfolio_type string Required

    Contains the one-character abbreviation for type of portfolio

    Values are C, I, M, O, or R.

  • account_type string Required

    Report the specific code that identifies the account classification.

    Values are 01, 15, or 18.

  • date_opened string(date) Required

    Report the date the account was originally opened. Retain the original Date Opened regardless of future activity, such as transfer, refinance, lost or stolen card, etc.

  • credit_limit integer Required

    Total amount (in truncated dollars) that the account can borrow.

  • highest_credit integer Required

    If a revolving account, highest credit is the peak balance within the statement cycle. If an installment account, it is the original loan amount.

  • terms_duration string Required

    Contains the duration of credit extended, or LOC if revolving account

  • terms_frequency string Required

    Report the frequency for payments due.

    Values are P, W, B, E, M, L, Q, T, S, or Y.

  • scheduled_monthly_payment_amount integer Required

    Report the dollar amount of the scheduled monthly payment due for this reporting period, whether principal, interest only or a combination of the two.

  • actual_payment_amount integer Required

    Report the dollar amount of the monthly payment actually received for this reporting period in whole dollars only.

  • account_status string Required

    Contains the status code that properly identifies the current condition of the account as of the Date of Account Information.

    Values are 11, 13, 71, 78, 80, 82, 83, 84, 64, 97, or DF.

  • payment_rating string | null

    The Payment Rating contains a code that properly identifies whether the account was current, past due, in collections or charged off prior to the status and within the current month’s reporting period.

    Values are null, 0, 1, 2, 3, 4, 5, 6, G, or L.

  • payment_history_profile string | null

    Contains up to 24 months of consecutive payment activity for the previous 24 reporting periods prior to the Date of Account Information being reported.

  • special_comment_code string | null

    Used in conjunction with Account Status and Payment Rating to further define the account (e.g., closed accounts or adjustments pending).

    Values are null, AP, M, or AU.

  • compliance_condition_code string | null

    Allows the reporting of a condition that is required for legal compliance.

    Values are null or XA.

  • current_balance integer Required

    Report the outstanding current dollar balance on the account as of the Date of Account Information.

  • amount_past_due integer Required

    Report the total amount of payments that are 30 days or more past due in whole dollars only.

  • original_charge_off_amount integer Required

    For Status Codes 64 and 97 (all portfolio types), report the original amount charged to loss, regardless of the declining balance. Whole dollars

  • date_of_account_info string(date) Required

    Date of reporting.

  • first_delinquency_date string(date) | null

    Indicates the first date of delinquency in a given cycle.

  • date_closed string(date) | null

    For all portfolio types, contains the date the account was closed to further purchases, paid in full, transferred or sold.

  • last_payment_date string(date) | null

    Report the date the most recent payment was received, whether full or partial payment is made.

  • consumer_primary object Required
    Hide consumer_primary attributes Show consumer_primary attributes object

    • name_first string Required

      Customer's first name. Primary account holder or controlling officer name for Business customers.

    • name_middle string

      Customer's middle name. Primary account holder or controlling officer name for Business customers.

    • name_last string Required

      Customer's last name. Primary account holder or controlling officer name for Business customers.

    • name_suffix string

      Suffix to the customer's name

    • ssn string

      Social security number of the customer

    • date_of_birth string(date) Required

      Customer's date of birth in ISO 8601 format

    • ecoa_code string Required

      Defines the relationship of the primary consumer to the account and designates the account as joint, individual, etc., in compliance with the Equal Credit Opportunity Act.

      Values are 1, 2, 3, 5, 7, T, X, W, or Z.

    • consumer_indicator_code string | null

      Contains a value that indicates a special condition of the account that applies to the associated consumer.

    • phone_number string

      Customer's phone number in E.164 format

    • address_line_one string Required

      Address line one.

    • address_line_two string

      Address line two.

    • address_city string Required

      Address city.

    • address_state string Required

      Address state.

    • address_zip string Required

      Five digit zipcode or nine digit 'ZIP+4'

• 401

  Unauthorized.

• 403

  Forbidden.

• 404

  Statement not found

• 429

  Too many requests.

• default

  Unexpected Error.