{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"d4742d9c-b389-4bde-b6ab-4c22678265dd","name":"Sparrow Prequalification API Documentation","description":"## Introduction\n\nSparrow's Pre-Qual product allows you to pre-approve (or \"pre-qualify\") users for Private Student Loans (PSL) and Student Loan Refinancing (SLR) from Sparrow's network of partnered lenders (\"lenders\").\n\nPre-Qual determines a borrower's eligibility for a lenders' loan product and (if eligible) personalizes the pricing of the loan product for the borrower. Pre-Qual accepts individual and cosigned applications.\n\n## Overview\n\nPre-Qual endpoints include:\n\nPOST /qualify - Accepts a pre-qualification request and returns a unique requestId to retrieve pre-approved loan offers.\n\nGET /{{requestId}}/offers - Returns real-time pre-qualified loan offers.\n\nPOST /explore - Returns back up to date url for offer when a borrower wants to explore. This indicates all tokens and links are refreshed.\n\nGET /schools - Returns all schools, colleges, and universities supported by Sparrow.\n\nGET /disclosures - Returns all disclosures by lender (for in school or refi).\n\nGET /lenders - Returns all lenders, their logo, and whether they are supported for Prequalification and Non-Prequalification (that is they can be shown if the borrower doesn't prequalify with any of our lenders) for both PSL and SLR.\n\nGET /{{requestId}}/lender-reported-data - Returns the most recent data that has been reported by our lenders for a specific request.\n\nGET /lender-reported-data - Returns the most recent data that has been reported by our lenders for all requests for the partner.\n\nGET /schools/opeids - Returns all schools, opeids, colleges, and universities supported by Sparrow.\n\nPOST /access-token - Accepts an email, and returns back an access token (which is needed in order to prefill information for a user)  \nPOST /prefill - Creates a request for a user on Sparrow's side, so that when the user logs in they can see the request with the information already prepopulated in their dashboard\n\n[https://api.sparrowtest.com/pq/api/v1](https://api.sparrowtest.com/pq/api/v1) is the base URL for testing Pre-Qual endpoints. All API requests must be made over HTTPS. Calls made over HTTP will fail.\n\nUsing development URLs does not affect live data, interact with Production networks, or pull real credit.\n\nPre-Qual uses API keys to authenticate requests. A password is not required. In order to begin initial testing, request a unique API Key from your Sparrow Client Success representative.\n\nOnce your testing is finalized, Sparrow will test your JSON to ensure the API was implemented properly. Upon completion, your development API Key will be approved for production use.\n\nThe base URL to be used for production is [https://api.sparrowfi.com/pq/api/v1](https://www.api.sparrowfi.com/pq/api/v1)\n\n## Testing\n\nThe body of the /qualify request will work as a way to test receiving offers. To test receiving no offers, please use an ssn of 100000001.\n\n## Errors\n\nPre-Qual uses standard HTTP response codes to indicate the success or failure of an API request. Response codes in the 200 range indicate success and codes in the 400 range indicate a failure in the request. (e.g., the API key provided was not valid, etc.)\n\n200: Success - The request works as expected.\n\n400: Failure - The request failed, likely due to missing or poorly formatted required parameter.\n\nAll integers are required to be larger than -2000000000 and less than 2000000000 (as no values would reasonably be of these sizes and allowing for this makes handling more difficult since we treat all values as integers).\n\nRelated to this, dates cannot be earlier than Thursday, August 16, 1906 8:26:40 PM GMT and cannot be later than Wednesday, May 18, 2033 3:33:20 AM.\n\nAnother related issue could be a missing content type header, if you run into this issue, please add the header below to your list of headers:  \n\"Content-Type\": \"application/json\"\n\n401: Unauthorized - The API key / UUID used is invalid.\n\n404: Not Found - The requested resource does not exist.\n\n## Confidentiality Notice\n\nThis documentation is confidential and contains proprietary information and intellectual property of Sparrow. Neither this document nor any of the information contained herein may be reproduced or disclosed under any circumstances without the express written permission of Sparrow. Please be aware that disclosure, copying, distribution or use of this document and the information contained therein is strictly prohibited.\n\n## **Webhooks**\n\nFor enabling webhooks, please see the documentation below for the webhooks endpoint. Please note, that you will need to provide us your webhook url, alongside the API Key you want us to send with. If you would prefer a different authentiation mechanism (or don't want any authentication at all), please let us know, and we can discuss this accordingly.","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"15503540","team":1997068,"collectionId":"d4742d9c-b389-4bde-b6ab-4c22678265dd","publishedId":"UyrDDbCj","public":true,"publicUrl":"https://documentation.sparrowfi.com","privateUrl":"https://go.postman.co/documentation/15503540-d4742d9c-b389-4bde-b6ab-4c22678265dd","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"documentationLayout":"classic-double-column","customisation":null,"version":"8.10.1","publishDate":"2022-04-27T01:56:48.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{},"logos":{}},"statusCode":200},"environments":[],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/bf38758254f68455a24be0693a74e7b6d56e983fe489c60d88ac7a1b5d884d81","favicon":"https://sparrowfi.com/favicon.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"}],"canonicalUrl":"https://documentation.sparrowfi.com/view/metadata/UyrDDbCj"}