v1.0.1, we're introducing automated student loan aggregation and data syncing. By using Nexus to walk your borrowers through linking their Servicers, we collect, process, normalize, and return the most accurate student loan portfolio data on the market for you to embed into your own products.
Check out our new Portfolio API endpoint
v1.0.1is the latest update, and officially releases our new Student Loan Aggregation functionality.
When you wish to fetch your borrowers'
Loan objects, you'll use our Portfolio API endpoint.
The response is a simple object with a
loans key, which provides an array of
When your borrowers link their servicers with Nexus, Payitoff retrieves and processes their loan history and details from each linked Servicer. We also will keep this data synced over time so you can re-fetch Portfolio details from our API and be sure you are always receiving accurate, up-to-date information at all times.
Portfolios require using Nexus in your products
If you'd like to use Aggregated Portfolios in your products and workflows, check out our One-day Integration Guide to get started.
Portfolio aggregation relies on your borrowers linking their Servicers so we can collect, process, normalize, and return accurate and always up-to-date data via the Portfolio API endpoint.
UUIDidentifiers are taking the place of
If you've been using the Payitoff API, you may be used to calling API endpoints with
Borrower.idparameters as unique identifiers where necessary. Some time ago, we quietly began moving toward
Borrower.uuididentifiers by including
Borrowerresponses, and accepting
uuidvalues wherever an endpoint previously expected an
Because this is a patch version upgrade, your existing code for
Loanobjects from API
v1should continue to work uninterrupted. Only the newly introduced API endpoints will be enforcing the
uuid-only approach—this includes the Portfolio API.
Just a heads up that we will continue moving in this direction in subsequent updates, eventually phasing out
idvalues entirely in favor of
uuidvalues for all API objects.
Updated almost 3 years ago