Alright, getting to the meat and potatoes - let’s talk APIs.
Your primary source of truth will always be the v1/users endpoint. From here you can check on all of the data of the user from a top level summary all the way down to an individual loan. You can also quickly check the auth status, the data sync status, whether or not the account is paid off or migrated, and every other piece of data you need.
There are multiple endpoints attributed to the v1/users API that allow you to check specific things on the user like billingDetails, applied transactions, PSLF (public service loan forgiveness) progress, and the ability to disconnect the user.
There are a few user “Summaries” you want to pay attention to on the v1/users response. Generally speaking, we believe that the data is most rich at the lowest level (which is the studentLoanAccounts.loanAccounts.loans), so we will start from a bottom up review (as should you):
|studentLoanAccounts.loanAccounts.summary||Provides a summary level view across all loan accounts within a given student loan servicer that a user has connected. Here you get to see each loanAccount within a given Servicer (the student loan servicer or lender). This will always be your most accurate summary data based directly on the loans underneath. This is a great place to see a blended interest rate across the loans within this loanAccount.|
|studentLoanAccounts.summary||This is the next highest level summary data, which gives you a peek in at the Servicer by servicer level (or “connection”) level. Ie. if there is a Mohela account holder, you will get a summary of all of the Mohela loans here. This is a great place to see a blended interest rate on a per Servicer basis.|
|studentLoanAccountSummary||This is the highest level summary you can have on a user giving you top down insight and data. This is a great place to see a total blended interest rate inclusive of all servicers the user is connected to.|
The most accurate information and most insightful data will always come at the loan level (studentLoanAccounts.loanAccounts.loans). To note, not every servicer provides the same information back, and therefore there may be some variation in the response model at this level. Some common key attributes are below:
|loanType||The type of student loan as reported directly from the Servicer|
|loanTypeDerived||The type of student loan as derived based on what was returned from the Servicer|
|status||The status of the student loan repayment as reported directly from the Servicer|
|statusDerived||The status of student loan repayment as derived based on what was returned from the Servicer|
|repaymentPlan||The repayment plan of the student loan as reported directly from the Servicer|
|repaymentPlanDerived||The repayment plan of student loan as derived based on what was returned from the Servicer|
|outstandingBalance||The amount of principal balance plus any outstanding interest either reported directly from the Servicer or calculated by Spinwheel|
|interestRate||The interest rate on the loan as reported by the Servicer|
|principalBalance||The balance of total principal amount left on the loan as reported by the Servicer|
|outstandingInterest||The amount of total unpaid interest left on the loan as reported by the Servicer|
|regularMonthlyPayment||The monthly payment expected by the Servicer on the user's loan as reported by the Servicer|
|minimumPaymentAmount||The smallest payment amount that must be made against the outstanding balance for the month by the user, as reported by the Servicer|
To learn more about our debt APIs and 1-click solutions, visit spinwheel.io.
Updated about 2 months ago