---
title: "Match partner liabilities to a credit report"
method: POST
path: "/v1/users/{userId}/liabilities/match"
tags: ["Debt Profile"]
---

# Match partner liabilities to a credit report

`POST /v1/users/{userId}/liabilities/match`

## Request

- Base URL: `https://sandbox-api.spinwheel.io`
- URL: `https://sandbox-api.spinwheel.io/v1/users/{userId}/liabilities/match`
- Auth: one of:
  - API key in header `Authorization`
  - API key in header `Authorization`

Validates partner-submitted liabilities so they can be matched to the user's credit report to enable payments. Rejects the request if the user has not completed Connect, a match is already in progress, or this partner has already matched liabilities for the user. A TransUnion file with a fraud indicator is HTTP 200 and creditReports[].reportStatus.status is FRAUD_INDICATOR. A frozen file with usable report data is HTTP 200 and reportStatus.status is FROZEN_REPORT. A frozen file with no usable report data, and a locked file, are HTTP 400.

## Path parameters

- `userId` string, required

## Request body

- MatchLiabilitiesRequest
  - `liabilities` MatchLiabilityRequest[], required: Liabilities to match. Minimum 1, maximum 75. Duplicate extLiabilityId values are rejected.
    - `extLiabilityId` string, required: Partner's own liability identifier. Must be unique within the request.
    - `creditorName` string, required: Name of the creditor.
    - `bureauSubscriberCode` string, required: Bureau subscriber code for the liability.
    - `accountNumber` string, required: Account number as held by the partner.
    - `liabilityType` 'STUDENT_LOAN' | 'CREDIT_CARD' | 'AUTO_LOAN' | 'HOME_LOAN' | 'PERSONAL_LOAN' | 'MISCELLANEOUS_LIABILITY', required: Spinwheel liability type.
    - `liabilitySubtype` string, required: Partner-provided liability subtype.
    - `accountOriginationDate` string, required: Account origination date.
    - `creditLimit` number: Credit limit. At least one of creditLimit or highCreditAmount is required.
    - `highCreditAmount` number: High credit amount. At least one of creditLimit or highCreditAmount is required.

## Response `200`

Successful response

