An endpoint for searching PSLF-qualifying employers by name (or part of a name).
There are currently four types of qualifying employers: Low Income Schools,
Public Schools, Non Profits, and Government Agencies. This endpoint will return
matching results from all four types. These are distinguished by inspecting the type property in the results (see example).
Search terms must be URL-encoded strings, and are passed in to a query parameter named q.
Terms are case-insensitive and will match at the beginning of the employer's name.
For example, "fed" will return "Federal Bureau of Investigation" but not "Dwarfed Foundation."
You may optionally pass in a state query parameter to restrict results only to a
specific 2-letter US state code. So if your Borrower lives in Texas, passing in state=TX
will filter out results from other states and reduce the noise shown to your user.
You may optionally pass in a limit query parameter to limit the number of results for
each type. For example, a limit of 10 will return at most 40 results:
10 each for Low Income Schools, Public Schools, Non Profits, and Government Agencies.
The limit value may not be more than 100, which would return at most 400 results.
Click Try It! to start a request and see the response here!