HomeGuidesAPI Reference


A `PortfolioLoan` is a rich object that describes a borrower's student loan portfolio in more accurate detail than ever. For `v1.0.1`, we're releasing an early preview of loan aggregation data, and we will continue to enrich the `PortfolioLoan` data in upcoming releases.

### Schema Definition

PropertyTypeFormatDescription
`account_number``string`
The borrower's account number for a `PortfolioLoan`, if known.
`created_at``string``date-time`A `DateTime` string indicating when this `Loan` was created.
`disbursement_dates``array``type: string` `format: date`An array of dates on which funds were disbursed to a `Borrower`.
`interest_rate``object`[`InterestRate`](🔗)An object that describes a loan's interest rate.
`monthly_payment``object`[`MonthlyPayment`](🔗)An object describing all known details about a loan's monthly payment.
`origination``object`[`Origination`](🔗)An object that describes the details of a loan's origination.
`outstanding_interest``string``decimal`Total unpaid interest. **NOTE:** As of `v1.0.1`, all `float` values are returned as decimal strings with 2-digit precision.
`outstanding_principal``string``decimal`Total unpaid principal. **NOTE:** As of `v1.0.1`, all `float` values are returned as decimal strings with 2-digit precision.
`repayment_plan``object`[`PortfolioRepaymentPlan`](🔗)An object describing the loan's Repayment Plan.
`servicer``object`[`Servicer`](🔗)An object describing the financial institution that services the loan, to whom a `Borrower` makes monthly payments.
`status``object`[`LoanStatus`](🔗)An object describing a loan's official status.
`type``object`[`LoanType`](🔗)An object describing a loan's official type.
`updated_at``string``date-time`A `DateTime` string indicating when this `PortfolioLoan` was last updated.
`uuid``string``uuid`A unique UUID identifier for this `PortfolioLoan`.

### Example