- MatchLiabilitiesResponse
  - `status` ResponseStatus, required
    - `code` number
    - `desc` string
    - `messages` Message[]
      - `desc` string, required
      - `type` 'ERROR' | 'WARN' | 'INFO'
  - `data` MatchLiabilitiesData, required
    - `userId` string, required
    - `extUserId` string
    - `creditCards` union[]: Bureau credit cards, with extLiabilityId when matched, plus unmatched submitted credit-card tradelines.
      - union
        - MatchedDebtProfileCreditCard
          - `creditCardId` string, required: Unique identifier for the credit card
          - `logoUrl` string, required: Logo URL for the institution
          - `displayName` string: Name of the institution
          - `updatedOn` number: Timestamp of the last update
          - `createdOn` number: Timestamp of the creation
          - `extLiabilityId` string: Partner liability identifier when this bureau liability was matched.
          - `statementSummary` CreditCardStatementSummaryReport, required
            - `statementDateWithFormat` DateWithFormat
              - …
            - `statementBalance` number: Total balance on the statement
            - `minimumPaymentAmount` number: Minimum amount due for payment
            - `lastPaymentAmount` number: Amount of last payment
            - `lastPaymentDateWithFormat` DateWithFormat
              - …
            - `dueDate` string, date-time: Due date for the next payment
            - `overduePeriod` 'LATE_30_DAYS' | 'LATE_60_DAYS' | 'LATE_90_DAYS' | 'LATE_120_DAYS' | 'NOT_OVERDUE': Overdue period status
            - `amountPastDue` number: Amount past due
            - `updatedOn` number: Timestamp of the last update
            - `dueDateWithFormat` DateWithFormat
              - …
          - `cardProfile` CreditCardProfile, required
            - `creditCardNumberMasked` string: Masked credit card number
            - `accountOriginationDate` string, date-time: Date of account origination
            - `status` 'OPEN' | 'CLOSED': Credit card status
            - `creditLimit` number: Credit limit on the account
            - `highCreditAmount` number: Represents the highest balance or amount of credit owed on a specific account during a specific period, as reported by the creditor
            - `accountRating` string: Account rating
            - `liabilitySubtype` string: Subtype of liability
            - `debtType` 'SECURED' | 'UNSECURED' | 'UNKNOWN': The type of debt. This field indicates whether the debt is secured or unsecured.
            - `termsFrequency` 'BIWEEKLY' | 'DEFERRED' | 'SEMI_MONTHLY' | 'BI_MONTHLY' | 'MONTHLY' | 'SINGLE_PAYMENT_LOAN' | 'QUARTERLY' | 'SEMI_ANNUALLY' | 'TRI_ANNUALLY' | 'WEEKLY' | 'ANNUALLY': Indicates how often payments are due
            - `closedDateWithFormat` DateWithFormat
              - …
            - `availableCreditDerived` number: Derived available credit
            - `accountOwnershipType` 'AUTHORIZED_USER' | 'COMAKER' | 'INDIVIDUAL' | 'JOINT_CONTRACTUAL_LIABILITY' | 'JOINT_PARTICIPATING' | 'MAKER' | 'ON_BEHALF_OF' | 'TERMINATED' | 'UNDESIGNATED' | 'DECEASED': Type of account ownership
            - `ecoaCode` 'I' | 'J' | 'A' | 'C' | 'M' | 'T' | 'X': This field represents the Equal Credit Opportunity Act code for a particular liability. Where it can be represented as both a letter and a number, we opt to display the letter
            - `reviewedInMonths` number: Number of months the account has been reviewed
            - `reportedDateWithFormat` DateWithFormat
              - …
            - `accountType` 'CREDIT_LINE' | 'INSTALLMENT' | 'MORTGAGE' | 'OPEN' | 'REVOLVING' | 'UNKNOWN': Type of account
            - `consumerDisputeStatus` 'DISPUTED' | 'NOT_DISPUTED': Consumer dispute status
            - `derogatoryDataStatus` 'DEROGATORY' | 'NOT_DEROGATORY': Status of derogatory data
            - `collectionStatus` 'IN_COLLECTION' | 'NOT_IN_COLLECTION': Collection status
            - `chargeOffStatus` 'CHARGED_OFF' | 'NOT_CHARGED_OFF': Charge-off status
            - `chargeOffAmount` number: Charge-off amount
            - `chargeOffDateWithFormat` DateWithFormat
              - …
            - `firstDelinquencyDateWithFormat` DateWithFormat
              - …
            - `lastActivityDateWithFormat` DateWithFormat
              - …
            - `accountTypeCode` string: Account type code
            - `highestAdverseRating` '0' | '1' | '2' | '3' | '4' | '5' | '6' | 'G' | 'H' | 'J' | 'R' | 'L' | 'E' | 'B' | 'D': Highest adverse rating
            - `highestAdverseRatingDateWithFormat` DateWithFormat
              - …
            - `mostRecentAdverseRating` '0' | '1' | '2' | '3' | '4' | '5' | '6' | 'G' | 'H' | 'J' | 'R' | 'L' | 'E' | 'B' | 'D': Most recent adverse rating
            - `mostRecentAdverseRatingDateWithFormat` DateWithFormat
              - …
            - `secondMostRecentAdverseRating` '0' | '1' | '2' | '3' | '4' | '5' | '6' | 'G' | 'H' | 'J' | 'R' | 'L' | 'E' | 'B' | 'D': Second most recent adverse rating
            - `secondMostRecentAdverseRatingDateWithFormat` DateWithFormat
              - …
            - `adverseRatingCount` number: Total count of adverse ratings
            - `liabilityTransfers` LiabilityTransfers
              - …
            - `narratives` Narratives[]: Details about consumer account narratives
              - …
            - `creditUtilization` number: This field represents the credit card utilization rate, expressed as a percentage. It indicates the proportion of a credit limit that is currently being used on this specific credit card.
            - `limitType` 'FLEXIBLE' | 'REGULAR': Type of credit limit
            - `paymentHistory` PaymentHistory
              - …
          - `balanceDetails` CreditCardBalanceDetails
            - `outstandingBalance` number: Current balance on the account
            - `updatedOn` number: Timestamp of the last update
          - `aprs` Apr[]
            - `rate` number, required: Annual percentage rate
            - `type` 'PURCHASE' | 'BALANCE_TRANSFER' | 'PENALTY' | 'CASH_ADVANCE' | 'INTRO', required: Type of APR
            - `applicableBalance` number: The balance to which this APR applies
            - `expirationDate` string: Date when this APR will expire
            - `source` 'DERIVED' | 'REAL_TIME': Indicates the origin of the APR value
            - `updatedOn` number, required: Timestamp of the last update
          - `creditor` Creditor
            - `industryType` string: Industry type of the creditor
            - `industryCode` string: Industry code of the creditor
            - `phoneNumber` string: Creditor phone number
            - `originalName` string: Creditor original name
            - `bureauSubscriberCode` string: Creditor subscriber code
            - `billingAddresses` BillingAddress[]: Previous and current billing addresses
              - …
            - `address` Address
              - …
            - `billingAddress` Address
              - …
          - `capabilities` CapabilityMatrix
            - `payments` PaymentsCapability
              - …
            - `data` DataCapability
              - …
        - UnmatchedTradeline
          - `extLiabilityId` string, required
          - `liabilityType` 'STUDENT_LOAN' | 'CREDIT_CARD' | 'AUTO_LOAN' | 'HOME_LOAN' | 'PERSONAL_LOAN' | 'MISCELLANEOUS_LIABILITY', required
          - `error` UnmatchedTradelineError, required
            - `code` string, required
            - `message` string, required
    - `homeLoans` union[]: Bureau home loans, with extLiabilityId when matched, plus unmatched submitted home-loan tradelines.
      - union
        - MatchedDebtProfileHomeLoan
          - `homeLoanId` string, required: Unique identifier for the home loan
          - `logoUrl` string, required: Logo URL for the institution
          - `displayName` string: Name of the institution
          - `updatedOn` number: Timestamp of the last update
          - `createdOn` number: Timestamp of the creation
          - `extLiabilityId` string: Partner liability identifier when this bureau liability was matched.
          - `liabilityProfile` LiabilityProfile, required
            - `accountOriginationDate` string, date: Date of account origination
            - `status` 'OPEN' | 'CLOSED': Liability status
            - `interestRateDerived` number: Interest rate derived
            - `loanOriginationAmount` number: Loan origination amount
            - `highCreditAmount` number: Represents the highest balance or amount of credit owed on a specific account during a specific period, as reported by the creditor
            - `accountRating` string: Account rating
            - `liabilitySubtype` string: Subtype of liability
            - `debtType` 'SECURED' | 'UNSECURED' | 'UNKNOWN': The type of debt. This field indicates whether the debt is secured or unsecured.
            - `pendingLoanTermInMonthsDerived` number: Pending loan term in months derived
            - `loanTermInMonths` number: Loan term in months
            - `termsFrequency` 'BIWEEKLY' | 'DEFERRED' | 'SEMI_MONTHLY' | 'BI_MONTHLY' | 'MONTHLY' | 'SINGLE_PAYMENT_LOAN' | 'QUARTERLY' | 'SEMI_ANNUALLY' | 'TRI_ANNUALLY' | 'WEEKLY' | 'ANNUALLY': Indicates how often payments are due
            - `closedDateWithFormat` DateWithFormat
              - …
            - `accountOwnershipType` 'AUTHORIZED_USER' | 'COMAKER' | 'INDIVIDUAL' | 'JOINT_CONTRACTUAL_LIABILITY' | 'JOINT_PARTICIPATING' | 'MAKER' | 'ON_BEHALF_OF' | 'TERMINATED' | 'UNDESIGNATED' | 'DECEASED': Type of account ownership
            - `ecoaCode` 'I' | 'J' | 'A' | 'C' | 'M' | 'T' | 'X': This field represents the Equal Credit Opportunity Act code for a particular liability. Where it can be represented as both a letter and a number, we opt to display the letter
            - `reviewedInMonths` number: Number of months the account has been reviewed
            - `reportedDateWithFormat` DateWithFormat
              - …
            - `accountType` 'CREDIT_LINE' | 'INSTALLMENT' | 'MORTGAGE' | 'OPEN' | 'REVOLVING' | 'UNKNOWN': Type of account
            - `consumerDisputeStatus` 'DISPUTED' | 'NOT_DISPUTED': Consumer dispute status
            - `derogatoryDataStatus` 'DEROGATORY' | 'NOT_DEROGATORY': Status of derogatory data
            - `collectionStatus` 'IN_COLLECTION' | 'NOT_IN_COLLECTION': Collection status
            - `chargeOffStatus` 'CHARGED_OFF' | 'NOT_CHARGED_OFF': Charge-off status
            - `chargeOffAmount` number: Charge-off amount
            - `chargeOffDateWithFormat` DateWithFormat
              - …
            - `firstDelinquencyDateWithFormat` DateWithFormat
              - …
            - `lastActivityDateWithFormat` DateWithFormat
              - …
            - `accountTypeCode` string: Account type code
            - `highestAdverseRating` '0' | '1' | '2' | '3' | '4' | '5' | '6' | 'G' | 'H' | 'J' | 'R' | 'L' | 'E' | 'B' | 'D': Highest adverse rating
            - `highestAdverseRatingDateWithFormat` DateWithFormat
              - …
            - `mostRecentAdverseRating` '0' | '1' | '2' | '3' | '4' | '5' | '6' | 'G' | 'H' | 'J' | 'R' | 'L' | 'E' | 'B' | 'D': Most recent adverse rating
            - `mostRecentAdverseRatingDateWithFormat` DateWithFormat
              - …
            - `secondMostRecentAdverseRating` '0' | '1' | '2' | '3' | '4' | '5' | '6' | 'G' | 'H' | 'J' | 'R' | 'L' | 'E' | 'B' | 'D': Second most recent adverse rating
            - `secondMostRecentAdverseRatingDateWithFormat` DateWithFormat
              - …
            - `adverseRatingCount` number: Total count of adverse ratings
            - `liabilityTransfers` LiabilityTransfers
              - …
            - `narratives` Narratives[]: Details about consumer account narratives
              - …
            - `accountNumberLastFour` string: Last four digits of the account number. For accounts with fewer than four digits, the full account number is returned. This field is only returned for non-credit card liability types (auto loans, student loans, home loans, personal loans, and miscellaneous liabilities).
            - `paymentHistory` PaymentHistory
              - …
          - `balanceDetails` LiabilityBalanceDetails, required
            - `outstandingBalance` number: Current balance on the account
            - `updatedOn` number: Timestamp of the last update
          - `statementSummary` LiabilityStatementSummary, required
            - `statementDateWithFormat` DateWithFormat
              - …
            - `statementBalance` number: Total balance on the statement
            - `principalBalance` number: Principal balance on the loan
            - `minimumPaymentAmount` number: Minimum amount due for payment
            - `lastPaymentDateWithFormat` DateWithFormat
              - …
            - `dueDate` string, date: Due date for the next payment
            - `overduePeriod` 'LATE_30_DAYS' | 'LATE_60_DAYS' | 'LATE_90_DAYS' | 'LATE_120_DAYS' | 'NOT_OVERDUE': Overdue period status
            - `amountPastDue` number: Amount past due
            - `updatedOn` number: Timestamp of the last update
          - `creditor` Creditor
            - `industryType` string: Industry type of the creditor
            - `industryCode` string: Industry code of the creditor
            - `phoneNumber` string: Creditor phone number
            - `originalName` string: Creditor original name
            - `bureauSubscriberCode` string: Creditor subscriber code
            - `billingAddresses` BillingAddress[]: Previous and current billing addresses
              - …
            - `address` Address
              - …
            - `billingAddress` Address
              - …
          - `capabilities` CapabilityMatrix
            - `payments` PaymentsCapability
              - …
            - `data` DataCapability
              - …
        - UnmatchedTradeline
          - `extLiabilityId` string, required
          - `liabilityType` 'STUDENT_LOAN' | 'CREDIT_CARD' | 'AUTO_LOAN' | 'HOME_LOAN' | 'PERSONAL_LOAN' | 'MISCELLANEOUS_LIABILITY', required
          - `error` UnmatchedTradelineError, required
            - `code` string, required
            - `message` string, required
    - `autoLoans` union[]: Bureau auto loans, with extLiabilityId when matched, plus unmatched submitted auto-loan tradelines.
      - union
        - MatchedDebtProfileAutoLoan
          - `autoLoanId` string, required: Unique identifier for the auto loan
          - `logoUrl` string, required: Logo URL for the institution
          - `displayName` string: Name of the institution
          - `updatedOn` number: Timestamp of the last update
          - `createdOn` number: Timestamp of the creation
          - `extLiabilityId` string: Partner liability identifier when this bureau liability was matched.
          - `liabilityProfile` LiabilityProfile, required
            - `accountOriginationDate` string, date: Date of account origination
            - `status` 'OPEN' | 'CLOSED': Liability status
            - `interestRateDerived` number: Interest rate derived
            - `loanOriginationAmount` number: Loan origination amount
            - `highCreditAmount` number: Represents the highest balance or amount of credit owed on a specific account during a specific period, as reported by the creditor
            - `accountRating` string: Account rating
            - `liabilitySubtype` string: Subtype of liability
            - `debtType` 'SECURED' | 'UNSECURED' | 'UNKNOWN': The type of debt. This field indicates whether the debt is secured or unsecured.
            - `pendingLoanTermInMonthsDerived` number: Pending loan term in months derived
            - `loanTermInMonths` number: Loan term in months
            - `termsFrequency` 'BIWEEKLY' | 'DEFERRED' | 'SEMI_MONTHLY' | 'BI_MONTHLY' | 'MONTHLY' | 'SINGLE_PAYMENT_LOAN' | 'QUARTERLY' | 'SEMI_ANNUALLY' | 'TRI_ANNUALLY' | 'WEEKLY' | 'ANNUALLY': Indicates how often payments are due
            - `closedDateWithFormat` DateWithFormat
              - …
            - `accountOwnershipType` 'AUTHORIZED_USER' | 'COMAKER' | 'INDIVIDUAL' | 'JOINT_CONTRACTUAL_LIABILITY' | 'JOINT_PARTICIPATING' | 'MAKER' | 'ON_BEHALF_OF' | 'TERMINATED' | 'UNDESIGNATED' | 'DECEASED': Type of account ownership
            - `ecoaCode` 'I' | 'J' | 'A' | 'C' | 'M' | 'T' | 'X': This field represents the Equal Credit Opportunity Act code for a particular liability. Where it can be represented as both a letter and a number, we opt to display the letter
            - `reviewedInMonths` number: Number of months the account has been reviewed
            - `reportedDateWithFormat` DateWithFormat
              - …
            - `accountType` 'CREDIT_LINE' | 'INSTALLMENT' | 'MORTGAGE' | 'OPEN' | 'REVOLVING' | 'UNKNOWN': Type of account
            - `consumerDisputeStatus` 'DISPUTED' | 'NOT_DISPUTED': Consumer dispute status
            - `derogatoryDataStatus` 'DEROGATORY' | 'NOT_DEROGATORY': Status of derogatory data
            - `collectionStatus` 'IN_COLLECTION' | 'NOT_IN_COLLECTION': Collection status
            - `chargeOffStatus` 'CHARGED_OFF' | 'NOT_CHARGED_OFF': Charge-off status
            - `chargeOffAmount` number: Charge-off amount
            - `chargeOffDateWithFormat` DateWithFormat
              - …
            - `firstDelinquencyDateWithFormat` DateWithFormat
              - …
            - `lastActivityDateWithFormat` DateWithFormat
              - …
            - `accountTypeCode` string: Account type code
            - `highestAdverseRating` '0' | '1' | '2' | '3' | '4' | '5' | '6' | 'G' | 'H' | 'J' | 'R' | 'L' | 'E' | 'B' | 'D': Highest adverse rating
            - `highestAdverseRatingDateWithFormat` DateWithFormat
              - …
            - `mostRecentAdverseRating` '0' | '1' | '2' | '3' | '4' | '5' | '6' | 'G' | 'H' | 'J' | 'R' | 'L' | 'E' | 'B' | 'D': Most recent adverse rating
            - `mostRecentAdverseRatingDateWithFormat` DateWithFormat
              - …
            - `secondMostRecentAdverseRating` '0' | '1' | '2' | '3' | '4' | '5' | '6' | 'G' | 'H' | 'J' | 'R' | 'L' | 'E' | 'B' | 'D': Second most recent adverse rating
            - `secondMostRecentAdverseRatingDateWithFormat` DateWithFormat
              - …
            - `adverseRatingCount` number: Total count of adverse ratings
            - `liabilityTransfers` LiabilityTransfers
              - …
            - `narratives` Narratives[]: Details about consumer account narratives
              - …
            - `accountNumberLastFour` string: Last four digits of the account number. For accounts with fewer than four digits, the full account number is returned. This field is only returned for non-credit card liability types (auto loans, student loans, home loans, personal loans, and miscellaneous liabilities).
            - `paymentHistory` PaymentHistory
              - …
          - `balanceDetails` LiabilityBalanceDetails, required
            - `outstandingBalance` number: Current balance on the account
            - `updatedOn` number: Timestamp of the last update
          - `statementSummary` LiabilityStatementSummary, required
            - `statementDateWithFormat` DateWithFormat
              - …
            - `statementBalance` number: Total balance on the statement
            - `principalBalance` number: Principal balance on the loan
            - `minimumPaymentAmount` number: Minimum amount due for payment
            - `lastPaymentDateWithFormat` DateWithFormat
              - …
            - `dueDate` string, date: Due date for the next payment
            - `overduePeriod` 'LATE_30_DAYS' | 'LATE_60_DAYS' | 'LATE_90_DAYS' | 'LATE_120_DAYS' | 'NOT_OVERDUE': Overdue period status
            - `amountPastDue` number: Amount past due
            - `updatedOn` number: Timestamp of the last update
          - `payoffSummary` LiabilityPayoffSummary
            - `payoffAmount` number: Pay off amount for the account
            - `payoffGoodThroughDate` string, date: Date till when pay off amount is valid
            - `updatedOn` number: Timestamp of the last update
          - `creditor` Creditor
            - `industryType` string: Industry type of the creditor
            - `industryCode` string: Industry code of the creditor
            - `phoneNumber` string: Creditor phone number
            - `originalName` string: Creditor original name
            - `bureauSubscriberCode` string: Creditor subscriber code
            - `billingAddresses` BillingAddress[]: Previous and current billing addresses
              - …
            - `address` Address
              - …
            - `billingAddress` Address
              - …
          - `capabilities` CapabilityMatrix, required
            - `payments` PaymentsCapability
              - …
            - `data` DataCapability
              - …
        - UnmatchedTradeline
          - `extLiabilityId` string, required
          - `liabilityType` 'STUDENT_LOAN' | 'CREDIT_CARD' | 'AUTO_LOAN' | 'HOME_LOAN' | 'PERSONAL_LOAN' | 'MISCELLANEOUS_LIABILITY', required
          - `error` UnmatchedTradelineError, required
            - `code` string, required
            - `message` string, required
    - `personalLoans` union[]: Bureau personal loans, with extLiabilityId when matched, plus unmatched submitted personal-loan tradelines.
      - union
        - MatchedDebtProfilePersonalLoan
          - `personalLoanId` string, required: Unique identifier for the personal loan
          - `logoUrl` string, required: Logo URL for the institution
          - `displayName` string: Name of the institution
          - `updatedOn` number: Timestamp of the last update
          - `createdOn` number: Timestamp of the creation
          - `extLiabilityId` string: Partner liability identifier when this bureau liability was matched.
          - `liabilityProfile` LiabilityProfile, required
            - `accountOriginationDate` string, date: Date of account origination
            - `status` 'OPEN' | 'CLOSED': Liability status
            - `interestRateDerived` number: Interest rate derived
            - `loanOriginationAmount` number: Loan origination amount
            - `highCreditAmount` number: Represents the highest balance or amount of credit owed on a specific account during a specific period, as reported by the creditor
            - `accountRating` string: Account rating
            - `liabilitySubtype` string: Subtype of liability
            - `debtType` 'SECURED' | 'UNSECURED' | 'UNKNOWN': The type of debt. This field indicates whether the debt is secured or unsecured.
            - `pendingLoanTermInMonthsDerived` number: Pending loan term in months derived
            - `loanTermInMonths` number: Loan term in months
            - `termsFrequency` 'BIWEEKLY' | 'DEFERRED' | 'SEMI_MONTHLY' | 'BI_MONTHLY' | 'MONTHLY' | 'SINGLE_PAYMENT_LOAN' | 'QUARTERLY' | 'SEMI_ANNUALLY' | 'TRI_ANNUALLY' | 'WEEKLY' | 'ANNUALLY': Indicates how often payments are due
            - `closedDateWithFormat` DateWithFormat
              - …
            - `accountOwnershipType` 'AUTHORIZED_USER' | 'COMAKER' | 'INDIVIDUAL' | 'JOINT_CONTRACTUAL_LIABILITY' | 'JOINT_PARTICIPATING' | 'MAKER' | 'ON_BEHALF_OF' | 'TERMINATED' | 'UNDESIGNATED' | 'DECEASED': Type of account ownership
            - `ecoaCode` 'I' | 'J' | 'A' | 'C' | 'M' | 'T' | 'X': This field represents the Equal Credit Opportunity Act code for a particular liability. Where it can be represented as both a letter and a number, we opt to display the letter
            - `reviewedInMonths` number: Number of months the account has been reviewed
            - `reportedDateWithFormat` DateWithFormat
              - …
            - `accountType` 'CREDIT_LINE' | 'INSTALLMENT' | 'MORTGAGE' | 'OPEN' | 'REVOLVING' | 'UNKNOWN': Type of account
            - `consumerDisputeStatus` 'DISPUTED' | 'NOT_DISPUTED': Consumer dispute status
            - `derogatoryDataStatus` 'DEROGATORY' | 'NOT_DEROGATORY': Status of derogatory data
            - `collectionStatus` 'IN_COLLECTION' | 'NOT_IN_COLLECTION': Collection status
            - `chargeOffStatus` 'CHARGED_OFF' | 'NOT_CHARGED_OFF': Charge-off status
            - `chargeOffAmount` number: Charge-off amount
            - `chargeOffDateWithFormat` DateWithFormat
              - …
            - `firstDelinquencyDateWithFormat` DateWithFormat
              - …
            - `lastActivityDateWithFormat` DateWithFormat
              - …
            - `accountTypeCode` string: Account type code
            - `highestAdverseRating` '0' | '1' | '2' | '3' | '4' | '5' | '6' | 'G' | 'H' | 'J' | 'R' | 'L' | 'E' | 'B' | 'D': Highest adverse rating
            - `highestAdverseRatingDateWithFormat` DateWithFormat
              - …
            - `mostRecentAdverseRating` '0' | '1' | '2' | '3' | '4' | '5' | '6' | 'G' | 'H' | 'J' | 'R' | 'L' | 'E' | 'B' | 'D': Most recent adverse rating
            - `mostRecentAdverseRatingDateWithFormat` DateWithFormat
              - …
            - `secondMostRecentAdverseRating` '0' | '1' | '2' | '3' | '4' | '5' | '6' | 'G' | 'H' | 'J' | 'R' | 'L' | 'E' | 'B' | 'D': Second most recent adverse rating
            - `secondMostRecentAdverseRatingDateWithFormat` DateWithFormat
              - …
            - `adverseRatingCount` number: Total count of adverse ratings
            - `liabilityTransfers` LiabilityTransfers
              - …
            - `narratives` Narratives[]: Details about consumer account narratives
              - …
            - `accountNumberLastFour` string: Last four digits of the account number. For accounts with fewer than four digits, the full account number is returned. This field is only returned for non-credit card liability types (auto loans, student loans, home loans, personal loans, and miscellaneous liabilities).
            - `paymentHistory` PaymentHistory
              - …
          - `balanceDetails` LiabilityBalanceDetails, required
            - `outstandingBalance` number: Current balance on the account
            - `updatedOn` number: Timestamp of the last update
          - `statementSummary` LiabilityStatementSummary, required
            - `statementDateWithFormat` DateWithFormat
              - …
            - `statementBalance` number: Total balance on the statement
            - `principalBalance` number: Principal balance on the loan
            - `minimumPaymentAmount` number: Minimum amount due for payment
            - `lastPaymentDateWithFormat` DateWithFormat
              - …
            - `dueDate` string, date: Due date for the next payment
            - `overduePeriod` 'LATE_30_DAYS' | 'LATE_60_DAYS' | 'LATE_90_DAYS' | 'LATE_120_DAYS' | 'NOT_OVERDUE': Overdue period status
            - `amountPastDue` number: Amount past due
            - `updatedOn` number: Timestamp of the last update
          - `creditor` Creditor
            - `industryType` string: Industry type of the creditor
            - `industryCode` string: Industry code of the creditor
            - `phoneNumber` string: Creditor phone number
            - `originalName` string: Creditor original name
            - `bureauSubscriberCode` string: Creditor subscriber code
            - `billingAddresses` BillingAddress[]: Previous and current billing addresses
              - …
            - `address` Address
              - …
            - `billingAddress` Address
              - …
          - `capabilities` CapabilityMatrix, required
            - `payments` PaymentsCapability
              - …
            - `data` DataCapability
              - …
        - UnmatchedTradeline
          - `extLiabilityId` string, required
          - `liabilityType` 'STUDENT_LOAN' | 'CREDIT_CARD' | 'AUTO_LOAN' | 'HOME_LOAN' | 'PERSONAL_LOAN' | 'MISCELLANEOUS_LIABILITY', required
          - `error` UnmatchedTradelineError, required
            - `code` string, required
            - `message` string, required
    - `studentLoans` union[]: Bureau student loans, with extLiabilityId when matched, plus unmatched submitted student-loan tradelines.
      - union
        - MatchedDebtProfileStudentLoan
          - `studentLoanId` string, required: Unique identifier for the student loan
          - `logoUrl` string, required: Logo URL for the institution
          - `displayName` string: Name of the institution
          - `updatedOn` number: Timestamp of the last update
          - `createdOn` number: Timestamp of the creation
          - `extLiabilityId` string: Partner liability identifier when this bureau liability was matched.
          - `liabilityProfile` StudentLoanLiabilityProfile, required
            - `accountOriginationDate` string, date: Date of account origination
            - `status` 'OPEN' | 'CLOSED': Liability status
            - `interestRateDerived` number: Interest rate derived
            - `loanOriginationAmount` number: Loan origination amount
            - `highCreditAmount` number: Represents the highest balance or amount of credit owed on a specific account during a specific period, as reported by the creditor
            - `accountRating` string: Account rating
            - `liabilitySubtype` string: Subtype of liability
            - `debtType` 'SECURED' | 'UNSECURED' | 'UNKNOWN': The type of debt. This field indicates whether the debt is secured or unsecured.
            - `pendingLoanTermInMonthsDerived` number: Pending loan term in months derived
            - `loanTermInMonths` number: Loan term in months
            - `termsFrequency` 'BIWEEKLY' | 'DEFERRED' | 'SEMI_MONTHLY' | 'BI_MONTHLY' | 'MONTHLY' | 'SINGLE_PAYMENT_LOAN' | 'QUARTERLY' | 'SEMI_ANNUALLY' | 'TRI_ANNUALLY' | 'WEEKLY' | 'ANNUALLY': Indicates how often payments are due
            - `closedDateWithFormat` DateWithFormat
              - …
            - `accountOwnershipType` 'AUTHORIZED_USER' | 'COMAKER' | 'INDIVIDUAL' | 'JOINT_CONTRACTUAL_LIABILITY' | 'JOINT_PARTICIPATING' | 'MAKER' | 'ON_BEHALF_OF' | 'TERMINATED' | 'UNDESIGNATED' | 'DECEASED': Type of account ownership
            - `ecoaCode` 'I' | 'J' | 'A' | 'C' | 'M' | 'T' | 'X': This field represents the Equal Credit Opportunity Act code for a particular liability. Where it can be represented as both a letter and a number, we opt to display the letter
            - `reviewedInMonths` number: Number of months the account has been reviewed
            - `reportedDateWithFormat` DateWithFormat
              - …
            - `accountType` 'CREDIT_LINE' | 'INSTALLMENT' | 'MORTGAGE' | 'OPEN' | 'REVOLVING' | 'UNKNOWN': Type of account
            - `consumerDisputeStatus` 'DISPUTED' | 'NOT_DISPUTED': Consumer dispute status
            - `derogatoryDataStatus` 'DEROGATORY' | 'NOT_DEROGATORY': Status of derogatory data
            - `collectionStatus` 'IN_COLLECTION' | 'NOT_IN_COLLECTION': Collection status
            - `chargeOffStatus` 'CHARGED_OFF' | 'NOT_CHARGED_OFF': Charge-off status
            - `chargeOffAmount` number: Charge-off amount
            - `chargeOffDateWithFormat` DateWithFormat
              - …
            - `firstDelinquencyDateWithFormat` DateWithFormat
              - …
            - `lastActivityDateWithFormat` DateWithFormat
              - …
            - `accountTypeCode` string: Account type code
            - `highestAdverseRating` '0' | '1' | '2' | '3' | '4' | '5' | '6' | 'G' | 'H' | 'J' | 'R' | 'L' | 'E' | 'B' | 'D': Highest adverse rating
            - `highestAdverseRatingDateWithFormat` DateWithFormat
              - …
            - `mostRecentAdverseRating` '0' | '1' | '2' | '3' | '4' | '5' | '6' | 'G' | 'H' | 'J' | 'R' | 'L' | 'E' | 'B' | 'D': Most recent adverse rating
            - `mostRecentAdverseRatingDateWithFormat` DateWithFormat
              - …
            - `secondMostRecentAdverseRating` '0' | '1' | '2' | '3' | '4' | '5' | '6' | 'G' | 'H' | 'J' | 'R' | 'L' | 'E' | 'B' | 'D': Second most recent adverse rating
            - `secondMostRecentAdverseRatingDateWithFormat` DateWithFormat
              - …
            - `adverseRatingCount` number: Total count of adverse ratings
            - `liabilityTransfers` LiabilityTransfers
              - …
            - `narratives` Narratives[]: Details about consumer account narratives
              - …
            - `accountNumberLastFour` string: Last four digits of the account number. For accounts with fewer than four digits, the full account number is returned. This field is only returned for non-credit card liability types (auto loans, student loans, home loans, personal loans, and miscellaneous liabilities).
            - `loanType` 'PUBLIC' | 'PRIVATE' | 'UNVERIFIED': Loan Type
            - `paymentHistory` PaymentHistory
              - …
          - `balanceDetails` LiabilityBalanceDetails, required
            - `outstandingBalance` number: Current balance on the account
            - `updatedOn` number: Timestamp of the last update
          - `statementSummary` LiabilityStatementSummary, required
            - `statementDateWithFormat` DateWithFormat
              - …
            - `statementBalance` number: Total balance on the statement
            - `principalBalance` number: Principal balance on the loan
            - `minimumPaymentAmount` number: Minimum amount due for payment
            - `lastPaymentDateWithFormat` DateWithFormat
              - …
            - `dueDate` string, date: Due date for the next payment
            - `overduePeriod` 'LATE_30_DAYS' | 'LATE_60_DAYS' | 'LATE_90_DAYS' | 'LATE_120_DAYS' | 'NOT_OVERDUE': Overdue period status
            - `amountPastDue` number: Amount past due
            - `updatedOn` number: Timestamp of the last update
          - `creditor` Creditor
            - `industryType` string: Industry type of the creditor
            - `industryCode` string: Industry code of the creditor
            - `phoneNumber` string: Creditor phone number
            - `originalName` string: Creditor original name
            - `bureauSubscriberCode` string: Creditor subscriber code
            - `billingAddresses` BillingAddress[]: Previous and current billing addresses
              - …
            - `address` Address
              - …
            - `billingAddress` Address
              - …
          - `capabilities` CapabilityMatrix, required
            - `payments` PaymentsCapability
              - …
            - `data` DataCapability
              - …
        - UnmatchedTradeline
          - `extLiabilityId` string, required
          - `liabilityType` 'STUDENT_LOAN' | 'CREDIT_CARD' | 'AUTO_LOAN' | 'HOME_LOAN' | 'PERSONAL_LOAN' | 'MISCELLANEOUS_LIABILITY', required
          - `error` UnmatchedTradelineError, required
            - `code` string, required
            - `message` string, required
    - `miscellaneousLiabilities` union[]: Bureau miscellaneous liabilities, with extLiabilityId when matched, plus unmatched submitted tradelines.
      - union
        - MatchedDebtProfileMiscellaneousLiability
          - `miscellaneousLiabilityId` string, required: Unique identifier for the miscellaneous liability
          - `logoUrl` string, required: Logo URL for the institution
          - `displayName` string: Name of the institution
          - `updatedOn` number: Timestamp of the last update
          - `createdOn` number: Timestamp of the creation
          - `extLiabilityId` string: Partner liability identifier when this bureau liability was matched.
          - `liabilityProfile` MiscellaneousLiabilityProfile, required
            - `accountOriginationDate` string, date: Date of account origination
            - `status` 'OPEN' | 'CLOSED': Liability status
            - `interestRateDerived` number: Interest rate derived
            - `loanOriginationAmount` number: Loan origination amount
            - `highCreditAmount` number: Represents the highest balance or amount of credit owed on a specific account during a specific period, as reported by the creditor
            - `accountRating` string: Account rating
            - `liabilitySubtype` string: Subtype of liability
            - `debtType` 'SECURED' | 'UNSECURED' | 'UNKNOWN': The type of debt. This field indicates whether the debt is secured or unsecured.
            - `pendingLoanTermInMonthsDerived` number: Pending loan term in months derived
            - `loanTermInMonths` number: Loan term in months
            - `termsFrequency` 'BIWEEKLY' | 'DEFERRED' | 'SEMI_MONTHLY' | 'BI_MONTHLY' | 'MONTHLY' | 'SINGLE_PAYMENT_LOAN' | 'QUARTERLY' | 'SEMI_ANNUALLY' | 'TRI_ANNUALLY' | 'WEEKLY' | 'ANNUALLY': Indicates how often payments are due
            - `closedDateWithFormat` DateWithFormat
              - …
            - `accountOwnershipType` 'AUTHORIZED_USER' | 'COMAKER' | 'INDIVIDUAL' | 'JOINT_CONTRACTUAL_LIABILITY' | 'JOINT_PARTICIPATING' | 'MAKER' | 'ON_BEHALF_OF' | 'TERMINATED' | 'UNDESIGNATED' | 'DECEASED': Type of account ownership
            - `ecoaCode` 'I' | 'J' | 'A' | 'C' | 'M' | 'T' | 'X': This field represents the Equal Credit Opportunity Act code for a particular liability. Where it can be represented as both a letter and a number, we opt to display the letter
            - `reviewedInMonths` number: Number of months the account has been reviewed
            - `reportedDateWithFormat` DateWithFormat
              - …
            - `accountType` 'CREDIT_LINE' | 'INSTALLMENT' | 'MORTGAGE' | 'OPEN' | 'REVOLVING' | 'UNKNOWN': Type of account
            - `consumerDisputeStatus` 'DISPUTED' | 'NOT_DISPUTED': Consumer dispute status
            - `derogatoryDataStatus` 'DEROGATORY' | 'NOT_DEROGATORY': Status of derogatory data
            - `collectionStatus` 'IN_COLLECTION' | 'NOT_IN_COLLECTION': Collection status
            - `chargeOffStatus` 'CHARGED_OFF' | 'NOT_CHARGED_OFF': Charge-off status
            - `chargeOffAmount` number: Charge-off amount
            - `chargeOffDateWithFormat` DateWithFormat
              - …
            - `firstDelinquencyDateWithFormat` DateWithFormat
              - …
            - `lastActivityDateWithFormat` DateWithFormat
              - …
            - `accountTypeCode` string: Account type code
            - `highestAdverseRating` '0' | '1' | '2' | '3' | '4' | '5' | '6' | 'G' | 'H' | 'J' | 'R' | 'L' | 'E' | 'B' | 'D': Highest adverse rating
            - `highestAdverseRatingDateWithFormat` DateWithFormat
              - …
            - `mostRecentAdverseRating` '0' | '1' | '2' | '3' | '4' | '5' | '6' | 'G' | 'H' | 'J' | 'R' | 'L' | 'E' | 'B' | 'D': Most recent adverse rating
            - `mostRecentAdverseRatingDateWithFormat` DateWithFormat
              - …
            - `secondMostRecentAdverseRating` '0' | '1' | '2' | '3' | '4' | '5' | '6' | 'G' | 'H' | 'J' | 'R' | 'L' | 'E' | 'B' | 'D': Second most recent adverse rating
            - `secondMostRecentAdverseRatingDateWithFormat` DateWithFormat
              - …
            - `adverseRatingCount` number: Total count of adverse ratings
            - `liabilityTransfers` LiabilityTransfers
              - …
            - `narratives` Narratives[]: Details about consumer account narratives
              - …
            - `accountNumberLastFour` string: Last four digits of the account number. For accounts with fewer than four digits, the full account number is returned. This field is only returned for non-credit card liability types (auto loans, student loans, home loans, personal loans, and miscellaneous liabilities).
            - `collectionAccountStatus` 'UNPAID' | 'FINANCIAL_COUNSELOR' | 'ADJUSTMENT' | 'WAGE_EARNER' | 'NEW_LISTING' | 'PAID' | 'ACCOUNT_DISPUTED' | 'PAYMENT' | 'UNKNOWN' | 'CHECKED' | 'IN_BANKRUPTCY': Represents the status of a collection account, indicating its current stage in the debt recovery process
            - `paymentHistory` PaymentHistory
              - …
          - `balanceDetails` LiabilityBalanceDetails, required
            - `outstandingBalance` number: Current balance on the account
            - `updatedOn` number: Timestamp of the last update
          - `statementSummary` LiabilityStatementSummary, required
            - `statementDateWithFormat` DateWithFormat
              - …
            - `statementBalance` number: Total balance on the statement
            - `principalBalance` number: Principal balance on the loan
            - `minimumPaymentAmount` number: Minimum amount due for payment
            - `lastPaymentDateWithFormat` DateWithFormat
              - …
            - `dueDate` string, date: Due date for the next payment
            - `overduePeriod` 'LATE_30_DAYS' | 'LATE_60_DAYS' | 'LATE_90_DAYS' | 'LATE_120_DAYS' | 'NOT_OVERDUE': Overdue period status
            - `amountPastDue` number: Amount past due
            - `updatedOn` number: Timestamp of the last update
          - `creditor` Creditor
            - `industryType` string: Industry type of the creditor
            - `industryCode` string: Industry code of the creditor
            - `phoneNumber` string: Creditor phone number
            - `originalName` string: Creditor original name
            - `bureauSubscriberCode` string: Creditor subscriber code
            - `billingAddresses` BillingAddress[]: Previous and current billing addresses
              - …
            - `address` Address
              - …
            - `billingAddress` Address
              - …
          - `capabilities` CapabilityMatrix, required
            - `payments` PaymentsCapability
              - …
            - `data` DataCapability
              - …
        - UnmatchedTradeline
          - `extLiabilityId` string, required
          - `liabilityType` 'STUDENT_LOAN' | 'CREDIT_CARD' | 'AUTO_LOAN' | 'HOME_LOAN' | 'PERSONAL_LOAN' | 'MISCELLANEOUS_LIABILITY', required
          - `error` UnmatchedTradelineError, required
            - `code` string, required
            - `message` string, required
    - `creditCardSummary` CreditCardSummary
      - `noOfCreditCards` number, required
      - `currentOutstandingBalance` number, required
      - `availableCredit` number, required
      - `creditUtilization` number: This field represents the credit utilization rate, expressed as a percentage. It indicates the proportion of a credit limit that is currently being used across all cards for a user.
      - `updatedOn` number
      - `createdOn` number
    - `homeLoanSummary` HomeLoanSummary
      - `noOfLoans` number, required
      - `currentOutstandingBalance` number, required
      - `minimumPaymentAmount` number, required
      - `interestRate` number
      - `interestRateDerived` number
      - `updatedOn` number
      - `createdOn` number
    - `autoLoanSummary` AutoLoanSummary
      - `noOfLoans` number, required
      - `currentOutstandingBalance` number, required
      - `minimumPaymentAmount` number, required
      - `interestRate` number
      - `interestRateDerived` number
      - `updatedOn` number
      - `createdOn` number
    - `personalLoanSummary` PersonalLoanSummary
      - `noOfLoans` number, required
      - `currentOutstandingBalance` number, required
      - `minimumPaymentAmount` number, required
      - `interestRate` number
      - `interestRateDerived` number
      - `updatedOn` number
      - `createdOn` number
    - `studentLoanSummary` StudentLoanSummary
      - `noOfLoans` number, required
      - `currentOutstandingBalance` number, required
      - `minimumPaymentAmount` number, required
      - `interestRate` number
      - `interestRateDerived` number
      - `updatedOn` number
      - `createdOn` number
      - `liabilityGroupPayoffQuotes` LiabilityGroupPayoffQuote[]: List of payoff quotes grouped by liability group
        - `studentLoanIds` string[], required
        - `liabilityGroupId` string, required
        - `payoffAmount` number, required
        - `payoffGoodThroughDate` string, required
        - `updatedOn` number, required
    - `miscellaneousLiabilitySummary` MiscellaneousLiabilitySummary
      - `noOfLoans` number, required
      - `currentOutstandingBalance` number, required
      - `minimumPaymentAmount` number, required
      - `interestRate` number
      - `interestRateDerived` number
      - `updatedOn` number
      - `createdOn` number
    - `creditReports` DebtProfileCreditReport[]
      - `id` string
      - `sourceBureau` 'Equifax' | 'TransUnion', required: Specifies the credit bureau from which the credit report was retrieved.
      - `type` '1_BUREAU.FULL': Defines the type of credit report retrieved.
      - `reportStatus` ReportStatus
        - `status` 'SUCCESS' | 'FROZEN_REPORT' | 'FRAUD_INDICATOR', required: The outcome of the credit report retrieval: SUCCESS, FROZEN_REPORT (consumer freeze), or FRAUD_INDICATOR (fraud alert on file)
        - `reason` string: Optional reason describing the report status e.g. "Frozen by consumer as allowed by state law. File is returned due to exempted use." or "Fraud alert on file."
      - `profile` DebtProfileReportProfile
        - `firstName` string
        - `middleName` string
        - `lastName` string
        - `creditScore` number
        - `ssn` string: The last 4 digits of the user's ssn
        - `dateOfBirth` string, date-time
        - `updatedOn` number
        - `createdOn` number
        - `formerNames` FormerName[]: Former names of the user.
          - `firstName` string, required: Former first name
          - `middleName` string: Former middle name
          - `lastName` string, required: Former last name
        - `model` 'VANTAGE_SCORE_3_0' | 'FICO_SCORE_4' | 'FICO_SCORE_8': Indicates the scoring model used for generating the credit score.
        - `addresses` CreditReportAddress[]
          - `addressLine1` string, required
          - `addressLine2` string
          - `city` string, required
          - `state` 'AL' | 'AK' | 'AZ' | 'AR' | 'CA' | 'CO' | 'CT' | 'DC' | 'DE' | 'FL' | 'GA' | 'HI' | 'ID' | 'IL' | 'IN' | 'IA' | 'KS' | 'KY' | 'LA' | 'ME' | 'MD' | 'MA' | 'MI' | 'MN' | 'MS' | 'MO' | 'MT' | 'Ne' | 'NE' | 'NV' | 'NH' | 'NJ' | 'NM' | 'NY' | 'NC' | 'ND' | 'OH' | 'OK' | 'OR' | 'PA' | 'RI' | 'SC' | 'SD' | 'TN' | 'TX' | 'UT' | 'VT' | 'VA' | 'WA' | 'WV' | 'WI' | 'WY', required
          - `zip` string, required
          - `zipExtension` string
          - `residencyType` 'PREVIOUS' | 'CURRENT': Residency type.
          - `addressOwnership` 'RENT' | 'OWN' | 'BUY': Ownership status of the address.
          - `addressSource` 'EQUIFAX' | 'TRANSUNION' | 'OTHER' | 'AUTOMATED_UPDATE': Source of the address information.
          - `residencyDurationInMonths` number: Length of stay in months at a specific address.
          - `reportedDate` string, date-time: The date the address was reported to the credit bureau
          - `reportedDateWithFormat` DateWithFormat
            - `value` string, date, required: Date value in format YYYY-MM-DD or YYYY-MM or YYYY
            - `format` string, required: Format of the date value. Possible values: YYYY-MM-DD, YYYY-MM, YYYY
          - `firstReportedDateWithFormat` DateWithFormat
            - `value` string, date, required: Date value in format YYYY-MM-DD or YYYY-MM or YYYY
            - `format` string, required: Format of the date value. Possible values: YYYY-MM-DD, YYYY-MM, YYYY
        - `employmentHistory` CreditEmploymentHistory[]
          - `employerName` string: Employer name
          - `position` string: Employment position
          - `startDateWithFormat` DateWithFormat
            - `value` string, date, required: Date value in format YYYY-MM-DD or YYYY-MM or YYYY
            - `format` string, required: Format of the date value. Possible values: YYYY-MM-DD, YYYY-MM, YYYY
          - `reportedDateWithFormat` DateWithFormat
            - `value` string, date, required: Date value in format YYYY-MM-DD or YYYY-MM or YYYY
            - `format` string, required: Format of the date value. Possible values: YYYY-MM-DD, YYYY-MM, YYYY
          - `employmentStatus` 'CURRENT' | 'PREVIOUS': Employment status
      - `creditScoreDetails` DebtProfileReportCreditScoreDetails[]
        - `reportedDate` string, date-time: Credit score date
        - `riskBasedPricingPercentage` number: Credit score's risk based pricing percentage
        - `riskBasedPricingMin` number: Credit score's risk based pricing minimum
        - `riskBasedPricingMax` number: Credit score's risk based pricing maximum
        - `creditScore` number: Credit score
        - `sourceBureau` 'Equifax' | 'TransUnion', required: Specifies the credit bureau from which the credit report was retrieved.
        - `factors` Factor[]: Credit score factors
          - `code` string: Factor's code
          - `description` string: Factor's description
          - `factorType` 'POSITIVE' | 'NEGATIVE': Whether this factor positively or negatively impacts the credit score. Omitted when the bureau does not provide a factor type.
        - `model` 'VANTAGE_SCORE_3_0' | 'FICO_SCORE_4' | 'FICO_SCORE_8', required: Indicates the scoring model used for generating the credit score.
      - `inquiries` Inquiry[]
        - `inquirerName` string: Inquirer name
        - `address` InquiryAddress
          - `addressLine1` string, required
          - `addressLine2` string
          - `city` string, required
          - `state` 'AL' | 'AK' | 'AZ' | 'AR' | 'CA' | 'CO' | 'CT' | 'DC' | 'DE' | 'FL' | 'GA' | 'HI' | 'ID' | 'IL' | 'IN' | 'IA' | 'KS' | 'KY' | 'LA' | 'ME' | 'MD' | 'MA' | 'MI' | 'MN' | 'MS' | 'MO' | 'MT' | 'Ne' | 'NE' | 'NV' | 'NH' | 'NJ' | 'NM' | 'NY' | 'NC' | 'ND' | 'OH' | 'OK' | 'OR' | 'PA' | 'RI' | 'SC' | 'SD' | 'TN' | 'TX' | 'UT' | 'VT' | 'VA' | 'WA' | 'WV' | 'WI' | 'WY'
          - `zip` string, required
          - `zipExtension` string
        - `phoneNumber` string: Inquirer phone number
        - `inquiryDate` string, date-time: Inquiry date
        - `inquirerIndustryCode` string: Inquirer industry code
        - `purposeType` 'HARD' | 'SOFT' | 'OTHER': Purpose type
        - `sourceBureau` 'Equifax' | 'Experian' | 'TransUnion': Source bureau
        - `bureauSubscriberCode` string: Bureau subscriber code
      - `bankruptcies` Bankruptcy[]
        - `filedDateWithFormat` DateWithFormat
          - `value` string, date, required: Date value in format YYYY-MM-DD or YYYY-MM or YYYY
          - `format` string, required: Format of the date value. Possible values: YYYY-MM-DD, YYYY-MM, YYYY
        - `dispositionDateWithFormat` DateWithFormat
          - `value` string, date, required: Date value in format YYYY-MM-DD or YYYY-MM or YYYY
          - `format` string, required: Format of the date value. Possible values: YYYY-MM-DD, YYYY-MM, YYYY
        - `verifiedDateWithFormat` DateWithFormat
          - `value` string, date, required: Date value in format YYYY-MM-DD or YYYY-MM or YYYY
          - `format` string, required: Format of the date value. Possible values: YYYY-MM-DD, YYYY-MM, YYYY
        - `reportedDateWithFormat` DateWithFormat
          - `value` string, date, required: Date value in format YYYY-MM-DD or YYYY-MM or YYYY
          - `format` string, required: Format of the date value. Possible values: YYYY-MM-DD, YYYY-MM, YYYY
        - `caseNumber` string: Bankruptcy case number.
        - `type` 'INDIVIDUAL' | 'BUSINESS': Type of bankruptcy filed.
        - `filer` 'INDIVIDUAL' | 'JOINT': Entity or person(s) filing for bankruptcy.
        - `disposition` 'FILED_CH_11' | 'FILED_CH_12' | 'FILED_CH_13' | 'DISCHARGED_CH_7' | 'DISCHARGED_CH_11' | 'DISCHARGED_CH_12' | 'DISCHARGED_CH_13' | 'DISMISSED_OR_CLOSED_CH_7' | 'DISMISSED_OR_CLOSED_CH_11' | 'DISMISSED_OR_CLOSED_CH_12' | 'DISMISSED_OR_CLOSED_CH_13' | 'INVOLUNTARY_CH_7' | 'VOLUNTARY_CH_7': Current disposition of the bankruptcy case.
        - `priorDisposition` 'FILED_CH_11' | 'FILED_CH_12' | 'FILED_CH_13' | 'DISCHARGED_CH_7' | 'DISCHARGED_CH_11' | 'DISCHARGED_CH_12' | 'DISCHARGED_CH_13' | 'DISMISSED_OR_CLOSED_CH_7' | 'DISMISSED_OR_CLOSED_CH_11' | 'DISMISSED_OR_CLOSED_CH_12' | 'DISMISSED_OR_CLOSED_CH_13' | 'INVOLUNTARY_CH_7' | 'VOLUNTARY_CH_7': Prior disposition of the bankruptcy case.
        - `liabilityAmount` number: Total liability amount for the bankruptcy.
        - `assetAmount` number: Total asset amount for the bankruptcy.
        - `exemptAmount` number: Exempted amount in the bankruptcy.
        - `court` Court
          - `industryType` string: Industry type of the court.
          - `industryCode` string: Industry code of the court.
          - `bureauSubscriberCode` string: Court costumer number.
        - `narratives` Narratives[]: Narratives related to the bankruptcy.
          - `code` string: Narrative's code
          - `description` string: Narrative's description
      - `creditAttributes` CreditAttribute[]
        - `description` string: Attribute's description
        - `value` string: Attribute's value
      - `summary` CreditReportSummary
        - `totalSecuredDebtAmount` number, required: Total secured debt amount
        - `securedDebtLiabilitiesCount` number, required: Total secured debt liabilities count
        - `totalUnsecuredDebtAmount` number, required: Total unsecured debt amount
        - `unsecuredDebtLiabilitiesCount` number, required: Total unsecured debt liabilities count
        - `totalUnsecuredDebtExcludingStudent` number, required: Total unsecured debt amount excluding student loans
        - `unsecuredDebtExcludingStudentCount` number, required: Total unsecured debt liabilities count excluding student loans
        - `totalUnknownDebtAmount` number, required: Total unknown debt amount
        - `unknownDebtLiabilitiesCount` number, required: Total unknown debt liabilities count
      - `updatedOn` number
      - `createdOn` number

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `403`: Forbidden
- `404`: Not Found
- `409`: Conflict
- `429`: Too Many Requests
- `500`: Internal Server Error

## Changes

- **2026-11-03** `aa032469622f`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/spinwheel/apis/discover/changes/v1/users/:userId/liabilities/match/post.md)

---

[API](https://skmtc.dev/spinwheel/apis/discover.md) - [All operations](https://skmtc.dev/spinwheel/apis/discover/llms.txt) - [OpenAPI document](https://skmtc.dev/spinwheel/apis/discover/revisions/aa032469622f?raw)