--- title: "Retrieve a User" method: GET path: "/v1/users" tags: ["User Management"] --- # Retrieve a User `GET /v1/users` ## Request - Base URL: `https://sandbox-api.spinwheel.io` - URL: `https://sandbox-api.spinwheel.io/v1/users` - Auth: API key in header `Authorization` Returns a User object ## Query parameters - `userId` string - `extUserId` string - `liabilityType` 'STUDENT_LOAN' | 'CREDIT_CARD' | 'HOME_LOAN' | 'AUTO_LOAN' | 'PERSONAL_LOAN' | 'MISCELLANEOUS_LIABILITY' ## Response `200` Successful response - UserProfileResponse - `status` ResponseStatus, required - `code` number - `desc` string - `messages` Message[] - `desc` string, required - `type` 'ERROR' | 'WARN' | 'INFO' - `data` UserProfile, required - `userId` string, required - `extUserId` string - `isChampion` boolean - `isBorrower` boolean - `networkToken` string - `profile` ProfileUser - `firstName` string, required: First name - `middleName` string: Middle name - `lastName` string, required: Last name - `emailAddress` string: Email address - `creditScore` number: Credit score - `model` 'VANTAGE_SCORE_3_0' | 'FICO_SCORE_4' | 'FICO_SCORE_8': Scoring model - `dob` string: Date of birth - `phoneNumber` string: Phone number - `ssnLastFourDigits` string, required: Last 4 digits of the ssn - `ssn` string - `addresses` Address[] - `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 - `autoLoanSummary` AutoLoanSummary - `noOfLoans` number, required - `currentOutstandingBalance` number, required - `minimumPaymentAmount` number, required - `interestRate` number - `interestRateDerived` number - `updatedOn` number - `createdOn` number - `homeLoanSummary` HomeLoanSummary - `noOfLoans` number, required - `currentOutstandingBalance` number, required - `minimumPaymentAmount` number, required - `interestRate` number - `interestRateDerived` number - `updatedOn` number - `createdOn` number - `miscellaneousLiabilitySummary` MiscellaneousLiabilitySummary - `noOfLoans` number, required - `currentOutstandingBalance` number, required - `minimumPaymentAmount` number, required - `interestRate` number - `interestRateDerived` number - `updatedOn` number - `createdOn` number - `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 - `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 - `bankAccountSummary` BankAccountSummary - `noOfBankAccounts` number, required - `updatedOn` number - `creditReports` CreditReport[] - `id` string - `sourceBureau` 'Equifax' | 'Experian' | 'TransUnion': The bureau that the credit report was sourced from - `type` '1_BUREAU.FULL': The type of credit report used to generate the response - `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` CreditProfile - `firstName` string - `middleName` string - `lastName` string - `creditScore` number - `model` 'VANTAGE_SCORE_3_0' | 'FICO_SCORE_4' | 'FICO_SCORE_8': Scoring model - `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 - `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 - `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 - `creditScoreDetails` CreditScoreDetails[] - `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 - `model` 'VANTAGE_SCORE_3_0' | 'FICO_SCORE_4' | 'FICO_SCORE_8': Scoring model - `sourceBureau` 'Equifax' | 'Experian' | 'TransUnion': Source bureau - `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. - `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 - `connectionStatus` ConnectionStatus - `isValid` boolean - `statusCode` number, required: Status codes to represent the current state of this connection - `description` string, required - `userAction` string - `isAuthSuccessful` boolean - `isSecurityStepPending` boolean - `isQuestionStepPending` boolean - `lastSuccessfulAuthOn` number - `lastAuthAttemptOn` number - `statusChangeLogs` StatusLog[] - `previousStatus` 'VALID' | 'INVALID', required - `updatedStatus` 'VALID' | 'INVALID', required - `statusUpdateTs` number, required - `dataStatus` DataStatus, required - `status` 'IN_PROGRESS' | 'COMPLETED' | 'ERROR' | 'Success', required - `updatedOn` number - `updatedOn` number - `createdOn` number - `homeLoans` HomeLoanResponse[] - `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 - `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 - `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 - `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 - `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 - `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 - `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 - `firstDelinquencyDateWithFormat` 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 - `lastActivityDateWithFormat` 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 - `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 - `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 - `mostRecentAdverseRating` '0' | '1' | '2' | '3' | '4' | '5' | '6' | 'G' | 'H' | 'J' | 'R' | 'L' | 'E' | 'B' | 'D': Most recent adverse rating - `mostRecentAdverseRatingDateWithFormat` 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 - `secondMostRecentAdverseRating` '0' | '1' | '2' | '3' | '4' | '5' | '6' | 'G' | 'H' | 'J' | 'R' | 'L' | 'E' | 'B' | 'D': Second most recent adverse rating - `secondMostRecentAdverseRatingDateWithFormat` 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 - `adverseRatingCount` number: Total count of adverse ratings - `liabilityTransfers` LiabilityTransfers - `transferredFrom` LiabilityTransfer - `creditorName` string, required: Creditor name - `transferredTo` LiabilityTransfer - `creditorName` string, required: Creditor name - `narratives` Narratives[]: Details about consumer account narratives - `code` string: Narrative's code - `description` string: Narrative's description - `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 - `lastAssessedStatementDate` string, date: Date of the last assessed statement - `details` PaymentHistoryDetails[] - `date` string, date: Date of billing period - `description` string: Description of the payment - `code` '0' | '1' | '2' | '3' | '4' | '5' | '6' | 'G' | 'H' | 'J' | 'R' | 'L' | 'E' | 'B' | 'D': Code representing the payment status - `balanceDetails` LiabilityBalanceDetails, required - `outstandingBalance` number: Current balance on the account - `updatedOn` number: Timestamp of the last update - `statementSummary` LiabilityStatementSummary, required - `statementDateWithFormat` 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 - `statementBalance` number: Total balance on the statement - `principalBalance` number: Principal balance on the loan - `minimumPaymentAmount` number: Minimum amount due for payment - `lastPaymentDateWithFormat` 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 - `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 - `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 - `reportedDate` string, date-time: Date when this address was reported - `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 - `addressType` 'PREVIOUS' | 'CURRENT': Type of address (current/previous) - `address` Address - `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 - `billingAddress` Address - `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 - `capabilities` CapabilityMatrix - `payments` PaymentsCapability - `billPayment` Capability, required - `availability` 'NOT_SUPPORTED' | 'SUPPORTED' | 'FIELD_ERROR', required: The availability status of a capability - `fieldErrors` FieldError[]: Field-level errors if applicable. - … - `description` 'INSTITUTION_NOT_SUPPORTED' | 'INSTITUTION_DISABLED' | 'REFRESH_EXHAUSTED' | 'NOT_PRIMARY_ACCOUNT_HOLDER' | 'ACCOUNT_TERMINATED' | 'CLOSED_ACCOUNT_NO_BALANCE' | 'CLOSED_ACCOUNT' | 'ACCOUNT_NUMBER_VERIFICATION_FAILED': Description of why the capability is not supported, if applicable. - `nextEligibleRefreshOn` number: The earliest timestamp that the capability will be available, if applicable. - `liabilityGroupId` string: Unique identifier of the liability group for the capability. - `pushToCard` Capability - `availability` 'NOT_SUPPORTED' | 'SUPPORTED' | 'FIELD_ERROR', required: The availability status of a capability - `fieldErrors` FieldError[]: Field-level errors if applicable. - … - `description` 'INSTITUTION_NOT_SUPPORTED' | 'INSTITUTION_DISABLED' | 'REFRESH_EXHAUSTED' | 'NOT_PRIMARY_ACCOUNT_HOLDER' | 'ACCOUNT_TERMINATED' | 'CLOSED_ACCOUNT_NO_BALANCE' | 'CLOSED_ACCOUNT' | 'ACCOUNT_NUMBER_VERIFICATION_FAILED': Description of why the capability is not supported, if applicable. - `nextEligibleRefreshOn` number: The earliest timestamp that the capability will be available, if applicable. - `liabilityGroupId` string: Unique identifier of the liability group for the capability. - `receiveOnlyPayment` Capability - `availability` 'NOT_SUPPORTED' | 'SUPPORTED' | 'FIELD_ERROR', required: The availability status of a capability - `fieldErrors` FieldError[]: Field-level errors if applicable. - … - `description` 'INSTITUTION_NOT_SUPPORTED' | 'INSTITUTION_DISABLED' | 'REFRESH_EXHAUSTED' | 'NOT_PRIMARY_ACCOUNT_HOLDER' | 'ACCOUNT_TERMINATED' | 'CLOSED_ACCOUNT_NO_BALANCE' | 'CLOSED_ACCOUNT' | 'ACCOUNT_NUMBER_VERIFICATION_FAILED': Description of why the capability is not supported, if applicable. - `nextEligibleRefreshOn` number: The earliest timestamp that the capability will be available, if applicable. - `liabilityGroupId` string: Unique identifier of the liability group for the capability. - `data` DataCapability - `realtimeBalance` Capability, required - `availability` 'NOT_SUPPORTED' | 'SUPPORTED' | 'FIELD_ERROR', required: The availability status of a capability - `fieldErrors` FieldError[]: Field-level errors if applicable. - … - `description` 'INSTITUTION_NOT_SUPPORTED' | 'INSTITUTION_DISABLED' | 'REFRESH_EXHAUSTED' | 'NOT_PRIMARY_ACCOUNT_HOLDER' | 'ACCOUNT_TERMINATED' | 'CLOSED_ACCOUNT_NO_BALANCE' | 'CLOSED_ACCOUNT' | 'ACCOUNT_NUMBER_VERIFICATION_FAILED': Description of why the capability is not supported, if applicable. - `nextEligibleRefreshOn` number: The earliest timestamp that the capability will be available, if applicable. - `liabilityGroupId` string: Unique identifier of the liability group for the capability. - `payoffSummary` Capability - `availability` 'NOT_SUPPORTED' | 'SUPPORTED' | 'FIELD_ERROR', required: The availability status of a capability - `fieldErrors` FieldError[]: Field-level errors if applicable. - … - `description` 'INSTITUTION_NOT_SUPPORTED' | 'INSTITUTION_DISABLED' | 'REFRESH_EXHAUSTED' | 'NOT_PRIMARY_ACCOUNT_HOLDER' | 'ACCOUNT_TERMINATED' | 'CLOSED_ACCOUNT_NO_BALANCE' | 'CLOSED_ACCOUNT' | 'ACCOUNT_NUMBER_VERIFICATION_FAILED': Description of why the capability is not supported, if applicable. - `nextEligibleRefreshOn` number: The earliest timestamp that the capability will be available, if applicable. - `liabilityGroupId` string: Unique identifier of the liability group for the capability. - `liabilityGroupPayoffQuote` Capability - `availability` 'NOT_SUPPORTED' | 'SUPPORTED' | 'FIELD_ERROR', required: The availability status of a capability - `fieldErrors` FieldError[]: Field-level errors if applicable. - … - `description` 'INSTITUTION_NOT_SUPPORTED' | 'INSTITUTION_DISABLED' | 'REFRESH_EXHAUSTED' | 'NOT_PRIMARY_ACCOUNT_HOLDER' | 'ACCOUNT_TERMINATED' | 'CLOSED_ACCOUNT_NO_BALANCE' | 'CLOSED_ACCOUNT' | 'ACCOUNT_NUMBER_VERIFICATION_FAILED': Description of why the capability is not supported, if applicable. - `nextEligibleRefreshOn` number: The earliest timestamp that the capability will be available, if applicable. - `liabilityGroupId` string: Unique identifier of the liability group for the capability. - `statementSummary` Capability - `availability` 'NOT_SUPPORTED' | 'SUPPORTED' | 'FIELD_ERROR', required: The availability status of a capability - `fieldErrors` FieldError[]: Field-level errors if applicable. - … - `description` 'INSTITUTION_NOT_SUPPORTED' | 'INSTITUTION_DISABLED' | 'REFRESH_EXHAUSTED' | 'NOT_PRIMARY_ACCOUNT_HOLDER' | 'ACCOUNT_TERMINATED' | 'CLOSED_ACCOUNT_NO_BALANCE' | 'CLOSED_ACCOUNT' | 'ACCOUNT_NUMBER_VERIFICATION_FAILED': Description of why the capability is not supported, if applicable. - `nextEligibleRefreshOn` number: The earliest timestamp that the capability will be available, if applicable. - `liabilityGroupId` string: Unique identifier of the liability group for the capability. - `annualPercentageRate` Capability - `availability` 'NOT_SUPPORTED' | 'SUPPORTED' | 'FIELD_ERROR', required: The availability status of a capability - `fieldErrors` FieldError[]: Field-level errors if applicable. - … - `description` 'INSTITUTION_NOT_SUPPORTED' | 'INSTITUTION_DISABLED' | 'REFRESH_EXHAUSTED' | 'NOT_PRIMARY_ACCOUNT_HOLDER' | 'ACCOUNT_TERMINATED' | 'CLOSED_ACCOUNT_NO_BALANCE' | 'CLOSED_ACCOUNT' | 'ACCOUNT_NUMBER_VERIFICATION_FAILED': Description of why the capability is not supported, if applicable. - `nextEligibleRefreshOn` number: The earliest timestamp that the capability will be available, if applicable. - `liabilityGroupId` string: Unique identifier of the liability group for the capability. - `cardBrand` Capability - `availability` 'NOT_SUPPORTED' | 'SUPPORTED' | 'FIELD_ERROR', required: The availability status of a capability - `fieldErrors` FieldError[]: Field-level errors if applicable. - … - `description` 'INSTITUTION_NOT_SUPPORTED' | 'INSTITUTION_DISABLED' | 'REFRESH_EXHAUSTED' | 'NOT_PRIMARY_ACCOUNT_HOLDER' | 'ACCOUNT_TERMINATED' | 'CLOSED_ACCOUNT_NO_BALANCE' | 'CLOSED_ACCOUNT' | 'ACCOUNT_NUMBER_VERIFICATION_FAILED': Description of why the capability is not supported, if applicable. - `nextEligibleRefreshOn` number: The earliest timestamp that the capability will be available, if applicable. - `liabilityGroupId` string: Unique identifier of the liability group for the capability. - `autoLoans` AutoLoanResponse[] - `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 - `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 - `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 - `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 - `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 - `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 - `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 - `firstDelinquencyDateWithFormat` 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 - `lastActivityDateWithFormat` 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 - `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 - `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 - `mostRecentAdverseRating` '0' | '1' | '2' | '3' | '4' | '5' | '6' | 'G' | 'H' | 'J' | 'R' | 'L' | 'E' | 'B' | 'D': Most recent adverse rating - `mostRecentAdverseRatingDateWithFormat` 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 - `secondMostRecentAdverseRating` '0' | '1' | '2' | '3' | '4' | '5' | '6' | 'G' | 'H' | 'J' | 'R' | 'L' | 'E' | 'B' | 'D': Second most recent adverse rating - `secondMostRecentAdverseRatingDateWithFormat` 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 - `adverseRatingCount` number: Total count of adverse ratings - `liabilityTransfers` LiabilityTransfers - `transferredFrom` LiabilityTransfer - `creditorName` string, required: Creditor name - `transferredTo` LiabilityTransfer - `creditorName` string, required: Creditor name - `narratives` Narratives[]: Details about consumer account narratives - `code` string: Narrative's code - `description` string: Narrative's description - `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 - `lastAssessedStatementDate` string, date: Date of the last assessed statement - `details` PaymentHistoryDetails[] - `date` string, date: Date of billing period - `description` string: Description of the payment - `code` '0' | '1' | '2' | '3' | '4' | '5' | '6' | 'G' | 'H' | 'J' | 'R' | 'L' | 'E' | 'B' | 'D': Code representing the payment status - `balanceDetails` LiabilityBalanceDetails, required - `outstandingBalance` number: Current balance on the account - `updatedOn` number: Timestamp of the last update - `statementSummary` LiabilityStatementSummary, required - `statementDateWithFormat` 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 - `statementBalance` number: Total balance on the statement - `principalBalance` number: Principal balance on the loan - `minimumPaymentAmount` number: Minimum amount due for payment - `lastPaymentDateWithFormat` 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 - `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 - `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 - `reportedDate` string, date-time: Date when this address was reported - `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 - `addressType` 'PREVIOUS' | 'CURRENT': Type of address (current/previous) - `address` Address - `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 - `billingAddress` Address - `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 - `capabilities` CapabilityMatrix, required - `payments` PaymentsCapability - `billPayment` Capability, required - `availability` 'NOT_SUPPORTED' | 'SUPPORTED' | 'FIELD_ERROR', required: The availability status of a capability - `fieldErrors` FieldError[]: Field-level errors if applicable. - … - `description` 'INSTITUTION_NOT_SUPPORTED' | 'INSTITUTION_DISABLED' | 'REFRESH_EXHAUSTED' | 'NOT_PRIMARY_ACCOUNT_HOLDER' | 'ACCOUNT_TERMINATED' | 'CLOSED_ACCOUNT_NO_BALANCE' | 'CLOSED_ACCOUNT' | 'ACCOUNT_NUMBER_VERIFICATION_FAILED': Description of why the capability is not supported, if applicable. - `nextEligibleRefreshOn` number: The earliest timestamp that the capability will be available, if applicable. - `liabilityGroupId` string: Unique identifier of the liability group for the capability. - `pushToCard` Capability - `availability` 'NOT_SUPPORTED' | 'SUPPORTED' | 'FIELD_ERROR', required: The availability status of a capability - `fieldErrors` FieldError[]: Field-level errors if applicable. - … - `description` 'INSTITUTION_NOT_SUPPORTED' | 'INSTITUTION_DISABLED' | 'REFRESH_EXHAUSTED' | 'NOT_PRIMARY_ACCOUNT_HOLDER' | 'ACCOUNT_TERMINATED' | 'CLOSED_ACCOUNT_NO_BALANCE' | 'CLOSED_ACCOUNT' | 'ACCOUNT_NUMBER_VERIFICATION_FAILED': Description of why the capability is not supported, if applicable. - `nextEligibleRefreshOn` number: The earliest timestamp that the capability will be available, if applicable. - `liabilityGroupId` string: Unique identifier of the liability group for the capability. - `receiveOnlyPayment` Capability - `availability` 'NOT_SUPPORTED' | 'SUPPORTED' | 'FIELD_ERROR', required: The availability status of a capability - `fieldErrors` FieldError[]: Field-level errors if applicable. - … - `description` 'INSTITUTION_NOT_SUPPORTED' | 'INSTITUTION_DISABLED' | 'REFRESH_EXHAUSTED' | 'NOT_PRIMARY_ACCOUNT_HOLDER' | 'ACCOUNT_TERMINATED' | 'CLOSED_ACCOUNT_NO_BALANCE' | 'CLOSED_ACCOUNT' | 'ACCOUNT_NUMBER_VERIFICATION_FAILED': Description of why the capability is not supported, if applicable. - `nextEligibleRefreshOn` number: The earliest timestamp that the capability will be available, if applicable. - `liabilityGroupId` string: Unique identifier of the liability group for the capability. - `data` DataCapability - `realtimeBalance` Capability, required - `availability` 'NOT_SUPPORTED' | 'SUPPORTED' | 'FIELD_ERROR', required: The availability status of a capability - `fieldErrors` FieldError[]: Field-level errors if applicable. - … - `description` 'INSTITUTION_NOT_SUPPORTED' | 'INSTITUTION_DISABLED' | 'REFRESH_EXHAUSTED' | 'NOT_PRIMARY_ACCOUNT_HOLDER' | 'ACCOUNT_TERMINATED' | 'CLOSED_ACCOUNT_NO_BALANCE' | 'CLOSED_ACCOUNT' | 'ACCOUNT_NUMBER_VERIFICATION_FAILED': Description of why the capability is not supported, if applicable. - `nextEligibleRefreshOn` number: The earliest timestamp that the capability will be available, if applicable. - `liabilityGroupId` string: Unique identifier of the liability group for the capability. - `payoffSummary` Capability - `availability` 'NOT_SUPPORTED' | 'SUPPORTED' | 'FIELD_ERROR', required: The availability status of a capability - `fieldErrors` FieldError[]: Field-level errors if applicable. - … - `description` 'INSTITUTION_NOT_SUPPORTED' | 'INSTITUTION_DISABLED' | 'REFRESH_EXHAUSTED' | 'NOT_PRIMARY_ACCOUNT_HOLDER' | 'ACCOUNT_TERMINATED' | 'CLOSED_ACCOUNT_NO_BALANCE' | 'CLOSED_ACCOUNT' | 'ACCOUNT_NUMBER_VERIFICATION_FAILED': Description of why the capability is not supported, if applicable. - `nextEligibleRefreshOn` number: The earliest timestamp that the capability will be available, if applicable. - `liabilityGroupId` string: Unique identifier of the liability group for the capability. - `liabilityGroupPayoffQuote` Capability - `availability` 'NOT_SUPPORTED' | 'SUPPORTED' | 'FIELD_ERROR', required: The availability status of a capability - `fieldErrors` FieldError[]: Field-level errors if applicable. - … - `description` 'INSTITUTION_NOT_SUPPORTED' | 'INSTITUTION_DISABLED' | 'REFRESH_EXHAUSTED' | 'NOT_PRIMARY_ACCOUNT_HOLDER' | 'ACCOUNT_TERMINATED' | 'CLOSED_ACCOUNT_NO_BALANCE' | 'CLOSED_ACCOUNT' | 'ACCOUNT_NUMBER_VERIFICATION_FAILED': Description of why the capability is not supported, if applicable. - `nextEligibleRefreshOn` number: The earliest timestamp that the capability will be available, if applicable. - `liabilityGroupId` string: Unique identifier of the liability group for the capability. - `statementSummary` Capability - `availability` 'NOT_SUPPORTED' | 'SUPPORTED' | 'FIELD_ERROR', required: The availability status of a capability - `fieldErrors` FieldError[]: Field-level errors if applicable. - … - `description` 'INSTITUTION_NOT_SUPPORTED' | 'INSTITUTION_DISABLED' | 'REFRESH_EXHAUSTED' | 'NOT_PRIMARY_ACCOUNT_HOLDER' | 'ACCOUNT_TERMINATED' | 'CLOSED_ACCOUNT_NO_BALANCE' | 'CLOSED_ACCOUNT' | 'ACCOUNT_NUMBER_VERIFICATION_FAILED': Description of why the capability is not supported, if applicable. - `nextEligibleRefreshOn` number: The earliest timestamp that the capability will be available, if applicable. - `liabilityGroupId` string: Unique identifier of the liability group for the capability. - `annualPercentageRate` Capability - `availability` 'NOT_SUPPORTED' | 'SUPPORTED' | 'FIELD_ERROR', required: The availability status of a capability - `fieldErrors` FieldError[]: Field-level errors if applicable. - … - `description` 'INSTITUTION_NOT_SUPPORTED' | 'INSTITUTION_DISABLED' | 'REFRESH_EXHAUSTED' | 'NOT_PRIMARY_ACCOUNT_HOLDER' | 'ACCOUNT_TERMINATED' | 'CLOSED_ACCOUNT_NO_BALANCE' | 'CLOSED_ACCOUNT' | 'ACCOUNT_NUMBER_VERIFICATION_FAILED': Description of why the capability is not supported, if applicable. - `nextEligibleRefreshOn` number: The earliest timestamp that the capability will be available, if applicable. - `liabilityGroupId` string: Unique identifier of the liability group for the capability. - `cardBrand` Capability - `availability` 'NOT_SUPPORTED' | 'SUPPORTED' | 'FIELD_ERROR', required: The availability status of a capability - `fieldErrors` FieldError[]: Field-level errors if applicable. - … - `description` 'INSTITUTION_NOT_SUPPORTED' | 'INSTITUTION_DISABLED' | 'REFRESH_EXHAUSTED' | 'NOT_PRIMARY_ACCOUNT_HOLDER' | 'ACCOUNT_TERMINATED' | 'CLOSED_ACCOUNT_NO_BALANCE' | 'CLOSED_ACCOUNT' | 'ACCOUNT_NUMBER_VERIFICATION_FAILED': Description of why the capability is not supported, if applicable. - `nextEligibleRefreshOn` number: The earliest timestamp that the capability will be available, if applicable. - `liabilityGroupId` string: Unique identifier of the liability group for the capability. - `personalLoans` PersonalLoanResponse[] - `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 - `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 - `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 - `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 - `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 - `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 - `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 - `firstDelinquencyDateWithFormat` 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 - `lastActivityDateWithFormat` 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 - `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 - `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 - `mostRecentAdverseRating` '0' | '1' | '2' | '3' | '4' | '5' | '6' | 'G' | 'H' | 'J' | 'R' | 'L' | 'E' | 'B' | 'D': Most recent adverse rating - `mostRecentAdverseRatingDateWithFormat` 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 - `secondMostRecentAdverseRating` '0' | '1' | '2' | '3' | '4' | '5' | '6' | 'G' | 'H' | 'J' | 'R' | 'L' | 'E' | 'B' | 'D': Second most recent adverse rating - `secondMostRecentAdverseRatingDateWithFormat` 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 - `adverseRatingCount` number: Total count of adverse ratings - `liabilityTransfers` LiabilityTransfers - `transferredFrom` LiabilityTransfer - `creditorName` string, required: Creditor name - `transferredTo` LiabilityTransfer - `creditorName` string, required: Creditor name - `narratives` Narratives[]: Details about consumer account narratives - `code` string: Narrative's code - `description` string: Narrative's description - `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 - `lastAssessedStatementDate` string, date: Date of the last assessed statement - `details` PaymentHistoryDetails[] - `date` string, date: Date of billing period - `description` string: Description of the payment - `code` '0' | '1' | '2' | '3' | '4' | '5' | '6' | 'G' | 'H' | 'J' | 'R' | 'L' | 'E' | 'B' | 'D': Code representing the payment status - `balanceDetails` LiabilityBalanceDetails, required - `outstandingBalance` number: Current balance on the account - `updatedOn` number: Timestamp of the last update - `statementSummary` LiabilityStatementSummary, required - `statementDateWithFormat` 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 - `statementBalance` number: Total balance on the statement - `principalBalance` number: Principal balance on the loan - `minimumPaymentAmount` number: Minimum amount due for payment - `lastPaymentDateWithFormat` 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 - `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 - `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 - `reportedDate` string, date-time: Date when this address was reported - `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 - `addressType` 'PREVIOUS' | 'CURRENT': Type of address (current/previous) - `address` Address - `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 - `billingAddress` Address - `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 - `capabilities` CapabilityMatrix, required - `payments` PaymentsCapability - `billPayment` Capability, required - `availability` 'NOT_SUPPORTED' | 'SUPPORTED' | 'FIELD_ERROR', required: The availability status of a capability - `fieldErrors` FieldError[]: Field-level errors if applicable. - … - `description` 'INSTITUTION_NOT_SUPPORTED' | 'INSTITUTION_DISABLED' | 'REFRESH_EXHAUSTED' | 'NOT_PRIMARY_ACCOUNT_HOLDER' | 'ACCOUNT_TERMINATED' | 'CLOSED_ACCOUNT_NO_BALANCE' | 'CLOSED_ACCOUNT' | 'ACCOUNT_NUMBER_VERIFICATION_FAILED': Description of why the capability is not supported, if applicable. - `nextEligibleRefreshOn` number: The earliest timestamp that the capability will be available, if applicable. - `liabilityGroupId` string: Unique identifier of the liability group for the capability. - `pushToCard` Capability - `availability` 'NOT_SUPPORTED' | 'SUPPORTED' | 'FIELD_ERROR', required: The availability status of a capability - `fieldErrors` FieldError[]: Field-level errors if applicable. - … - `description` 'INSTITUTION_NOT_SUPPORTED' | 'INSTITUTION_DISABLED' | 'REFRESH_EXHAUSTED' | 'NOT_PRIMARY_ACCOUNT_HOLDER' | 'ACCOUNT_TERMINATED' | 'CLOSED_ACCOUNT_NO_BALANCE' | 'CLOSED_ACCOUNT' | 'ACCOUNT_NUMBER_VERIFICATION_FAILED': Description of why the capability is not supported, if applicable. - `nextEligibleRefreshOn` number: The earliest timestamp that the capability will be available, if applicable. - `liabilityGroupId` string: Unique identifier of the liability group for the capability. - `receiveOnlyPayment` Capability - `availability` 'NOT_SUPPORTED' | 'SUPPORTED' | 'FIELD_ERROR', required: The availability status of a capability - `fieldErrors` FieldError[]: Field-level errors if applicable. - … - `description` 'INSTITUTION_NOT_SUPPORTED' | 'INSTITUTION_DISABLED' | 'REFRESH_EXHAUSTED' | 'NOT_PRIMARY_ACCOUNT_HOLDER' | 'ACCOUNT_TERMINATED' | 'CLOSED_ACCOUNT_NO_BALANCE' | 'CLOSED_ACCOUNT' | 'ACCOUNT_NUMBER_VERIFICATION_FAILED': Description of why the capability is not supported, if applicable. - `nextEligibleRefreshOn` number: The earliest timestamp that the capability will be available, if applicable. - `liabilityGroupId` string: Unique identifier of the liability group for the capability. - `data` DataCapability - `realtimeBalance` Capability, required - `availability` 'NOT_SUPPORTED' | 'SUPPORTED' | 'FIELD_ERROR', required: The availability status of a capability - `fieldErrors` FieldError[]: Field-level errors if applicable. - … - `description` 'INSTITUTION_NOT_SUPPORTED' | 'INSTITUTION_DISABLED' | 'REFRESH_EXHAUSTED' | 'NOT_PRIMARY_ACCOUNT_HOLDER' | 'ACCOUNT_TERMINATED' | 'CLOSED_ACCOUNT_NO_BALANCE' | 'CLOSED_ACCOUNT' | 'ACCOUNT_NUMBER_VERIFICATION_FAILED': Description of why the capability is not supported, if applicable. - `nextEligibleRefreshOn` number: The earliest timestamp that the capability will be available, if applicable. - `liabilityGroupId` string: Unique identifier of the liability group for the capability. - `payoffSummary` Capability - `availability` 'NOT_SUPPORTED' | 'SUPPORTED' | 'FIELD_ERROR', required: The availability status of a capability - `fieldErrors` FieldError[]: Field-level errors if applicable. - … - `description` 'INSTITUTION_NOT_SUPPORTED' | 'INSTITUTION_DISABLED' | 'REFRESH_EXHAUSTED' | 'NOT_PRIMARY_ACCOUNT_HOLDER' | 'ACCOUNT_TERMINATED' | 'CLOSED_ACCOUNT_NO_BALANCE' | 'CLOSED_ACCOUNT' | 'ACCOUNT_NUMBER_VERIFICATION_FAILED': Description of why the capability is not supported, if applicable. - `nextEligibleRefreshOn` number: The earliest timestamp that the capability will be available, if applicable. - `liabilityGroupId` string: Unique identifier of the liability group for the capability. - `liabilityGroupPayoffQuote` Capability - `availability` 'NOT_SUPPORTED' | 'SUPPORTED' | 'FIELD_ERROR', required: The availability status of a capability - `fieldErrors` FieldError[]: Field-level errors if applicable. - … - `description` 'INSTITUTION_NOT_SUPPORTED' | 'INSTITUTION_DISABLED' | 'REFRESH_EXHAUSTED' | 'NOT_PRIMARY_ACCOUNT_HOLDER' | 'ACCOUNT_TERMINATED' | 'CLOSED_ACCOUNT_NO_BALANCE' | 'CLOSED_ACCOUNT' | 'ACCOUNT_NUMBER_VERIFICATION_FAILED': Description of why the capability is not supported, if applicable. - `nextEligibleRefreshOn` number: The earliest timestamp that the capability will be available, if applicable. - `liabilityGroupId` string: Unique identifier of the liability group for the capability. - `statementSummary` Capability - `availability` 'NOT_SUPPORTED' | 'SUPPORTED' | 'FIELD_ERROR', required: The availability status of a capability - `fieldErrors` FieldError[]: Field-level errors if applicable. - … - `description` 'INSTITUTION_NOT_SUPPORTED' | 'INSTITUTION_DISABLED' | 'REFRESH_EXHAUSTED' | 'NOT_PRIMARY_ACCOUNT_HOLDER' | 'ACCOUNT_TERMINATED' | 'CLOSED_ACCOUNT_NO_BALANCE' | 'CLOSED_ACCOUNT' | 'ACCOUNT_NUMBER_VERIFICATION_FAILED': Description of why the capability is not supported, if applicable. - `nextEligibleRefreshOn` number: The earliest timestamp that the capability will be available, if applicable. - `liabilityGroupId` string: Unique identifier of the liability group for the capability. - `annualPercentageRate` Capability - `availability` 'NOT_SUPPORTED' | 'SUPPORTED' | 'FIELD_ERROR', required: The availability status of a capability - `fieldErrors` FieldError[]: Field-level errors if applicable. - … - `description` 'INSTITUTION_NOT_SUPPORTED' | 'INSTITUTION_DISABLED' | 'REFRESH_EXHAUSTED' | 'NOT_PRIMARY_ACCOUNT_HOLDER' | 'ACCOUNT_TERMINATED' | 'CLOSED_ACCOUNT_NO_BALANCE' | 'CLOSED_ACCOUNT' | 'ACCOUNT_NUMBER_VERIFICATION_FAILED': Description of why the capability is not supported, if applicable. - `nextEligibleRefreshOn` number: The earliest timestamp that the capability will be available, if applicable. - `liabilityGroupId` string: Unique identifier of the liability group for the capability. - `cardBrand` Capability - `availability` 'NOT_SUPPORTED' | 'SUPPORTED' | 'FIELD_ERROR', required: The availability status of a capability - `fieldErrors` FieldError[]: Field-level errors if applicable. - … - `description` 'INSTITUTION_NOT_SUPPORTED' | 'INSTITUTION_DISABLED' | 'REFRESH_EXHAUSTED' | 'NOT_PRIMARY_ACCOUNT_HOLDER' | 'ACCOUNT_TERMINATED' | 'CLOSED_ACCOUNT_NO_BALANCE' | 'CLOSED_ACCOUNT' | 'ACCOUNT_NUMBER_VERIFICATION_FAILED': Description of why the capability is not supported, if applicable. - `nextEligibleRefreshOn` number: The earliest timestamp that the capability will be available, if applicable. - `liabilityGroupId` string: Unique identifier of the liability group for the capability. - `miscellaneousLiabilities` MiscellaneousLiabilityResponse[] - `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 - `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 - `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 - `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 - `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 - `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 - `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 - `firstDelinquencyDateWithFormat` 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 - `lastActivityDateWithFormat` 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 - `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 - `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 - `mostRecentAdverseRating` '0' | '1' | '2' | '3' | '4' | '5' | '6' | 'G' | 'H' | 'J' | 'R' | 'L' | 'E' | 'B' | 'D': Most recent adverse rating - `mostRecentAdverseRatingDateWithFormat` 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 - `secondMostRecentAdverseRating` '0' | '1' | '2' | '3' | '4' | '5' | '6' | 'G' | 'H' | 'J' | 'R' | 'L' | 'E' | 'B' | 'D': Second most recent adverse rating - `secondMostRecentAdverseRatingDateWithFormat` 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 - `adverseRatingCount` number: Total count of adverse ratings - `liabilityTransfers` LiabilityTransfers - `transferredFrom` LiabilityTransfer - `creditorName` string, required: Creditor name - `transferredTo` LiabilityTransfer - `creditorName` string, required: Creditor name - `narratives` Narratives[]: Details about consumer account narratives - `code` string: Narrative's code - `description` string: Narrative's description - `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 - `lastAssessedStatementDate` string, date: Date of the last assessed statement - `details` PaymentHistoryDetails[] - `date` string, date: Date of billing period - `description` string: Description of the payment - `code` '0' | '1' | '2' | '3' | '4' | '5' | '6' | 'G' | 'H' | 'J' | 'R' | 'L' | 'E' | 'B' | 'D': Code representing the payment status - `balanceDetails` LiabilityBalanceDetails, required - `outstandingBalance` number: Current balance on the account - `updatedOn` number: Timestamp of the last update - `statementSummary` LiabilityStatementSummary, required - `statementDateWithFormat` 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 - `statementBalance` number: Total balance on the statement - `principalBalance` number: Principal balance on the loan - `minimumPaymentAmount` number: Minimum amount due for payment - `lastPaymentDateWithFormat` 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 - `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 - `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 - `reportedDate` string, date-time: Date when this address was reported - `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 - `addressType` 'PREVIOUS' | 'CURRENT': Type of address (current/previous) - `address` Address - `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 - `billingAddress` Address - `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 - `capabilities` CapabilityMatrix, required - `payments` PaymentsCapability - `billPayment` Capability, required - `availability` 'NOT_SUPPORTED' | 'SUPPORTED' | 'FIELD_ERROR', required: The availability status of a capability - `fieldErrors` FieldError[]: Field-level errors if applicable. - … - `description` 'INSTITUTION_NOT_SUPPORTED' | 'INSTITUTION_DISABLED' | 'REFRESH_EXHAUSTED' | 'NOT_PRIMARY_ACCOUNT_HOLDER' | 'ACCOUNT_TERMINATED' | 'CLOSED_ACCOUNT_NO_BALANCE' | 'CLOSED_ACCOUNT' | 'ACCOUNT_NUMBER_VERIFICATION_FAILED': Description of why the capability is not supported, if applicable. - `nextEligibleRefreshOn` number: The earliest timestamp that the capability will be available, if applicable. - `liabilityGroupId` string: Unique identifier of the liability group for the capability. - `pushToCard` Capability - `availability` 'NOT_SUPPORTED' | 'SUPPORTED' | 'FIELD_ERROR', required: The availability status of a capability - `fieldErrors` FieldError[]: Field-level errors if applicable. - … - `description` 'INSTITUTION_NOT_SUPPORTED' | 'INSTITUTION_DISABLED' | 'REFRESH_EXHAUSTED' | 'NOT_PRIMARY_ACCOUNT_HOLDER' | 'ACCOUNT_TERMINATED' | 'CLOSED_ACCOUNT_NO_BALANCE' | 'CLOSED_ACCOUNT' | 'ACCOUNT_NUMBER_VERIFICATION_FAILED': Description of why the capability is not supported, if applicable. - `nextEligibleRefreshOn` number: The earliest timestamp that the capability will be available, if applicable. - `liabilityGroupId` string: Unique identifier of the liability group for the capability. - `receiveOnlyPayment` Capability - `availability` 'NOT_SUPPORTED' | 'SUPPORTED' | 'FIELD_ERROR', required: The availability status of a capability - `fieldErrors` FieldError[]: Field-level errors if applicable. - … - `description` 'INSTITUTION_NOT_SUPPORTED' | 'INSTITUTION_DISABLED' | 'REFRESH_EXHAUSTED' | 'NOT_PRIMARY_ACCOUNT_HOLDER' | 'ACCOUNT_TERMINATED' | 'CLOSED_ACCOUNT_NO_BALANCE' | 'CLOSED_ACCOUNT' | 'ACCOUNT_NUMBER_VERIFICATION_FAILED': Description of why the capability is not supported, if applicable. - `nextEligibleRefreshOn` number: The earliest timestamp that the capability will be available, if applicable. - `liabilityGroupId` string: Unique identifier of the liability group for the capability. - `data` DataCapability - `realtimeBalance` Capability, required - `availability` 'NOT_SUPPORTED' | 'SUPPORTED' | 'FIELD_ERROR', required: The availability status of a capability - `fieldErrors` FieldError[]: Field-level errors if applicable. - … - `description` 'INSTITUTION_NOT_SUPPORTED' | 'INSTITUTION_DISABLED' | 'REFRESH_EXHAUSTED' | 'NOT_PRIMARY_ACCOUNT_HOLDER' | 'ACCOUNT_TERMINATED' | 'CLOSED_ACCOUNT_NO_BALANCE' | 'CLOSED_ACCOUNT' | 'ACCOUNT_NUMBER_VERIFICATION_FAILED': Description of why the capability is not supported, if applicable. - `nextEligibleRefreshOn` number: The earliest timestamp that the capability will be available, if applicable. - `liabilityGroupId` string: Unique identifier of the liability group for the capability. - `payoffSummary` Capability - `availability` 'NOT_SUPPORTED' | 'SUPPORTED' | 'FIELD_ERROR', required: The availability status of a capability - `fieldErrors` FieldError[]: Field-level errors if applicable. - … - `description` 'INSTITUTION_NOT_SUPPORTED' | 'INSTITUTION_DISABLED' | 'REFRESH_EXHAUSTED' | 'NOT_PRIMARY_ACCOUNT_HOLDER' | 'ACCOUNT_TERMINATED' | 'CLOSED_ACCOUNT_NO_BALANCE' | 'CLOSED_ACCOUNT' | 'ACCOUNT_NUMBER_VERIFICATION_FAILED': Description of why the capability is not supported, if applicable. - `nextEligibleRefreshOn` number: The earliest timestamp that the capability will be available, if applicable. - `liabilityGroupId` string: Unique identifier of the liability group for the capability. - `liabilityGroupPayoffQuote` Capability - `availability` 'NOT_SUPPORTED' | 'SUPPORTED' | 'FIELD_ERROR', required: The availability status of a capability - `fieldErrors` FieldError[]: Field-level errors if applicable. - … - `description` 'INSTITUTION_NOT_SUPPORTED' | 'INSTITUTION_DISABLED' | 'REFRESH_EXHAUSTED' | 'NOT_PRIMARY_ACCOUNT_HOLDER' | 'ACCOUNT_TERMINATED' | 'CLOSED_ACCOUNT_NO_BALANCE' | 'CLOSED_ACCOUNT' | 'ACCOUNT_NUMBER_VERIFICATION_FAILED': Description of why the capability is not supported, if applicable. - `nextEligibleRefreshOn` number: The earliest timestamp that the capability will be available, if applicable. - `liabilityGroupId` string: Unique identifier of the liability group for the capability. - `statementSummary` Capability - `availability` 'NOT_SUPPORTED' | 'SUPPORTED' | 'FIELD_ERROR', required: The availability status of a capability - `fieldErrors` FieldError[]: Field-level errors if applicable. - … - `description` 'INSTITUTION_NOT_SUPPORTED' | 'INSTITUTION_DISABLED' | 'REFRESH_EXHAUSTED' | 'NOT_PRIMARY_ACCOUNT_HOLDER' | 'ACCOUNT_TERMINATED' | 'CLOSED_ACCOUNT_NO_BALANCE' | 'CLOSED_ACCOUNT' | 'ACCOUNT_NUMBER_VERIFICATION_FAILED': Description of why the capability is not supported, if applicable. - `nextEligibleRefreshOn` number: The earliest timestamp that the capability will be available, if applicable. - `liabilityGroupId` string: Unique identifier of the liability group for the capability. - `annualPercentageRate` Capability - `availability` 'NOT_SUPPORTED' | 'SUPPORTED' | 'FIELD_ERROR', required: The availability status of a capability - `fieldErrors` FieldError[]: Field-level errors if applicable. - … - `description` 'INSTITUTION_NOT_SUPPORTED' | 'INSTITUTION_DISABLED' | 'REFRESH_EXHAUSTED' | 'NOT_PRIMARY_ACCOUNT_HOLDER' | 'ACCOUNT_TERMINATED' | 'CLOSED_ACCOUNT_NO_BALANCE' | 'CLOSED_ACCOUNT' | 'ACCOUNT_NUMBER_VERIFICATION_FAILED': Description of why the capability is not supported, if applicable. - `nextEligibleRefreshOn` number: The earliest timestamp that the capability will be available, if applicable. - `liabilityGroupId` string: Unique identifier of the liability group for the capability. - `cardBrand` Capability - `availability` 'NOT_SUPPORTED' | 'SUPPORTED' | 'FIELD_ERROR', required: The availability status of a capability - `fieldErrors` FieldError[]: Field-level errors if applicable. - … - `description` 'INSTITUTION_NOT_SUPPORTED' | 'INSTITUTION_DISABLED' | 'REFRESH_EXHAUSTED' | 'NOT_PRIMARY_ACCOUNT_HOLDER' | 'ACCOUNT_TERMINATED' | 'CLOSED_ACCOUNT_NO_BALANCE' | 'CLOSED_ACCOUNT' | 'ACCOUNT_NUMBER_VERIFICATION_FAILED': Description of why the capability is not supported, if applicable. - `nextEligibleRefreshOn` number: The earliest timestamp that the capability will be available, if applicable. - `liabilityGroupId` string: Unique identifier of the liability group for the capability. - `creditCards` CreditCardResponse[] - `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 - `cardBrand` CreditCardBrand - `cardName` string: Name of the card brand - `cardArtUrl` string: URL of the card art - `updatedOn` number: Timestamp of the last update - `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 - `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 - `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 - `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 - `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 - `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 - `firstDelinquencyDateWithFormat` 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 - `lastActivityDateWithFormat` 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 - `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 - `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 - `mostRecentAdverseRating` '0' | '1' | '2' | '3' | '4' | '5' | '6' | 'G' | 'H' | 'J' | 'R' | 'L' | 'E' | 'B' | 'D': Most recent adverse rating - `mostRecentAdverseRatingDateWithFormat` 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 - `secondMostRecentAdverseRating` '0' | '1' | '2' | '3' | '4' | '5' | '6' | 'G' | 'H' | 'J' | 'R' | 'L' | 'E' | 'B' | 'D': Second most recent adverse rating - `secondMostRecentAdverseRatingDateWithFormat` 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 - `adverseRatingCount` number: Total count of adverse ratings - `liabilityTransfers` LiabilityTransfers - `transferredFrom` LiabilityTransfer - `creditorName` string, required: Creditor name - `transferredTo` LiabilityTransfer - `creditorName` string, required: Creditor name - `narratives` Narratives[]: Details about consumer account narratives - `code` string: Narrative's code - `description` string: Narrative's description - `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 - `lastAssessedStatementDate` string, date: Date of the last assessed statement - `details` PaymentHistoryDetails[] - `date` string, date: Date of billing period - `description` string: Description of the payment - `code` '0' | '1' | '2' | '3' | '4' | '5' | '6' | 'G' | 'H' | 'J' | 'R' | 'L' | 'E' | 'B' | 'D': Code representing the payment status - `balanceDetails` CreditCardBalanceDetails - `outstandingBalance` number: Current balance on the account - `updatedOn` number: Timestamp of the last update - `statementSummary` CreditCardStatementSummary, required - `statementDateWithFormat` 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 - `statementBalance` number: Total balance on the statement - `minimumPaymentAmount` number: Minimum amount due for payment - `lastPaymentAmount` number: Amount of last payment - `lastPaymentDateWithFormat` 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 - `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 - `refreshedFields` CreditCardRefreshedFields - `paymentDueDay` RefreshedDateField - `value` string: Date of the field - `format` string: Format of the date - `updatedOn` number: Timestamp of the last update - `lastPaymentDate` RefreshedDateField - `value` string: Date of the field - `format` string: Format of the date - `updatedOn` number: Timestamp of the last update - `lastPaymentAmount` RefreshedPaymentField - `value` number: Payment amount in dollars - `updatedOn` number: Timestamp of the last update - `updatedOn` number: Timestamp of the last update - `dueDateWithFormat` 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 - `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 - `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 - `reportedDate` string, date-time: Date when this address was reported - `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 - `addressType` 'PREVIOUS' | 'CURRENT': Type of address (current/previous) - `address` Address - `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 - `billingAddress` Address - `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 - `capabilities` CapabilityMatrix - `payments` PaymentsCapability - `billPayment` Capability, required - `availability` 'NOT_SUPPORTED' | 'SUPPORTED' | 'FIELD_ERROR', required: The availability status of a capability - `fieldErrors` FieldError[]: Field-level errors if applicable. - … - `description` 'INSTITUTION_NOT_SUPPORTED' | 'INSTITUTION_DISABLED' | 'REFRESH_EXHAUSTED' | 'NOT_PRIMARY_ACCOUNT_HOLDER' | 'ACCOUNT_TERMINATED' | 'CLOSED_ACCOUNT_NO_BALANCE' | 'CLOSED_ACCOUNT' | 'ACCOUNT_NUMBER_VERIFICATION_FAILED': Description of why the capability is not supported, if applicable. - `nextEligibleRefreshOn` number: The earliest timestamp that the capability will be available, if applicable. - `liabilityGroupId` string: Unique identifier of the liability group for the capability. - `pushToCard` Capability - `availability` 'NOT_SUPPORTED' | 'SUPPORTED' | 'FIELD_ERROR', required: The availability status of a capability - `fieldErrors` FieldError[]: Field-level errors if applicable. - … - `description` 'INSTITUTION_NOT_SUPPORTED' | 'INSTITUTION_DISABLED' | 'REFRESH_EXHAUSTED' | 'NOT_PRIMARY_ACCOUNT_HOLDER' | 'ACCOUNT_TERMINATED' | 'CLOSED_ACCOUNT_NO_BALANCE' | 'CLOSED_ACCOUNT' | 'ACCOUNT_NUMBER_VERIFICATION_FAILED': Description of why the capability is not supported, if applicable. - `nextEligibleRefreshOn` number: The earliest timestamp that the capability will be available, if applicable. - `liabilityGroupId` string: Unique identifier of the liability group for the capability. - `receiveOnlyPayment` Capability - `availability` 'NOT_SUPPORTED' | 'SUPPORTED' | 'FIELD_ERROR', required: The availability status of a capability - `fieldErrors` FieldError[]: Field-level errors if applicable. - … - `description` 'INSTITUTION_NOT_SUPPORTED' | 'INSTITUTION_DISABLED' | 'REFRESH_EXHAUSTED' | 'NOT_PRIMARY_ACCOUNT_HOLDER' | 'ACCOUNT_TERMINATED' | 'CLOSED_ACCOUNT_NO_BALANCE' | 'CLOSED_ACCOUNT' | 'ACCOUNT_NUMBER_VERIFICATION_FAILED': Description of why the capability is not supported, if applicable. - `nextEligibleRefreshOn` number: The earliest timestamp that the capability will be available, if applicable. - `liabilityGroupId` string: Unique identifier of the liability group for the capability. - `data` DataCapability - `realtimeBalance` Capability, required - `availability` 'NOT_SUPPORTED' | 'SUPPORTED' | 'FIELD_ERROR', required: The availability status of a capability - `fieldErrors` FieldError[]: Field-level errors if applicable. - … - `description` 'INSTITUTION_NOT_SUPPORTED' | 'INSTITUTION_DISABLED' | 'REFRESH_EXHAUSTED' | 'NOT_PRIMARY_ACCOUNT_HOLDER' | 'ACCOUNT_TERMINATED' | 'CLOSED_ACCOUNT_NO_BALANCE' | 'CLOSED_ACCOUNT' | 'ACCOUNT_NUMBER_VERIFICATION_FAILED': Description of why the capability is not supported, if applicable. - `nextEligibleRefreshOn` number: The earliest timestamp that the capability will be available, if applicable. - `liabilityGroupId` string: Unique identifier of the liability group for the capability. - `payoffSummary` Capability - `availability` 'NOT_SUPPORTED' | 'SUPPORTED' | 'FIELD_ERROR', required: The availability status of a capability - `fieldErrors` FieldError[]: Field-level errors if applicable. - … - `description` 'INSTITUTION_NOT_SUPPORTED' | 'INSTITUTION_DISABLED' | 'REFRESH_EXHAUSTED' | 'NOT_PRIMARY_ACCOUNT_HOLDER' | 'ACCOUNT_TERMINATED' | 'CLOSED_ACCOUNT_NO_BALANCE' | 'CLOSED_ACCOUNT' | 'ACCOUNT_NUMBER_VERIFICATION_FAILED': Description of why the capability is not supported, if applicable. - `nextEligibleRefreshOn` number: The earliest timestamp that the capability will be available, if applicable. - `liabilityGroupId` string: Unique identifier of the liability group for the capability. - `liabilityGroupPayoffQuote` Capability - `availability` 'NOT_SUPPORTED' | 'SUPPORTED' | 'FIELD_ERROR', required: The availability status of a capability - `fieldErrors` FieldError[]: Field-level errors if applicable. - … - `description` 'INSTITUTION_NOT_SUPPORTED' | 'INSTITUTION_DISABLED' | 'REFRESH_EXHAUSTED' | 'NOT_PRIMARY_ACCOUNT_HOLDER' | 'ACCOUNT_TERMINATED' | 'CLOSED_ACCOUNT_NO_BALANCE' | 'CLOSED_ACCOUNT' | 'ACCOUNT_NUMBER_VERIFICATION_FAILED': Description of why the capability is not supported, if applicable. - `nextEligibleRefreshOn` number: The earliest timestamp that the capability will be available, if applicable. - `liabilityGroupId` string: Unique identifier of the liability group for the capability. - `statementSummary` Capability - `availability` 'NOT_SUPPORTED' | 'SUPPORTED' | 'FIELD_ERROR', required: The availability status of a capability - `fieldErrors` FieldError[]: Field-level errors if applicable. - … - `description` 'INSTITUTION_NOT_SUPPORTED' | 'INSTITUTION_DISABLED' | 'REFRESH_EXHAUSTED' | 'NOT_PRIMARY_ACCOUNT_HOLDER' | 'ACCOUNT_TERMINATED' | 'CLOSED_ACCOUNT_NO_BALANCE' | 'CLOSED_ACCOUNT' | 'ACCOUNT_NUMBER_VERIFICATION_FAILED': Description of why the capability is not supported, if applicable. - `nextEligibleRefreshOn` number: The earliest timestamp that the capability will be available, if applicable. - `liabilityGroupId` string: Unique identifier of the liability group for the capability. - `annualPercentageRate` Capability - `availability` 'NOT_SUPPORTED' | 'SUPPORTED' | 'FIELD_ERROR', required: The availability status of a capability - `fieldErrors` FieldError[]: Field-level errors if applicable. - … - `description` 'INSTITUTION_NOT_SUPPORTED' | 'INSTITUTION_DISABLED' | 'REFRESH_EXHAUSTED' | 'NOT_PRIMARY_ACCOUNT_HOLDER' | 'ACCOUNT_TERMINATED' | 'CLOSED_ACCOUNT_NO_BALANCE' | 'CLOSED_ACCOUNT' | 'ACCOUNT_NUMBER_VERIFICATION_FAILED': Description of why the capability is not supported, if applicable. - `nextEligibleRefreshOn` number: The earliest timestamp that the capability will be available, if applicable. - `liabilityGroupId` string: Unique identifier of the liability group for the capability. - `cardBrand` Capability - `availability` 'NOT_SUPPORTED' | 'SUPPORTED' | 'FIELD_ERROR', required: The availability status of a capability - `fieldErrors` FieldError[]: Field-level errors if applicable. - … - `description` 'INSTITUTION_NOT_SUPPORTED' | 'INSTITUTION_DISABLED' | 'REFRESH_EXHAUSTED' | 'NOT_PRIMARY_ACCOUNT_HOLDER' | 'ACCOUNT_TERMINATED' | 'CLOSED_ACCOUNT_NO_BALANCE' | 'CLOSED_ACCOUNT' | 'ACCOUNT_NUMBER_VERIFICATION_FAILED': Description of why the capability is not supported, if applicable. - `nextEligibleRefreshOn` number: The earliest timestamp that the capability will be available, if applicable. - `liabilityGroupId` string: Unique identifier of the liability group for the capability. - `studentLoans` StudentLoanResponse[] - `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 - `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 - `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 - `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 - `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 - `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 - `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 - `firstDelinquencyDateWithFormat` 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 - `lastActivityDateWithFormat` 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 - `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 - `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 - `mostRecentAdverseRating` '0' | '1' | '2' | '3' | '4' | '5' | '6' | 'G' | 'H' | 'J' | 'R' | 'L' | 'E' | 'B' | 'D': Most recent adverse rating - `mostRecentAdverseRatingDateWithFormat` 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 - `secondMostRecentAdverseRating` '0' | '1' | '2' | '3' | '4' | '5' | '6' | 'G' | 'H' | 'J' | 'R' | 'L' | 'E' | 'B' | 'D': Second most recent adverse rating - `secondMostRecentAdverseRatingDateWithFormat` 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 - `adverseRatingCount` number: Total count of adverse ratings - `liabilityTransfers` LiabilityTransfers - `transferredFrom` LiabilityTransfer - `creditorName` string, required: Creditor name - `transferredTo` LiabilityTransfer - `creditorName` string, required: Creditor name - `narratives` Narratives[]: Details about consumer account narratives - `code` string: Narrative's code - `description` string: Narrative's description - `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 - `lastAssessedStatementDate` string, date: Date of the last assessed statement - `details` PaymentHistoryDetails[] - `date` string, date: Date of billing period - `description` string: Description of the payment - `code` '0' | '1' | '2' | '3' | '4' | '5' | '6' | 'G' | 'H' | 'J' | 'R' | 'L' | 'E' | 'B' | 'D': Code representing the payment status - `balanceDetails` LiabilityBalanceDetails, required - `outstandingBalance` number: Current balance on the account - `updatedOn` number: Timestamp of the last update - `statementSummary` LiabilityStatementSummary, required - `statementDateWithFormat` 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 - `statementBalance` number: Total balance on the statement - `principalBalance` number: Principal balance on the loan - `minimumPaymentAmount` number: Minimum amount due for payment - `lastPaymentDateWithFormat` 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 - `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 - `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 - `reportedDate` string, date-time: Date when this address was reported - `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 - `addressType` 'PREVIOUS' | 'CURRENT': Type of address (current/previous) - `address` Address - `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 - `billingAddress` Address - `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 - `capabilities` CapabilityMatrix, required - `payments` PaymentsCapability - `billPayment` Capability, required - `availability` 'NOT_SUPPORTED' | 'SUPPORTED' | 'FIELD_ERROR', required: The availability status of a capability - `fieldErrors` FieldError[]: Field-level errors if applicable. - … - `description` 'INSTITUTION_NOT_SUPPORTED' | 'INSTITUTION_DISABLED' | 'REFRESH_EXHAUSTED' | 'NOT_PRIMARY_ACCOUNT_HOLDER' | 'ACCOUNT_TERMINATED' | 'CLOSED_ACCOUNT_NO_BALANCE' | 'CLOSED_ACCOUNT' | 'ACCOUNT_NUMBER_VERIFICATION_FAILED': Description of why the capability is not supported, if applicable. - `nextEligibleRefreshOn` number: The earliest timestamp that the capability will be available, if applicable. - `liabilityGroupId` string: Unique identifier of the liability group for the capability. - `pushToCard` Capability - `availability` 'NOT_SUPPORTED' | 'SUPPORTED' | 'FIELD_ERROR', required: The availability status of a capability - `fieldErrors` FieldError[]: Field-level errors if applicable. - … - `description` 'INSTITUTION_NOT_SUPPORTED' | 'INSTITUTION_DISABLED' | 'REFRESH_EXHAUSTED' | 'NOT_PRIMARY_ACCOUNT_HOLDER' | 'ACCOUNT_TERMINATED' | 'CLOSED_ACCOUNT_NO_BALANCE' | 'CLOSED_ACCOUNT' | 'ACCOUNT_NUMBER_VERIFICATION_FAILED': Description of why the capability is not supported, if applicable. - `nextEligibleRefreshOn` number: The earliest timestamp that the capability will be available, if applicable. - `liabilityGroupId` string: Unique identifier of the liability group for the capability. - `receiveOnlyPayment` Capability - `availability` 'NOT_SUPPORTED' | 'SUPPORTED' | 'FIELD_ERROR', required: The availability status of a capability - `fieldErrors` FieldError[]: Field-level errors if applicable. - … - `description` 'INSTITUTION_NOT_SUPPORTED' | 'INSTITUTION_DISABLED' | 'REFRESH_EXHAUSTED' | 'NOT_PRIMARY_ACCOUNT_HOLDER' | 'ACCOUNT_TERMINATED' | 'CLOSED_ACCOUNT_NO_BALANCE' | 'CLOSED_ACCOUNT' | 'ACCOUNT_NUMBER_VERIFICATION_FAILED': Description of why the capability is not supported, if applicable. - `nextEligibleRefreshOn` number: The earliest timestamp that the capability will be available, if applicable. - `liabilityGroupId` string: Unique identifier of the liability group for the capability. - `data` DataCapability - `realtimeBalance` Capability, required - `availability` 'NOT_SUPPORTED' | 'SUPPORTED' | 'FIELD_ERROR', required: The availability status of a capability - `fieldErrors` FieldError[]: Field-level errors if applicable. - … - `description` 'INSTITUTION_NOT_SUPPORTED' | 'INSTITUTION_DISABLED' | 'REFRESH_EXHAUSTED' | 'NOT_PRIMARY_ACCOUNT_HOLDER' | 'ACCOUNT_TERMINATED' | 'CLOSED_ACCOUNT_NO_BALANCE' | 'CLOSED_ACCOUNT' | 'ACCOUNT_NUMBER_VERIFICATION_FAILED': Description of why the capability is not supported, if applicable. - `nextEligibleRefreshOn` number: The earliest timestamp that the capability will be available, if applicable. - `liabilityGroupId` string: Unique identifier of the liability group for the capability. - `payoffSummary` Capability - `availability` 'NOT_SUPPORTED' | 'SUPPORTED' | 'FIELD_ERROR', required: The availability status of a capability - `fieldErrors` FieldError[]: Field-level errors if applicable. - … - `description` 'INSTITUTION_NOT_SUPPORTED' | 'INSTITUTION_DISABLED' | 'REFRESH_EXHAUSTED' | 'NOT_PRIMARY_ACCOUNT_HOLDER' | 'ACCOUNT_TERMINATED' | 'CLOSED_ACCOUNT_NO_BALANCE' | 'CLOSED_ACCOUNT' | 'ACCOUNT_NUMBER_VERIFICATION_FAILED': Description of why the capability is not supported, if applicable. - `nextEligibleRefreshOn` number: The earliest timestamp that the capability will be available, if applicable. - `liabilityGroupId` string: Unique identifier of the liability group for the capability. - `liabilityGroupPayoffQuote` Capability - `availability` 'NOT_SUPPORTED' | 'SUPPORTED' | 'FIELD_ERROR', required: The availability status of a capability - `fieldErrors` FieldError[]: Field-level errors if applicable. - … - `description` 'INSTITUTION_NOT_SUPPORTED' | 'INSTITUTION_DISABLED' | 'REFRESH_EXHAUSTED' | 'NOT_PRIMARY_ACCOUNT_HOLDER' | 'ACCOUNT_TERMINATED' | 'CLOSED_ACCOUNT_NO_BALANCE' | 'CLOSED_ACCOUNT' | 'ACCOUNT_NUMBER_VERIFICATION_FAILED': Description of why the capability is not supported, if applicable. - `nextEligibleRefreshOn` number: The earliest timestamp that the capability will be available, if applicable. - `liabilityGroupId` string: Unique identifier of the liability group for the capability. - `statementSummary` Capability - `availability` 'NOT_SUPPORTED' | 'SUPPORTED' | 'FIELD_ERROR', required: The availability status of a capability - `fieldErrors` FieldError[]: Field-level errors if applicable. - … - `description` 'INSTITUTION_NOT_SUPPORTED' | 'INSTITUTION_DISABLED' | 'REFRESH_EXHAUSTED' | 'NOT_PRIMARY_ACCOUNT_HOLDER' | 'ACCOUNT_TERMINATED' | 'CLOSED_ACCOUNT_NO_BALANCE' | 'CLOSED_ACCOUNT' | 'ACCOUNT_NUMBER_VERIFICATION_FAILED': Description of why the capability is not supported, if applicable. - `nextEligibleRefreshOn` number: The earliest timestamp that the capability will be available, if applicable. - `liabilityGroupId` string: Unique identifier of the liability group for the capability. - `annualPercentageRate` Capability - `availability` 'NOT_SUPPORTED' | 'SUPPORTED' | 'FIELD_ERROR', required: The availability status of a capability - `fieldErrors` FieldError[]: Field-level errors if applicable. - … - `description` 'INSTITUTION_NOT_SUPPORTED' | 'INSTITUTION_DISABLED' | 'REFRESH_EXHAUSTED' | 'NOT_PRIMARY_ACCOUNT_HOLDER' | 'ACCOUNT_TERMINATED' | 'CLOSED_ACCOUNT_NO_BALANCE' | 'CLOSED_ACCOUNT' | 'ACCOUNT_NUMBER_VERIFICATION_FAILED': Description of why the capability is not supported, if applicable. - `nextEligibleRefreshOn` number: The earliest timestamp that the capability will be available, if applicable. - `liabilityGroupId` string: Unique identifier of the liability group for the capability. - `cardBrand` Capability - `availability` 'NOT_SUPPORTED' | 'SUPPORTED' | 'FIELD_ERROR', required: The availability status of a capability - `fieldErrors` FieldError[]: Field-level errors if applicable. - … - `description` 'INSTITUTION_NOT_SUPPORTED' | 'INSTITUTION_DISABLED' | 'REFRESH_EXHAUSTED' | 'NOT_PRIMARY_ACCOUNT_HOLDER' | 'ACCOUNT_TERMINATED' | 'CLOSED_ACCOUNT_NO_BALANCE' | 'CLOSED_ACCOUNT' | 'ACCOUNT_NUMBER_VERIFICATION_FAILED': Description of why the capability is not supported, if applicable. - `nextEligibleRefreshOn` number: The earliest timestamp that the capability will be available, if applicable. - `liabilityGroupId` string: Unique identifier of the liability group for the capability. - `bankAccounts` BankAccountResponse[] - `logoUrl` string, required: Logo URL for the institution - `displayName` string: Name of the institution - `bankAccountId` string, required: Unique identifier for the bank account - `updatedOn` number: Timestamp of the last update - `accountProfile` union, required - BankAccountProfile - `accountNumberLastFourDigits` string, required: Last four digits of the bank account number - `accountType` 'CHECKING' | 'SAVINGS': Bank account type - `balanceDetails` BalanceDetails - `accountBalance` number, required: The balance as of the last update - `updatedOn` number, required: Timestamp of the last update - PayableBankAccountProfile - `firstName` string, required: Account holder first name - `lastName` string, required: Account holder last name - `email` string, required: Account holder email - `accountNumberLastFourDigits` string, required: Last four digits of the bank account number - `accountType` 'CHECKING' | 'SAVINGS', required: Bank account type - `createdOn` number: Timestamp of the creation - `capabilities` CapabilityMatrix, required - `payments` PaymentsCapability - `billPayment` Capability, required - `availability` 'NOT_SUPPORTED' | 'SUPPORTED' | 'FIELD_ERROR', required: The availability status of a capability - `fieldErrors` FieldError[]: Field-level errors if applicable. - … - `description` 'INSTITUTION_NOT_SUPPORTED' | 'INSTITUTION_DISABLED' | 'REFRESH_EXHAUSTED' | 'NOT_PRIMARY_ACCOUNT_HOLDER' | 'ACCOUNT_TERMINATED' | 'CLOSED_ACCOUNT_NO_BALANCE' | 'CLOSED_ACCOUNT' | 'ACCOUNT_NUMBER_VERIFICATION_FAILED': Description of why the capability is not supported, if applicable. - `nextEligibleRefreshOn` number: The earliest timestamp that the capability will be available, if applicable. - `liabilityGroupId` string: Unique identifier of the liability group for the capability. - `pushToCard` Capability - `availability` 'NOT_SUPPORTED' | 'SUPPORTED' | 'FIELD_ERROR', required: The availability status of a capability - `fieldErrors` FieldError[]: Field-level errors if applicable. - … - `description` 'INSTITUTION_NOT_SUPPORTED' | 'INSTITUTION_DISABLED' | 'REFRESH_EXHAUSTED' | 'NOT_PRIMARY_ACCOUNT_HOLDER' | 'ACCOUNT_TERMINATED' | 'CLOSED_ACCOUNT_NO_BALANCE' | 'CLOSED_ACCOUNT' | 'ACCOUNT_NUMBER_VERIFICATION_FAILED': Description of why the capability is not supported, if applicable. - `nextEligibleRefreshOn` number: The earliest timestamp that the capability will be available, if applicable. - `liabilityGroupId` string: Unique identifier of the liability group for the capability. - `receiveOnlyPayment` Capability - `availability` 'NOT_SUPPORTED' | 'SUPPORTED' | 'FIELD_ERROR', required: The availability status of a capability - `fieldErrors` FieldError[]: Field-level errors if applicable. - … - `description` 'INSTITUTION_NOT_SUPPORTED' | 'INSTITUTION_DISABLED' | 'REFRESH_EXHAUSTED' | 'NOT_PRIMARY_ACCOUNT_HOLDER' | 'ACCOUNT_TERMINATED' | 'CLOSED_ACCOUNT_NO_BALANCE' | 'CLOSED_ACCOUNT' | 'ACCOUNT_NUMBER_VERIFICATION_FAILED': Description of why the capability is not supported, if applicable. - `nextEligibleRefreshOn` number: The earliest timestamp that the capability will be available, if applicable. - `liabilityGroupId` string: Unique identifier of the liability group for the capability. - `data` DataCapability - `realtimeBalance` Capability, required - `availability` 'NOT_SUPPORTED' | 'SUPPORTED' | 'FIELD_ERROR', required: The availability status of a capability - `fieldErrors` FieldError[]: Field-level errors if applicable. - … - `description` 'INSTITUTION_NOT_SUPPORTED' | 'INSTITUTION_DISABLED' | 'REFRESH_EXHAUSTED' | 'NOT_PRIMARY_ACCOUNT_HOLDER' | 'ACCOUNT_TERMINATED' | 'CLOSED_ACCOUNT_NO_BALANCE' | 'CLOSED_ACCOUNT' | 'ACCOUNT_NUMBER_VERIFICATION_FAILED': Description of why the capability is not supported, if applicable. - `nextEligibleRefreshOn` number: The earliest timestamp that the capability will be available, if applicable. - `liabilityGroupId` string: Unique identifier of the liability group for the capability. - `payoffSummary` Capability - `availability` 'NOT_SUPPORTED' | 'SUPPORTED' | 'FIELD_ERROR', required: The availability status of a capability - `fieldErrors` FieldError[]: Field-level errors if applicable. - … - `description` 'INSTITUTION_NOT_SUPPORTED' | 'INSTITUTION_DISABLED' | 'REFRESH_EXHAUSTED' | 'NOT_PRIMARY_ACCOUNT_HOLDER' | 'ACCOUNT_TERMINATED' | 'CLOSED_ACCOUNT_NO_BALANCE' | 'CLOSED_ACCOUNT' | 'ACCOUNT_NUMBER_VERIFICATION_FAILED': Description of why the capability is not supported, if applicable. - `nextEligibleRefreshOn` number: The earliest timestamp that the capability will be available, if applicable. - `liabilityGroupId` string: Unique identifier of the liability group for the capability. - `liabilityGroupPayoffQuote` Capability - `availability` 'NOT_SUPPORTED' | 'SUPPORTED' | 'FIELD_ERROR', required: The availability status of a capability - `fieldErrors` FieldError[]: Field-level errors if applicable. - … - `description` 'INSTITUTION_NOT_SUPPORTED' | 'INSTITUTION_DISABLED' | 'REFRESH_EXHAUSTED' | 'NOT_PRIMARY_ACCOUNT_HOLDER' | 'ACCOUNT_TERMINATED' | 'CLOSED_ACCOUNT_NO_BALANCE' | 'CLOSED_ACCOUNT' | 'ACCOUNT_NUMBER_VERIFICATION_FAILED': Description of why the capability is not supported, if applicable. - `nextEligibleRefreshOn` number: The earliest timestamp that the capability will be available, if applicable. - `liabilityGroupId` string: Unique identifier of the liability group for the capability. - `statementSummary` Capability - `availability` 'NOT_SUPPORTED' | 'SUPPORTED' | 'FIELD_ERROR', required: The availability status of a capability - `fieldErrors` FieldError[]: Field-level errors if applicable. - … - `description` 'INSTITUTION_NOT_SUPPORTED' | 'INSTITUTION_DISABLED' | 'REFRESH_EXHAUSTED' | 'NOT_PRIMARY_ACCOUNT_HOLDER' | 'ACCOUNT_TERMINATED' | 'CLOSED_ACCOUNT_NO_BALANCE' | 'CLOSED_ACCOUNT' | 'ACCOUNT_NUMBER_VERIFICATION_FAILED': Description of why the capability is not supported, if applicable. - `nextEligibleRefreshOn` number: The earliest timestamp that the capability will be available, if applicable. - `liabilityGroupId` string: Unique identifier of the liability group for the capability. - `annualPercentageRate` Capability - `availability` 'NOT_SUPPORTED' | 'SUPPORTED' | 'FIELD_ERROR', required: The availability status of a capability - `fieldErrors` FieldError[]: Field-level errors if applicable. - … - `description` 'INSTITUTION_NOT_SUPPORTED' | 'INSTITUTION_DISABLED' | 'REFRESH_EXHAUSTED' | 'NOT_PRIMARY_ACCOUNT_HOLDER' | 'ACCOUNT_TERMINATED' | 'CLOSED_ACCOUNT_NO_BALANCE' | 'CLOSED_ACCOUNT' | 'ACCOUNT_NUMBER_VERIFICATION_FAILED': Description of why the capability is not supported, if applicable. - `nextEligibleRefreshOn` number: The earliest timestamp that the capability will be available, if applicable. - `liabilityGroupId` string: Unique identifier of the liability group for the capability. - `cardBrand` Capability - `availability` 'NOT_SUPPORTED' | 'SUPPORTED' | 'FIELD_ERROR', required: The availability status of a capability - `fieldErrors` FieldError[]: Field-level errors if applicable. - … - `description` 'INSTITUTION_NOT_SUPPORTED' | 'INSTITUTION_DISABLED' | 'REFRESH_EXHAUSTED' | 'NOT_PRIMARY_ACCOUNT_HOLDER' | 'ACCOUNT_TERMINATED' | 'CLOSED_ACCOUNT_NO_BALANCE' | 'CLOSED_ACCOUNT' | 'ACCOUNT_NUMBER_VERIFICATION_FAILED': Description of why the capability is not supported, if applicable. - `nextEligibleRefreshOn` number: The earliest timestamp that the capability will be available, if applicable. - `liabilityGroupId` string: Unique identifier of the liability group for the capability. - `updatedOn` number, required - `createdOn` number, required ## Other responses - `206`: This occurs when there is a risk factor detected for a user. Some reasons can pertain to soft or hard locks on the user's credit file, or fraud risk related reasons. - `400`: Bad request response - `401`: Unauthorized response - `404`: Not found response - `500`: Internal server error response --- [API](https://skmtc.dev/spinwheel/apis/optimize.md) - [All operations](https://skmtc.dev/spinwheel/apis/optimize/llms.txt) - [OpenAPI document](https://skmtc.dev/spinwheel/apis/optimize/revisions/6222309663d2?raw)