CreditParsePro

Enable next-gen fintech innovations with creditparsepro.io: Our API parses fixed-length credit reports from major US bureaus, delivering ML ready JSON data.

# **Documentation** ## **Overview** This document is a comprehensive guide covering getting started, authentication, the API endpoints and responses, and the data provided. It serves as a reference for developers, data analysts, and other stakeholders to understand the formats and structures of the extracted credit report data. ## **Table of Contents** 1. [About](#about) 2. [Version](#version) 3. [Getting Started](#getting-started) 4. [Support](#support) 5. [Authentication](#authentication) 6. [Quota & Rate Limits](#quota--rate-limits) 7. [Error & Response Messages](#error--response-messages) 8. [Endpoints](#endpoints) - [POST v1/parse-report](#post-v1parse-report) - [Response](#response) - [Request Headers](#request-headers) - [Body](#body) - [Examples](#examples) - [GET v1/quota-info](#get-v1quota-info) - [Response](#response-1) - [Request Headers](#request-headers-1) - [Examples](#examples-1) - [GET v1/rate-info](#get-v1rate-info) - [Response](#response-2) - [Request Headers](#request-headers-2) - [Examples](#examples-2) 9. [Data Dictionary](#data-dictionary) - [Field Format Convetions](#field-format-conventions) - [Collections](#collections) - [Inquiries](#inquiries) - [Personal Information](#personal-information) - [Public Records](#public-records) - [Score](#score) - [Tradelines](#tradelines) - [Summary](#summary) - [Raw Segments](#raw-segments) --- ## About Are you struggling to leverage credit report data effectively for analytics and machine learning? Many loan origination systems provide credit report data in a cumbersome, fixed-format text. This not only hampers your ability to perform in-depth analysis but also requires navigating through extensive documentation and complex logic to parse the data. Introducing our API solution – the bridge to transforming traditional credit report data into a dynamic format ready for advanced fintech applications. Our software parses curated fields for both analytics and machine learning use-cases in a ready-to-use JSON format. Unlock the full potential of your data with our API, and step into a new era of financial technology applications. Say goodbye to outdated processes and embrace a future where your data works for you, enabling faster, more accurate decision-making. ## **Version** - **Current Version**: 1.4.0 - Effective date: 06/15/2025 - Summary - Tradelines - Mortgage - expanded current, delinquent, late stage delinquent status tracking - Installment - added excess obligations analysis for general non-categorized installments - Late payments - expanded 30/60/90 day tracking by tradeline type (revolving, mortgage, installment, auto, recreational) - Reworked installment non-student loan fields to exclude both student loans and mortgages - **1.3.0** - Effective date: 06/08/2025 - Segments - Tradelines - added `months_reviewed` field and `status` field with key-value mapping for current account status - Summary - Tradelines - Enhanced installment loan analysis excluding student loans and mortgages - Added auto/recreational loan categorization with specific delinquency tracking - Added period-based filtering (6+, 12+, 18+, 24+ payment periods) - Added status aggregations (current, delinquent, late stage delinquent) across account types - **1.2.0** - Effective date: 05/25/2025 - Segments - Tradelines - added ECOA codes for distinguishing joint vs individual credit accounts - Summary - Tradelines - Overall - Added recent delinquency indicators for most recent 1 and 3 period non-regular payments - Added worst delinquency metrics for 6, 12, and 24 period analysis - Enhanced delinquency detection with recent and worst delinquency metrics - New tradeline summary fields split by individual/joint designations - **1.1.0** - Effective date: 05/11/2025 - Segments - Tradelines - added payment history tracking - Collections - segment introduced including dates and balances - Public Records - added status and close dates - Summary - Tradelines - Overall - added 6, 12, 24 period payment history summaries with and without student loans - Installment - split out current summary fields to with and without student loans - Public Records - now differentiate between open and closed public records and bankruptcies - Collections - expanded to now include balances and differentiate between total and open counts - **1.0.0** - initial release ## Getting Started 1. Use our [Postman](https://documenter.getpostman.com/view/34164250/2sA3BgBFus) collection to test our API endpoints to ensure our product is right for you. And if you have further questions reach out to info@granum-tech.com. 2. Visit our [website](https://www.granum-tech.com/products/creditparsepro/) and pick a free or paid subscription plan via our Stripe integration. 3. Receive an automated email with your API key via our SendGrid integration. 4. Review our [documentation](/docs/documentation.md). ## Support Please contact us at [info@granum-tech.com](mailto:info@granum-tech.com) for suppoer and inquiries. ## **Authentication** Authenticate each request by including the request header `x-api-key`. This was sent to you via Email when signing up. It is okay to share your API key within your organization as there are no seat limits imposed only rate and quota limits. In the case that a key is lost please email us from the email used to signup at info@granum-tech.com. If an API key is missing, malformed, or invalid, you will receive an HTTP 401 Unauthorized response code. ## **Quota & Rate Limits** API access rate and quota limits apply at a per-API key basis in unit time. The rate and quota you are offered depends on the product subscription tier that you chose. If you would like to upgrade you can do so at any time in the [Stripe billing portal](https://billing.stripe.com/p/login/14kaHj8NX5LJ5Ta8ww). You can see our detailed product offerings on our [website](https://www.granum-tech.com/products/creditparsepro/). You can check your current rate and quota limits using the GET requests [GET v1/quota-info](#get-v1quota-info) and [GET v1/rate-info](#get-v1rate-info). If you either reach your quota or rate limit you will receive a 401 error message. ## **Error & Response Messages** If you receive a 200 response your request was successful. Otherwise potential errors are shown in the table below. | Error | Description | |----------------------|-------------------------------------------------------------------------------| | 400 | Bad Request: The request was malformed. Possibly due to a missing required parameter or a required parameter with an invalid value/data type.| | 401 | Unauthorized: The API key was missing or invalid. The rate or quota limit is at maximum.| | 500 | Internal Server Error: Likely an issue with the credit_report_text parameter formatting.| ## **Endpoints** ### **POST v1/parse-report** **Production:** `https://api.creditparsepro.io/v1/parse-report` **Test:** `https://test.creditparsepro.io/v1/parse-report` Parses fixed-format credit reports from major bureaus - automatically detecting the bureau and report version and returning data in JSON format. Successful POST requests do affect your quota and rate limits based on your product tier. #### **Response** See the [Data Dictionary](#data-dictionary) below for details or view and run examples directly in your browser on our [Postman](https://documenter.getpostman.com/view/34164250/2sA3BgBFus). #### **Request Headers** * `Content-Type: application/json` * `x-api-key: {{x-api-key}}` #### **Body** * `credit_report_text` - REQUIRED - Full text of the credit report. * `format` - OPTIONAL - Defaults to `complete` which includes `summary`. You can request `summary` on it's own. * `gross_monthly_income` - OPTIONAL - Used in calculating the `dti` field in the `summary` if provided. * `outcome` - OPTIONAL - Outcome indicator `0` or `1` accepted values. #### **Examples** View and run examples directly in your browser on our [Postman](https://documenter.getpostman.com/view/34164250/2sA3BgBFus). ### **GET v1/quota-info** **Production:** `https://api.creditparsepro.io/v1/quota-info` **Test:** `https://test.creditparsepro.io/v1/quota-info` This GET request retrieves your current quota usage, including the total allowed requests and the reset date. This request does not use up your quota and can be requested an unlimited amount of times. #### **Response** * `quota_count` - Total of successful requests used this month. * `quota_limit` - Your monthly request limit. * `quota_reset_date` - {yyyy-MM-dd hh:mm:ss} of when your quota_count will reset to 0. #### **Request Headers** * `Content-Type: application/json` * `x-api-key: {{x-api-key}}` #### **Examples** View and run examples directly in your browser on our [Postman](https://www.postman.com/granum-tech/creditpasrepro-demo/request/xfrvhg1/v1-quota-info). ### **GET v1/rate-info** **Production:** `https://api.creditparsepro.io/v1/rate-info` **Test:** `https://test.creditparsepro.io/v1/rate-info` This GET request provides information on your current rate limit, showing how many requests you can make per minute. This request does not use up your quota and can be requested an unlimited amount of times. #### **Response** * `last_request_minute` - {yyyy-MM-dd hh:mm:ss} this field is set when a successful request is made if there has been more than a minute passed. When it is set the rate_count is reset back to 0. * `rate_count` - Total of successful requests used this minute. * `rate_limit` - Your per minute request limit. #### **Request Headers** * `Content-Type: application/json` * `x-api-key: {{x-api-key}}` #### **Examples** View and run examples directly in your browser on our [Postman](https://documenter.getpostman.com/view/34164250/2sA3BgBFus). ## **Data Dictionary** ### **Field Format Conventions** - **Date Fields**: All date fields are ISO8601 format (`YYYY-MM-DD`). - **Currency Fields**: Represented as floats (e.g., `100.00` for $100.00). - **Boolean Fields**: Represented as `true` or `false`. - **Categorical Fields**: Represented as string values from a predefined list. --- ### **Collections** | Field Name | Type | Description | Example | Notes | |----------------------|-----------|---------------------------------------------------------------|-------------------|----------------------------------------| | `open_date` | Date | The date when the collection was opened. | `2023-09-15` | Format: ISO8601 (`YYYY-MM-DD`). | | `effective_date` | Date | The date when the collection became effective. | `2023-10-01` | Format: ISO8601 (`YYYY-MM-DD`). | | `closed_date` | Date | The date when the collection was closed. | `2024-02-15` | Format: ISO8601 (`YYYY-MM-DD`). | | `open_balance` | Integer | The current open balance on the collection. | `450` | In dollars. | | `total_balance` | Integer | The total balance of the collection. | `500` | In dollars. | ### **Inquiries** | Field Name | Type | Description | Example | Notes | |----------------------|-----------|-----------------------------------------------------------------------------|-------------------|----------------------------------------| | `inquiry_date` | Date | The date of the inquiry, formatted as `YYYY-MM-DD`. | `2025-01-01` | Parsed from segment-specific formats. | | `amount` | Integer | The amount associated with the inquiry, if applicable. | `5000` | May be `null` if no amount is provided.| | `inquiry_type.key` | String | The code representing the industry type of inquiry or portfolio. | `F` | Specific to each bureau's mapping, reach out to info@granum-tech.com for details.| | `inquiry_type.value` | String | The descriptive value corresponding to `inquiry_type.key`. | `Finance/personal`| Mapped from `inquiry_type.key`. | | `industry_type.key` | String | The code representing the industry type of the inquiry. | `07` | Specific to each bureau's mapping, reach out to info@granum-tech.com for details.| | `industry_type.value`| String | The descriptive value corresponding to `industry_type.key`. | `Charge Account` | Mapped from `industry_type.key`. | | `subscriber_name` | String | The name of the subscriber (creditor) that initiated the inquiry. | `CAPITAL ONE` | Extracted from subsegments or fields. | ### **Personal Information** | Field Name | Type | Description | Example | Notes | |---------------------------------|-----------|---------------------------------------------------|---------------------------|----------------------------------------| | `social_security_number` | String | Social Security Number of the individual. | `123456789` | | | `date_of_birth` | Date | The date of birth of the individual. | `1985-07-15` | Format: ISO8601 (`YYYY-MM-DD`). | | `names.first_name` | String | First name of the individual. | `JOHN` | All capitalized. | | `names.middle_name` | String | Middle name of the individual. | `A` | All capitalized. | | `names.last_name` | String | Last name of the individual. | `DOE` | All capitalized. | | `names.suffix` | String | Suffix of the individual (e.g., Jr., Sr.). | `JR` | All capitalized. | | `names.is_primary` | Boolean | Indicates if this is the primary name. | `1` | `1` for primary, `0` otherwise. | | `addresses.first_reported_date` | Date | The first date the address was reported. | `2020-01-01` | Format: ISO8601 (`YYYY-MM-DD`). | | `addresses.dwelling_type.key` | String | Code for the dwelling type. | `S` | Specific to each bureau's mapping, reach out to info@granum-tech.com for details.| | `addresses.dwelling_type.value` | String | Description of the dwelling type. | `Single-family dwelling` | Mapped from `dwelling_type.key`. | | `addresses.street_number` | String | Street number of the address. | `123` | | | `addresses.prefix` | String | Prefix direction of the street (e.g., N, S). | `N` | All capitalized. | | `addresses.street` | String | Street name of the address. | `MAIN ST` | | | `addresses.suffix` | String | Suffix direction of the street (e.g., Ave, Blvd). | `DR` | All capitalized. | | `addresses.unit` | String | Unit or apartment number. | `APT 4B` | All capitalized. | | `addresses.city` | String | City of the address. | `SPRINGFIELD` | All capitalized. | | `addresses.state` | String | State of the address. | `IL` | Format: 2-character state code. All capitalized. | | `addresses.zip` | String | ZIP code of the address. | `15211` or `152119998` | May include extended format. | | `addresses.is_most_recent` | Boolean | Indicates if this is the most recent address. | `1` | `1` for most recent, `0` otherwise. | | `employment.employer_name` | String | Name of the employer. | `ACME CORP` | All capitalized. Defaults to `Unknown` if not available.| | `employment.occupation` | String | Occupation or job title. | `SOFTWARE ENGINEER` | All capitalized. Defaults to `Unknown` if not available.| | `employment.reported_date` | Date | The date the employment was reported. | `2021-06-01` | Format: ISO8601 (`YYYY-MM-DD`). | | `employment.income` | Integer | Income reported for the job. | `75000` | Defaults to `null` if not available. | | `employment.pay_basis.key` | String | Code for the pay basis (e.g., H for Hourly). | `M` | Specific to each bureau's mapping, reach out to info@granum-tech.com for details.| | `employment.pay_basis.value` | String | Description of the pay basis. | `Monthly` | Mapped from `pay_basis.key`. | | `employment.is_most_recent` | Boolean | Indicates if this is the most recent employment. | `1` | `1` for most recent, `0` otherwise. | ### **Public Records** | Field Name | Type | Description | Example | Notes | |------------------------------------------------|-----------|--------------------------------------------------------------------|----------------|----------------------------------------| | `public_record_type.key` | String | Code for the type of public record. | `1X` | Specific to each bureau's mapping, reach out to info@granum-tech.com for details.| | `public_record_type.value` | String | Description of the public record type. | `Bankruptcy` | Mapped from `public_record_type.key`. | | `reference_number` | String | Reference number associated with the public record. | `125431` | May be masked or truncated. | | `plaintiff` | String | Name of the plaintiff or party associated with the public record. | `John Doe` | Defaults to `Unknown` if not available. | | `file_date` | Date | Date the public record was filed. | `2023-07-01` | Format: ISO8601 (`YYYY-MM-DD`). | | `amount` | Integer | Monetary amount associated with the public record (e.g., judgment amount).| `15000` | May be `null` if not applicable. | | `equal_credit_opportunity_act_designator.key` | String | Code for the ECOA (Equal Credit Opportunity Act) designator. | `I` | Specific to each bureau's mapping, reach out to info@granum-tech.com for details.| | `equal_credit_opportunity_act_designator.value`| String | Description of the ECOA designator. | `Individual` | Mapped from `equal_credit_opportunity_act_designator.key`. | | `status_date` | Date | The date when the public record status was last updated. | `2024-03-15` | Format: ISO8601 (`YYYY-MM-DD`). | | `closed_date` | Date | The date when the public record was closed. | `2024-04-10` | Format: ISO8601 (`YYYY-MM-DD`). | ### **Score** | Field Name | Type | Description | Example | Notes | |-----------------------------|----------|----------------------------------------------------------------------------|--------------------|----------------------------------------| | `score` | Integer | The calculated credit score. | `750` | May vary by bureau and score model. | | `sign` | String | Indicates whether the score is positive (+) or negative (-). | `+` | Can be `+` or `-` | | `score_factor_1.key` | String | Code for the first score factor. | `01` | Specific to each bureau's mapping, reach out to info@granum-tech.com for details.| | `score_factor_1.value` | String | Description of the first score factor. | `HIGH CREDIT USAGE`| Mapped from `score_factor_1.key`. | | `score_factor_2.key` | String | Code for the second score factor. | `02` | Specific to each bureau's mapping, reach out to info@granum-tech.com for details.| | `score_factor_2.value` | String | Description of the second score factor. | `MISSED PAYMENTS` | Mapped from `score_factor_2.key`. | | `score_factor_3.key` | String | Code for the third score factor. | `03` | Specific to each bureau's mapping, reach out to info@granum-tech.com for details.| | `score_factor_3.value` | String | Description of the third score factor. | `LIMITED HISTORY` | Mapped from `score_factor_3.key`. | | `score_factor_4.key` | String | Code for the fourth score factor. | `04` | Specific to each bureau's mapping, reach out to info@granum-tech.com for details.| | `score_factor_4.value` | String | Description of the fourth score factor. | `NEW ACCOUNTS` | Mapped from `score_factor_4.key`. | | `service_model` | String | Code indicating the service or model used to calculate the score. | `P00W40` | Prefixed `P` for certain codes. | ### **Tradelines** | Field Name | Type | Description | Example | Notes | |----------------------------------|----------|------------------------------------------------------------------------|-----------------------|----------------------------------------| | `account_number` | String | The account number associated with the tradeline. | `1234567890` | | | `open_date` | Date | The date when the account was opened. | `2021-01-01` | Format: ISO8601 (`YYYY-MM-DD`). | | `close_date` | Date | The date when the account was closed. | `2022-12-31` | Format: ISO8601 (`YYYY-MM-DD`). Empty if the account is still open.| | `is_open` | Boolean | Indicates if the account is currently open. | `1` | `1` for open, `0` for closed. | | `portfolio_type.key` | String | Code for the portfolio type of the tradeline. | `R` | Specific to each bureau's mapping, reach out to info@granum-tech.com for details.| | `portfolio_type.value` | String | Description of the portfolio type. | `Revolving` | Mapped from `portfolio_type.key`. | | `current_balance` | Integer | The current balance on the account. | `5000` | May be `0` if account is paid off. | | `original_balance` | Integer | The original balance on the account. | `10000` | Not applicable for all types. `0` if not applicable. | | `high_balance_amount` | Integer | The highest balance ever recorded on the account. | `8000` | Not applicable for all types. `0` if not applicable. | | `credit_limit_amount` | Integer | The credit limit for the account. | `10000` | Not applicable for all types. `0` if not applicable. | | `past_due_amount` | Integer | The amount currently past due. | `200` | May be `0` if no past due balance. | | `maximum_delinquency_date` | Date | The date of the most severe delinquency recorded on the account. | `2022-06-01` | Format: ISO8601 (`YYYY-MM-DD`). Can be empty.| | `maximum_delinquency_amount` | Integer | The highest past due amount recorded on the account. | `300` | | | `times_30_days_late` | Integer | Number of times the account was 30 days late on payments. | `2` | Defaults to `0`. | | `times_60_days_late` | Integer | Number of times the account was 60 days late on payments. | `1` | Defaults to `0`. | | `times_90_days_late` | Integer | Number of times the account was 90+ days late on payments. | `0` | Defaults to `0`. | | `term` | Integer | The repayment term for accounts in months. | `60` | Defaults to `0`. | | `monthly_payment` | Integer | The scheduled monthly payment amount for the account. | `200` | Defaults to `0`. | | `last_payment_date` | Date | The date of the last payment made on the account. | `2022-11-01` | Format: ISO8601 (`YYYY-MM-DD`). Can be empty.| | `payment_history` | String | The payment history for this tradeline account, typically a sequence of codes. | `111211111111` | Each character represents payment status for a period where the leftmost is the most recent. Depending on the bureau this will be different i.e. `C` vs `1` please consult your bureau documentation or reach out for assistance. | | `months_reviewed` | Integer | Number of months of payment history reviewed for this tradeline. | `24` | Used for filtering in summary calculations. | | `status.key` | String | Code for the current account status. | `R1` | Specific to each bureau's mapping, reach out to info@granum-tech.com for details.| | `status.value` | String | Human-readable description of the account status. | `Current account` | Mapped from `status.key`. | | `ecoa_code.key` | String | Code for account ownership (e.g., individual, joint, authorized user). | `A` | Mapping based on bureau (see docs). | | `ecoa_code.value` | String | Human-readable description of the ECOA code. | `Authorized User` | Mapped from `ecoa_code.key`. | ### **Summary** | Field Name | Type | Description | Example | Notes | |---------------------------------------------------|------------|------------------------------------------------------------------------------|---------------------|------------------------------| | `date` | String | The date the credit report was generated. | `2025-01-01` | Format: ISO8601 (`YYYY-MM-DD`).| | `age` | Integer | The individual's age, calculated from the date of birth. | `35` | Based on the report's date. | | `score` | Integer | Credit score of the individual. | `750` | | | `dti` | Float | Debt-to-income ratio, calculated if `gross_monthly_income` is provided. | `25.5` | Rounded to 2 decimal places. | | `tradelines.overall.total_accounts` | Integer | Total number of tradelines in the credit report. | `15` | | | `tradelines.overall.open_accounts` | Integer | Number of open tradelines in the report. | `5` | | | `tradelines.overall.total_monthly_payments` | Float | Total monthly payment amounts across all tradelines. | `1200.50` | | | `tradelines.overall.oldest_open_date_months` | Integer | Age of the oldest open tradeline, in months. | `120` | | | `tradelines.overall.regular_payment_count_past_6_periods` | Integer | Count of regular payments in the past 6 months. | `5` | | | `tradelines.overall.non_regular_payment_count_past_6_periods` | Integer | Count of non-regular payments in the past 6 months. | `1` | | | `tradelines.overall.regular_payment_count_past_12_periods` | Integer | Count of regular payments in the past 12 months. | `10` | | | `tradelines.overall.non_regular_payment_count_past_12_periods` | Integer | Count of non-regular payments in the past 12 months. | `2` | | | `tradelines.overall.regular_payment_count_past_24_periods` | Integer | Count of regular payments in the past 24 months. | `20` | | | `tradelines.overall.non_regular_payment_count_past_24_periods` | Integer | Count of non-regular payments in the past 24 months. | `4` | | | `tradelines.overall.non_regular_payment_percent_past_6_periods` | Float | Percentage of non-regular payments in the past 6 months. | `16.67` | Changed from Integer to Float in v1.3.0. | | `tradelines.overall.non_regular_payment_percent_past_12_periods` | Float | Percentage of non-regular payments in the past 12 months. | `16.67` | Changed from Integer to Float in v1.3.0. | | `tradelines.overall.non_regular_payment_percent_past_24_periods` | Float | Percentage of non-regular payments in the past 24 months. | `16.67` | Changed from Integer to Float in v1.3.0. | | `tradelines.overall.non_regular_payment_percent_past_6_periods_worst` | Float | Highest non-regular % in the past 6 months from any single tradeline. | `83.33` | Reflects worst-performing tradeline only. | | `tradelines.overall.non_regular_payment_percent_past_6_periods_worst_open`| Float | Same as above but only considering open tradelines. | `66.67` | Only includes open tradelines. | | `tradelines.overall.non_regular_payment_percent_past_12_periods_worst` | Float | Highest non-regular % in past 12 months from any tradeline. | `91.67` | Reflects single worst tradeline. | | `tradelines.overall.non_regular_payment_percent_past_12_periods_worst_open`| Float | Highest non-regular % in past 12 months from open tradelines only. | `75.00` | Open tradelines only. | | `tradelines.overall.non_regular_payment_percent_past_24_periods_worst` | Float | Highest non-regular % in past 24 months from any tradeline. | `80.00` | Reflects worst of all. | | `tradelines.overall.non_regular_payment_percent_past_24_periods_worst_open`| Float | Same as above but restricted to open tradelines. | `64.00` | Open tradelines only. | | `tradelines.overall.regular_payment_count_no_student_loans_past_6_periods` | Integer | Count of regular payments in the past 6 months excluding student loans. | `4` | | | `tradelines.overall.non_regular_payment_count_no_student_loans_past_6_periods` | Integer | Count of non-regular payments in the past 6 months excluding student loans. | `1` | | | `tradelines.overall.regular_payment_count_no_student_loans_past_12_periods` | Integer | Count of regular payments in the past 12 months excluding student loans. | `9` | | | `tradelines.overall.non_regular_payment_count_no_student_loans_past_12_periods` | Integer | Count of non-regular payments in the past 12 months excluding student loans. | `2` | | | `tradelines.overall.regular_payment_count_no_student_loans_past_24_periods` | Integer | Count of regular payments in the past 24 months excluding student loans. | `18` | | | `tradelines.overall.non_regular_payment_count_no_student_loans_past_24_periods` | Integer | Count of non-regular payments in the past 24 months excluding student loans. | `4` | | | `tradelines.overall.non_regular_payment_percent_no_student_loans_past_6_periods`| Float | Percentage of non-regular payments excluding student loans in past 6 months. | `20.0` | Changed from Integer to Float in v1.3.0. | | `tradelines.overall.non_regular_payment_percent_no_student_loans_past_12_periods`| Float | Percentage of non-regular payments excluding student loans in past 12 months. | `18.18` | Changed from Integer to Float in v1.3.0. | | `tradelines.overall.non_regular_payment_percent_no_student_loans_past_24_periods`| Float | Percentage of non-regular payments excluding student loans in past 24 months. | `18.18` | Changed from Integer to Float in v1.3.0. | | `tradelines.overall.non_regular_payment_percent_no_student_loans_past_6_periods_worst` | Float | Worst-performing tradeline excluding student loans in past 6 months. | `85.00` | Filters out student loans. | | `tradelines.overall.non_regular_payment_percent_no_student_loans_past_6_periods_worst_open` | Float | Same as above but only for open tradelines. | `75.00` | Open tradelines only. | | `tradelines.overall.non_regular_payment_percent_no_student_loans_past_12_periods_worst` | Float | Worst-performing tradeline excluding student loans in past 12 months. | `90.00` | Excludes student loans. | | `tradelines.overall.non_regular_payment_percent_no_student_loans_past_12_periods_worst_open` | Float | Same as above but only for open tradelines. | `70.00` | Excludes closed tradelines. | | `tradelines.overall.non_regular_payment_percent_no_student_loans_past_24_periods_worst` | Float | Worst-performing tradeline excluding student loans in past 24 months. | `77.77` | Filters out student loans. | | `tradelines.overall.non_regular_payment_percent_no_student_loans_past_24_periods_worst_open` | Float | Same as above but only for open tradelines. | `60.00` | Open tradelines only. | | `tradelines.overall.total_count_current` | Integer | Count of current accounts across all tradeline types. | `12` | | | `tradelines.overall.total_count_delinquent` | Integer | Count of delinquent accounts across all tradeline types. | `2` | | | `tradelines.overall.total_count_late_stage_delinquent` | Integer | Count of late-stage delinquent accounts across all tradeline types. | `1` | | | `tradelines.overall.total_count_gte_6_period_auto` | Integer | Count of auto accounts ≥6 periods old. | `3` | | | `tradelines.overall.total_count_gte_6_period_installment` | Integer | Count of installment accounts ≥6 periods old. | `8` | | | `tradelines.overall.total_count_gte_6_period_installment_no_student_loans` | Integer | Count of non-student loan installment accounts ≥6 periods old. | `5` | | | `tradelines.overall.total_count_gte_6_period_installment_no_student_loans_no_mortgage` | Integer | Count of non-student loan, non-mortgage installment accounts ≥6 periods old. | `4` | | | `tradelines.overall.total_count_gte_6_period_recreational` | Integer | Count of recreational accounts ≥6 periods old. | `2` | | | `tradelines.overall.total_count_gte_12_period_auto` | Integer | Count of auto accounts ≥12 periods old. | `3` | | | `tradelines.overall.total_count_gte_12_period_installment` | Integer | Count of installment accounts ≥12 periods old. | `7` | | | `tradelines.overall.total_count_gte_12_period_installment_no_student_loans` | Integer | Count of non-student loan installment accounts ≥12 periods old. | `4` | | | `tradelines.overall.total_count_gte_12_period_installment_no_student_loans_no_mortgage` | Integer | Count of non-student loan, non-mortgage installment accounts ≥12 periods old. | `3` | | | `tradelines.overall.total_count_gte_12_period_recreational` | Integer | Count of recreational accounts ≥12 periods old. | `1` | | | `tradelines.overall.total_count_gte_18_period_auto` | Integer | Count of auto accounts ≥18 periods old. | `2` | | | `tradelines.overall.total_count_gte_18_period_installment` | Integer | Count of installment accounts ≥18 periods old. | `6` | | | `tradelines.overall.total_count_gte_18_period_installment_no_student_loans` | Integer | Count of non-student loan installment accounts ≥18 periods old. | `3` | | | `tradelines.overall.total_count_gte_18_period_installment_no_student_loans_no_mortgage` | Integer | Count of non-student loan, non-mortgage installment accounts ≥18 periods old. | `2` | | | `tradelines.overall.total_count_gte_18_period_recreational` | Integer | Count of recreational accounts ≥18 periods old. | `1` | | | `tradelines.overall.total_count_gte_24_period_auto` | Integer | Count of auto accounts ≥24 periods old. | `2` | | | `tradelines.overall.total_count_gte_24_period_installment` | Integer | Count of installment accounts ≥24 periods old. | `5` | | | `tradelines.overall.total_count_gte_24_period_installment_no_student_loans` | Integer | Count of non-student loan installment accounts ≥24 periods old. | `2` | | | `tradelines.overall.total_count_gte_24_period_installment_no_student_loans_no_mortgage` | Integer | Count of non-student loan, non-mortgage installment accounts ≥24 periods old. | `1` | | | `tradelines.overall.total_count_gte_24_period_recreational` | Integer | Count of recreational accounts ≥24 periods old. | `1` | | | `tradelines.revolving.is_most_recent_period_open_non_regular_revolving` | Boolean | Most recent revolving tradeline period was non-regular. | `0` | | | `tradelines.revolving.is_most_recent_3_period_open_non_regular_revolving` | Boolean | Most recent 3 periods of revolving tradelines had irregularities. | `0` | | | `tradelines.revolving.open_sum` | Float | Total credit limit for open revolving tradelines. | `20000.00` | | | `tradelines.revolving.open_sum_individual` | Float | Total balance of open individual revolving tradelines. | `41219.0` | | | `tradelines.revolving.open_sum_joint` | Float | Total balance of open joint revolving tradelines. | `0.0` | | | `tradelines.revolving.open_sum_percent_joint` | Float | Percentage of open revolving balance from joint tradelines. | `0.0` | Percentage value. | | `tradelines.revolving.open_count` | Integer | Number of open revolving tradelines. | `3` | | | `tradelines.revolving.open_count_joint` | Integer | Open revolving tradelines jointly owned. | `0` | | | `tradelines.revolving.open_count_individual` | Integer | Open revolving tradelines individually owned. | `8` | | | `tradelines.revolving.total_count` | Integer | Total number of revolving tradelines. | `5` | | | `tradelines.revolving.total_count_joint` | Integer | Total revolving tradelines jointly owned. | `0` | | | `tradelines.revolving.total_count_individual` | Integer | Total revolving tradelines individually owned. | `10` | | | `tradelines.revolving.revolving_utilization_ratio`| Float | Credit utilization ratio for revolving tradelines. | `30.0` | Percentage value. | | `tradelines.revolving.revolving_utilization_ratio_joint` | Float | Utilization ratio of revolving joint tradelines. | `0.0` | | | `tradelines.revolving.revolving_utilization_ratio_individual` | Float | Utilization ratio of revolving individual tradelines. | `79.19` | | | `tradelines.revolving.open_count_percent_joint` | Float | Percentage of open joint revolving accounts. | `0.0` | Changed from Integer to Float in v1.3.0. | | `tradelines.revolving.open_sum_percent_joint` | Float | Percentage of open revolving balance from joint tradelines. | `0.0` | Changed from Integer to Float in v1.3.0. | | `tradelines.revolving.total_count_percent_joint` | Float | Percentage of total joint revolving accounts. | `0.0` | Changed from Integer to Float in v1.3.0. | | `tradelines.revolving.total_count_current` | Integer | Count of current revolving accounts. | `8` | | | `tradelines.revolving.total_count_delinquent` | Integer | Count of delinquent revolving accounts. | `1` | | | `tradelines.revolving.total_count_late_stage_delinquent` | Integer | Count of late-stage delinquent revolving accounts. | `0` | | | `tradelines.installment.is_most_recent_period_open_non_regular_installment` | Boolean | Whether the most recent installment tradeline period was non-regular. | `0` | Only includes open tradelines. | | `tradelines.installment.is_most_recent_3_period_open_non_regular_installment` | Boolean | Whether the last 3 periods of open installment tradelines had issues. | `0` | | | `tradelines.installment.open_count` | Integer | Number of open installment tradelines. | `2` | | | `tradelines.installment.open_count_joint` | Integer | Open installment tradelines with joint ownership. | `3` | | | `tradelines.installment.open_count_individual` | Integer | Open installment tradelines with individual ownership. | `0` | | | `tradelines.installment.total_count` | Integer | Total number of installment tradelines. | `4` | | | `tradelines.installment.total_count_joint` | Integer | Total installment tradelines that are joint. | `15` | | | `tradelines.installment.total_count_individual` | Integer | Total installment tradelines that are individual. | `3` | | | `tradelines.installment.installment_utilization_ratio` | Float | Utilization ratio for installment tradelines. | `70.0` | Percentage value. | | `tradelines.installment.installment_utilization_ratio_individual` | Float | Installment utilization for individually-owned tradelines. | `0.0` | | | `tradelines.installment.installment_utilization_ratio_joint` | Float | Installment utilization for jointly-owned tradelines. | `94.64` | | | `tradelines.installment.open_sum` | Float | Total balance for open installment tradelines. | `5000.00` | | | `tradelines.installment.open_sum_individual` | Float | Total balance of open individual installment tradelines. | `0.0` | | | `tradelines.installment.open_sum_joint` | Float | Total balance of open joint installment tradelines. | `290949.0` | | | `tradelines.installment.open_sum_percent_joint` | Float | Percentage of open installment balance from joint tradelines. | `100.0` | Changed from Integer to Float in v1.3.0. | | `tradelines.installment.installment_utilization_ratio_no_student_loans` | Float | Utilization ratio for installment tradelines excluding student loans. | `65.0` | Percentage value. | | `tradelines.installment.installment_utilization_ratio_no_student_loans_joint` | Float | Utilization ratio excluding student loans for joint tradelines. | `94.64` | | | `tradelines.installment.installment_utilization_ratio_no_student_loans_individual` | Float | Same as above for individual tradelines. | `0.0` | | | `tradelines.installment.open_count_no_student_loans` | Integer | Number of open installment tradelines excluding student loans. | `2` | | | `tradelines.installment.open_sum_no_student_loans` | Float | Total balance for open installment tradelines excluding student loans. | `4200.00` | | | `tradelines.installment.open_sum_no_student_loans` | Float | Open installment balance excluding student loans. | `290949.0` | | | `tradelines.installment.open_sum_no_student_loans_individual` | Float | Open individual installment balance excluding student loans. | `0.0` | | | `tradelines.installment.open_sum_no_student_loans_joint` | Float | Open joint installment balance excluding student loans. | `290949.0` | | | `tradelines.installment.open_sum_no_student_loans_percent_joint` | Float | Percentage of open installment balance from joint tradelines (no student loans). | `100.0` | Changed from Integer to Float in v1.3.0. | | `tradelines.installment.total_count_no_student_loans` | Integer | Total number of installment tradelines excluding student loans. | `3` | | | `tradelines.installment.auto_open_count` | Integer | Count of open auto installment accounts. | `2` | | | `tradelines.installment.auto_total_count` | Integer | Total count of auto installment accounts. | `3` | | | `tradelines.installment.recreational_open_count` | Integer | Count of open recreational installment accounts. | `1` | | | `tradelines.installment.recreational_total_count` | Integer | Total count of recreational installment accounts. | `2` | | | `tradelines.installment.original_open_sum` | Float | Total original balance of open installment accounts. | `35000.0` | | | `tradelines.installment.original_total_sum` | Float | Total original balance of all installment accounts. | `50000.0` | | | `tradelines.installment.original_sum_no_student_loans` | Float | Total original balance excluding student loans. | `40000.0` | | | `tradelines.installment.original_sum_no_student_loans_no_mortgage` | Float | Total original balance excluding student loans and mortgages. | `35000.0` | | | `tradelines.installment.average_original_sum_no_student_loans_no_mortgage` | Float | Average original balance excluding student loans and mortgages. | `17500.0` | | | `tradelines.installment.average_original_sum_no_student_loans_no_mortgage_gte_18_periods` | Float | Average original balance for accounts ≥18 periods old. | `20000.0` | | | `tradelines.installment.maximum_single_original_sum_no_student_loans_no_mortgage` | Float | Highest single original balance excluding student loans and mortgages. | `25000.0` | | | `tradelines.installment.maximum_single_original_sum_no_student_loans_no_mortgage_gte_18_periods` | Float | Highest single original balance for accounts ≥18 periods old. | `25000.0` | | | `tradelines.installment.is_most_recent_6_period_non_regular_auto` | Boolean | Most recent 6 periods of auto tradelines had non-regular payments. | `0` | | | `tradelines.installment.is_most_recent_6_period_open_non_regular_auto` | Boolean | Most recent 6 periods of open auto tradelines had non-regular payments. | `0` | | | `tradelines.installment.is_most_recent_6_period_non_regular_recreational` | Boolean | Most recent 6 periods of recreational tradelines had non-regular payments. | `0` | | | `tradelines.installment.is_most_recent_6_period_open_non_regular_recreational` | Boolean | Most recent 6 periods of open recreational tradelines had non-regular payments.| `0` | | | `tradelines.installment.is_most_recent_12_period_non_regular_auto` | Boolean | Most recent 12 periods of auto tradelines had non-regular payments. | `0` | | | `tradelines.installment.is_most_recent_12_period_open_non_regular_auto` | Boolean | Most recent 12 periods of open auto tradelines had non-regular payments. | `0` | | | `tradelines.installment.is_most_recent_12_period_non_regular_recreational` | Boolean | Most recent 12 periods of recreational tradelines had non-regular payments. | `0` | | | `tradelines.installment.is_most_recent_12_period_open_non_regular_recreational` | Boolean | Most recent 12 periods of open recreational tradelines had non-regular payments.| `0` | | | `tradelines.installment.is_most_recent_18_period_non_regular_auto` | Boolean | Most recent 18 periods of auto tradelines had non-regular payments. | `0` | | | `tradelines.installment.is_most_recent_18_period_open_non_regular_auto` | Boolean | Most recent 18 periods of open auto tradelines had non-regular payments. | `0` | | | `tradelines.installment.is_most_recent_18_period_non_regular_recreational` | Boolean | Most recent 18 periods of recreational tradelines had non-regular payments. | `0` | | | `tradelines.installment.is_most_recent_18_period_open_non_regular_recreational` | Boolean | Most recent 18 periods of open recreational tradelines had non-regular payments.| `0` | | | `tradelines.installment.is_most_recent_24_period_non_regular_auto` | Boolean | Most recent 24 periods of auto tradelines had non-regular payments. | `0` | | | `tradelines.installment.is_most_recent_24_period_open_non_regular_auto` | Boolean | Most recent 24 periods of open auto tradelines had non-regular payments. | `0` | | | `tradelines.installment.is_most_recent_24_period_non_regular_recreational` | Boolean | Most recent 24 periods of recreational tradelines had non-regular payments. | `0` | | | `tradelines.installment.is_most_recent_24_period_open_non_regular_recreational` | Boolean | Most recent 24 periods of open recreational tradelines had non-regular payments.| `0` | | | `tradelines.installment.total_count_current` | Integer | Count of current installment accounts. | `8` | | | `tradelines.installment.total_count_current_auto` | Integer | Count of current auto installment accounts. | `3` | | | `tradelines.installment.total_count_current_recreational` | Integer | Count of current recreational installment accounts. | `2` | | | `tradelines.installment.total_count_current_no_student_loans_no_mortgage` | Integer | Count of current installment accounts excluding student loans and mortgages. | `5` | | | `tradelines.installment.total_count_delinquent` | Integer | Count of delinquent installment accounts. | `1` | | | `tradelines.installment.total_count_delinquent_auto` | Integer | Count of delinquent auto installment accounts. | `0` | | | `tradelines.installment.total_count_delinquent_recreational` | Integer | Count of delinquent recreational installment accounts. | `0` | | | `tradelines.installment.total_count_delinquent_no_student_loans_no_mortgage` | Integer | Count of delinquent installment accounts excluding student loans and mortgages. | `1` | | | `tradelines.installment.total_count_late_stage_delinquent` | Integer | Count of late-stage delinquent installment accounts. | `0` | | | `tradelines.installment.total_count_late_stage_delinquent_auto` | Integer | Count of late-stage delinquent auto installment accounts. | `0` | | | `tradelines.installment.total_count_late_stage_delinquent_recreational` | Integer | Count of late-stage delinquent recreational installment accounts. | `0` | | | `tradelines.installment.total_count_late_stage_delinquent_no_student_loans_no_mortgage` | Integer | Count of late-stage delinquent installment accounts excluding student loans and mortgages. | `0` | | | `tradelines.installment.total_count_excess_obligations` | Integer | Count of excess obligation installment accounts (non-mortgage, non-student loan, non-auto, non-recreational). | `2` | | | `tradelines.installment.open_count_excess_obligations` | Integer | Count of open excess obligation installment accounts. | `1` | | | `tradelines.installment.original_open_sum_excess_obligations` | Float | Total original balance of open excess obligation installment accounts. | `15000.0` | | | `tradelines.installment.open_sum_excess_obligations` | Float | Total current balance of open excess obligation installment accounts. | `8500.0` | | | `tradelines.auto_recreational.open_count` | Integer | Number of open auto/recreational tradelines. | `2` | | | `tradelines.auto_recreational.total_count` | Integer | Total number of auto/recreational tradelines. | `3` | | | `tradelines.auto_recreational.is_most_recent_period_open_non_regular_auto_recreational` | Boolean | Most recent period of auto/recreational tradeline was non-regular. | `0` | | | `tradelines.auto_recreational.is_most_recent_3_period_open_non_regular_auto_recreational` | Boolean | Last 3 periods of open auto/recreational tradelines had irregularities. | `0` | | | `tradelines.mortgage.is_most_recent_period_open_non_regular_mortgage` | Boolean | Most recent period of mortgage tradeline was non-regular. | `0` | | | `tradelines.mortgage.is_most_recent_3_period_open_non_regular_mortgage` | Boolean | Last 3 periods of open mortgage tradelines had payment irregularities.| `0` | | `tradelines.mortgage.open_count` | Integer | Number of open mortgage tradelines. | `1` | | | `tradelines.mortgage.total_count` | Integer | Total number of mortgage tradelines. | `1` | | | `tradelines.mortgage.total_count_current` | Integer | Count of current mortgage accounts. | `1` | | | `tradelines.mortgage.total_count_delinquent` | Integer | Count of delinquent mortgage accounts. | `0` | | | `tradelines.mortgage.total_count_late_stage_delinquent` | Integer | Count of late-stage delinquent mortgage accounts. | `0` | | | `tradelines.credit.open_count` | Integer | Number of open credit tradelines. | `4` | | | `tradelines.credit.total_count` | Integer | Total number of credit tradelines. | `6` | | | `tradelines.period_filtering.open_count_6_plus_periods` | Integer | Number of open tradelines with 6+ payment periods. | `8` | | | `tradelines.period_filtering.open_count_12_plus_periods` | Integer | Number of open tradelines with 12+ payment periods. | `7` | | | `tradelines.period_filtering.open_count_18_plus_periods` | Integer | Number of open tradelines with 18+ payment periods. | `6` | | | `tradelines.period_filtering.open_count_24_plus_periods` | Integer | Number of open tradelines with 24+ payment periods. | `5` | | | `tradelines.status_aggregations.current_count` | Integer | Number of tradelines with current status. | `7` | | | `tradelines.status_aggregations.delinquent_count` | Integer | Number of tradelines with delinquent status. | `1` | | | `tradelines.status_aggregations.late_stage_delinquent_count` | Integer | Number of tradelines with late stage delinquent status. | `0` | | | `tradelines.status_aggregations.current_count_open` | Integer | Number of open tradelines with current status. | `5` | | | `tradelines.status_aggregations.delinquent_count_open` | Integer | Number of open tradelines with delinquent status. | `1` | | | `tradelines.status_aggregations.late_stage_delinquent_count_open` | Integer | Number of open tradelines with late stage delinquent status. | `0` | | | `address.change_count` | Integer | Number of address changes recorded. | `3` | Excludes current address. | | `address.months_at_current_address` | Float | Duration of stay at the current address, in months. | `24.5` | Rounded to 2 decimal places. | | `address.address_changes_per_year` | Float | Average number of address changes per year. | `0.5` | | | `address.state` | String | The state abbreviation of the current address. | `CA` | Lowercased. | | `address.zip` | String | The ZIP code of the current address. | `90210` | | | `employment.months_at_current_employer` | Float | Duration of employment at the current job, in months. | `18.5` | Rounded to 2 decimal places. | | `delinquencies.past_due.open_count` | Integer | Number of open past-due tradelines. | `1` | | | `delinquencies.past_due.total_count` | Integer | Total number of past-due tradelines. | `3` | | | `delinquencies.past_due.open_sum` | Float | Total balance of open past-due tradelines. | `2000.00` | | | `delinquencies.times_late.30_days_sum` | Integer | Total count of 30-day late payment instances. | `2` | | | `delinquencies.times_late.60_days_sum` | Integer | Total count of 60-day late payment instances. | `1` | | | `delinquencies.times_late.90_days_sum` | Integer | Total count of 90-day late payment instances. | `0` | | | `tradelines.revolving.30_days_sum` | Integer | Total count of 30-day late payments on revolving accounts. | `2` | | | `tradelines.revolving.60_days_sum` | Integer | Total count of 60-day late payments on revolving accounts. | `1` | | | `tradelines.revolving.90_days_sum` | Integer | Total count of 90-day late payments on revolving accounts. | `0` | | | `tradelines.mortgage.30_days_sum` | Integer | Total count of 30-day late payments on mortgage accounts. | `0` | | | `tradelines.mortgage.60_days_sum` | Integer | Total count of 60-day late payments on mortgage accounts. | `0` | | | `tradelines.mortgage.90_days_sum` | Integer | Total count of 90-day late payments on mortgage accounts. | `0` | | | `tradelines.installment.30_days_sum` | Integer | Total count of 30-day late payments on installment accounts. | `1` | | | `tradelines.installment.60_days_sum` | Integer | Total count of 60-day late payments on installment accounts. | `0` | | | `tradelines.installment.90_days_sum` | Integer | Total count of 90-day late payments on installment accounts. | `0` | | | `tradelines.installment.30_days_sum_no_student_loans_no_mortgage` | Integer | Total count of 30-day late payments on installment accounts (excluding student loans and mortgages). | `1` | | | `tradelines.installment.60_days_sum_no_student_loans_no_mortgage` | Integer | Total count of 60-day late payments on installment accounts (excluding student loans and mortgages). | `0` | | | `tradelines.installment.90_days_sum_no_student_loans_no_mortgage` | Integer | Total count of 90-day late payments on installment accounts (excluding student loans and mortgages). | `0` | | | `tradelines.installment.30_days_sum_auto` | Integer | Total count of 30-day late payments on auto installment accounts. | `0` | | | `tradelines.installment.60_days_sum_auto` | Integer | Total count of 60-day late payments on auto installment accounts. | `0` | | | `tradelines.installment.90_days_sum_auto` | Integer | Total count of 90-day late payments on auto installment accounts. | `0` | | | `tradelines.installment.30_days_sum_recreational` | Integer | Total count of 30-day late payments on recreational installment accounts. | `0` | | | `tradelines.installment.60_days_sum_recreational` | Integer | Total count of 60-day late payments on recreational installment accounts. | `0` | | | `tradelines.installment.90_days_sum_recreational` | Integer | Total count of 90-day late payments on recreational installment accounts. | `0` | | | `public_records.total_count` | Integer | Total count of all public records. | `2` | | | `public_records.total_open_count` | Integer | Count of open public records. | `1` | | | `public_records.total_bankruptcy_count` | Integer | Total count of bankruptcy records. | `1` | | | `public_records.total_open_bankruptcy_count` | Integer | Count of open bankruptcy records. | `0` | | | `collections.count` | Integer | Total count of all collections. | `3` | | | `collections.open_count` | Integer | Count of open collections. | `1` | | | `collections.open_balance` | Float | Total balance of open collections. | `450.00` | | | `collections.total_balance` | Float | Total balance of all collections. | `950.00` | | | `inquiries.total_count` | Integer | Total number of credit inquiries. | `6` | | | `inquiries.past_6_months_count` | Integer | Number of inquiries in the past 6 months. | `3` | | ### Raw Segments | Field Name | Descriptions | |-------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------| | `collections` | Raw data from the credit report used to provide the fields returned in the `collections` and `summary` sections. | | `inquiries` | Raw data from the credit report used to provide the fields returned in the `inquiries` and `summary` sections. | | `personal_information` | Raw data from the credit report used to provide the fields returned in the `personal_information` and `summary` sections. | | `public_records` | Raw data from the credit report used to provide the fields returned in the `public_records` and `summary` sections. | | `score` | Raw data from the credit report used to provide the fields returned in the `score` and `summary` sections. | | `tradelines` | Raw data from the credit report used to provide the fields returned in the `tradelines` and `summary` sections. | | `additional_summary_segments` | Raw data from the credit report used to provide the fields returned in the `summary` section that were not covered in the prior sections. |