{"info":{"_postman_id":"d4742d9c-b389-4bde-b6ab-4c22678265dd","name":"Sparrow Prequalification API Documentation","description":"<html><head></head><body><h2 id=\"introduction\">Introduction</h2>\n<p>Sparrow'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\").</p>\n<p>Pre-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.</p>\n<h2 id=\"overview\">Overview</h2>\n<p>Pre-Qual endpoints include:</p>\n<p>POST /qualify - Accepts a pre-qualification request and returns a unique requestId to retrieve pre-approved loan offers.</p>\n<p>GET /{{requestId}}/offers - Returns real-time pre-qualified loan offers.</p>\n<p>POST /explore - Returns back up to date url for offer when a borrower wants to explore. This indicates all tokens and links are refreshed.</p>\n<p>GET /schools - Returns all schools, colleges, and universities supported by Sparrow.</p>\n<p>GET /disclosures - Returns all disclosures by lender (for in school or refi).</p>\n<p>GET /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.</p>\n<p>GET /{{requestId}}/lender-reported-data - Returns the most recent data that has been reported by our lenders for a specific request.</p>\n<p>GET /lender-reported-data - Returns the most recent data that has been reported by our lenders for all requests for the partner.</p>\n<p>GET /schools/opeids - Returns all schools, opeids, colleges, and universities supported by Sparrow.</p>\n<p>POST /access-token - Accepts an email, and returns back an access token (which is needed in order to prefill information for a user)<br>POST /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</p>\n<p><a href=\"https://api.sparrowtest.com/pq/api/v1\">https://api.sparrowtest.com/pq/api/v1</a> is the base URL for testing Pre-Qual endpoints. All API requests must be made over HTTPS. Calls made over HTTP will fail.</p>\n<p>Using development URLs does not affect live data, interact with Production networks, or pull real credit.</p>\n<p>Pre-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.</p>\n<p>Once 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.</p>\n<p>The base URL to be used for production is <a href=\"https://www.api.sparrowfi.com/pq/api/v1\">https://api.sparrowfi.com/pq/api/v1</a></p>\n<h2 id=\"testing\">Testing</h2>\n<p>The 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.</p>\n<h2 id=\"errors\">Errors</h2>\n<p>Pre-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.)</p>\n<p>200: Success - The request works as expected.</p>\n<p>400: Failure - The request failed, likely due to missing or poorly formatted required parameter.</p>\n<p>All 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).</p>\n<p>Related 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.</p>\n<p>Another 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:<br>\"Content-Type\": \"application/json\"</p>\n<p>401: Unauthorized - The API key / UUID used is invalid.</p>\n<p>404: Not Found - The requested resource does not exist.</p>\n<h2 id=\"confidentiality-notice\">Confidentiality Notice</h2>\n<p>This 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.</p>\n<h2 id=\"webhooks\"><strong>Webhooks</strong></h2>\n<p>For 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.</p>\n</body></html>","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"15503540","collectionId":"d4742d9c-b389-4bde-b6ab-4c22678265dd","publishedId":"UyrDDbCj","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2022-04-27T01:56:48.000Z"},"item":[{"name":"Qualify","id":"7ffc29d2-df8a-47ac-8e5c-f2c7fa6feab9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"<value>"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n    \"firstName\": \"Test\",\n    \"lastName\": \"User\",\n    \"loanAmount\": 1000000,\n    \"email\": \"testuser@gmail.com\",\n    \"phoneNumber\": \"+13104567890\",\n    \"permanentAddress\": {\n        \"addressLine1\": \"33 Irving Pl\",\n        \"city\": \"New York\",\n        \"state\": \"NY\",\n        \"zip\": \"10003\",\n        \"countryCode\": \"US\"\n    },\n    \"dob\": \"1970-01-01\",\n    \"citizenshipStatus\": {\n        \"type\": \"US Citizen or National\"\n    },\n    \"income\": {\n        \"amount\": 1000000000,\n        \"type\": \"Employed - Full Time\",\n        \"sourceChanged\": true\n    },\n    \"enrollment\": \"Full-Time Student\",\n    \"housing\": {\n        \"payment\": 1000,\n        \"type\": \"Rent\"\n    },\n    \"degrees\": [\n        {\n            \"university\": \"Duke University\",\n            \"gradDate\": \"2022-12-21\",\n            \"degreeType\": \"Bachelor of Arts (B.A.)\",\n            \"major\": \"Accounting\",\n            \"gpa\": \"3.50\"\n        }\n    ],\n    \"type\": \"SLR\",\n    \"additionalIncome\": {\n        \"amount\": 0,\n        \"frequency\": \"Annually\"\n    },\n    \"ssn\": \"100000000\",\n    \"cosigner\": {\n        \"firstName\": \"string\",\n        \"lastName\": \"string\",\n        \"email\": \"cosigner@email.com\",\n        \"dob\": \"1970-01-01\",\n        \"citizenshipStatus\": {\n            \"type\": \"US Citizen or National\"\n        },\n        \"permanentAddress\": {\n            \"addressLine1\": \"33 Irving Pl\",\n            \"city\": \"New York\",\n            \"state\": \"NY\",\n            \"zip\": \"10003\",\n            \"countryCode\": \"US\"\n        },\n        \"income\": 100000000,\n        \"additionalIncome\": 0,\n        \"employment\": \"Employed - Full Time\",\n        \"housingPayment\": 0,\n        \"ssn\": \"100000000\",\n        \"estimatedFicoScore\": 825\n    },\n    \"estimatedFicoScore\": 750,\n    \"subIds\": {\n        \"subId\": \"value\"\n    }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.sparrowtest.com/pq/api/v1/qualify","description":"<h1 id=\"fields\">Fields:</h1>\n<h2 id=\"note\"><strong>Note:</strong></h2>\n<h4 id=\"amounts\">Amounts</h4>\n<p>All amounts representing money should be the value in cents.</p>\n<p>EX: an income with value 100000 would be interpretted as an income of $1,000, not $100,000.</p>\n<h2 id=\"required\">Required:</h2>\n<p>The following fields are required by the API:</p>\n<ol>\n<li><p>type</p>\n</li>\n<li><p>firstName</p>\n</li>\n<li><p>lastName</p>\n</li>\n<li><p>email</p>\n</li>\n<li><p>loanAmount</p>\n</li>\n<li><p>dob</p>\n</li>\n<li><p>housing</p>\n</li>\n<li><p>degrees</p>\n</li>\n<li><p>citizenshipStatus</p>\n</li>\n<li><p>permanentAddress</p>\n</li>\n<li><p>income</p>\n</li>\n</ol>\n<h2 id=\"optional\"><strong>Optional:</strong></h2>\n<p>The following fields are optional for the API:</p>\n<ol>\n<li><p>phoneNumber</p>\n</li>\n<li><p>subIds</p>\n</li>\n<li><p>enrollment</p>\n</li>\n<li><p>ssn</p>\n</li>\n<li><p>cosigner</p>\n</li>\n<li><p>mailingAddress</p>\n</li>\n<li><p>additionalIncome</p>\n</li>\n<li><p>estimatedFicoScore</p>\n</li>\n</ol>\n<h4 id=\"additional-income\">Additional Income</h4>\n<p>The frequency field can take on of the following values:</p>\n<ol>\n<li><p>Annually</p>\n</li>\n<li><p>Monthly</p>\n</li>\n</ol>\n<h4 id=\"citizenship-status\">Citizenship Status</h4>\n<p>The type for citizenshipStatus can be one of the following:</p>\n<ol>\n<li><p>US Citizen or National</p>\n</li>\n<li><p>Permanent Resident</p>\n</li>\n<li><p>Non-Permanent Resident</p>\n</li>\n<li><p>Visa Holder</p>\n</li>\n<li><p>DACA Recipient</p>\n</li>\n<li><p>International Citizen</p>\n</li>\n</ol>\n<h4 id=\"cosigner\">Cosigner:</h4>\n<h5 id=\"required-1\">Required:</h5>\n<p>If a cosigner is included, the following are required fields:</p>\n<ol>\n<li><p>firstName</p>\n</li>\n<li><p>lastName</p>\n</li>\n<li><p>email</p>\n</li>\n<li><p>dob</p>\n</li>\n<li><p>employment</p>\n</li>\n<li><p>ssn</p>\n</li>\n<li><p>citizenshipStatus</p>\n</li>\n<li><p>permanentAddress</p>\n</li>\n<li><p>income</p>\n</li>\n<li><p>housingPayment</p>\n</li>\n</ol>\n<h5 id=\"optional-1\">Optional:</h5>\n<p>If a cosigner is included, the following are optional fields:</p>\n<ol>\n<li><p>phoneNumber</p>\n</li>\n<li><p>mailingAddress</p>\n</li>\n<li><p>additionalIncome</p>\n</li>\n<li><p>estimatedFicoScore</p>\n</li>\n</ol>\n<h4 id=\"dates\">Dates</h4>\n<p>All dates should be in the format YYYY-MM-DD</p>\n<h4 id=\"degrees\">Degrees</h4>\n<p>The expected major, degreeType, and university values can all be obtained by calling the schools request above.<br />Gpa should be a string.</p>\n<h4 id=\"enrollment-options\"><strong>Enrollment Options</strong></h4>\n<ol>\n<li><p>Full-Time Student</p>\n</li>\n<li><p>More than half-time</p>\n</li>\n<li><p>Less than half-time</p>\n</li>\n<li><p>Not currently enrolled</p>\n</li>\n</ol>\n<h4 id=\"housing\">Housing</h4>\n<p>The type field can take on of the following values:</p>\n<ol>\n<li><p>Rent</p>\n</li>\n<li><p>Own with mortgage</p>\n</li>\n<li><p>Own without mortgage</p>\n</li>\n<li><p>Live with family or friends</p>\n</li>\n<li><p>Other</p>\n</li>\n</ol>\n<h4 id=\"income-and-cosigner-employment\">Income and Cosigner Employment</h4>\n<p>The type field of the income object and the employment field of the cosigner can take on one of the following values:</p>\n<ol>\n<li><p>Employed - Full Time</p>\n</li>\n<li><p>Employed - Part Time</p>\n</li>\n<li><p>Employed - Military</p>\n</li>\n<li><p>Self Employed</p>\n</li>\n<li><p>Future Employed</p>\n</li>\n<li><p>Retired</p>\n</li>\n<li><p>Unemployed</p>\n</li>\n</ol>\n<h4 id=\"permanent-address\">Permanent Address</h4>\n<p>Country code must be formatted in the ISO 3166-1 alpha-2 code (that is it must be the standard two letter format).</p>\n<p>If in the US, the state must follow the format of the standard two letter state abbreviation.</p>\n<p>If in the US, zip should be five characters long.</p>\n<h4 id=\"type\"><strong>Type</strong></h4>\n<p>The type field can take on one of the following values:</p>\n<ol>\n<li><p>PSL</p>\n</li>\n<li><p>SLR</p>\n</li>\n</ol>\n<p>PSL (private student loan) represents an in school loan, and SLR (student loan refinance) represents a refinancing loan.</p>\n","urlObject":{"protocol":"https","path":["pq","api","v1","qualify"],"host":["api","sparrowtest","com"],"query":[],"variable":[]}},"response":[{"id":"f1f814fb-92ce-4b8f-a0ae-b6b49d286ad7","name":"Success Request","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n    \"firstName\": \"Test\",\n    \"lastName\": \"User\",\n    \"loanAmount\": 1000000,\n    \"email\": \"testuser@gmail.com\",\n    \"phoneNumber\": \"+13104567890\",\n    \"permanentAddress\": {\n        \"addressLine1\": \"33 Irving Pl\",\n        \"city\": \"New York\",\n        \"state\": \"NY\",\n        \"zip\": \"10003\",\n        \"countryCode\": \"US\"\n    },\n    \"dob\": \"1970-01-01\",\n    \"citizenshipStatus\": {\n        \"type\": \"US Citizen or National\"\n    },\n    \"income\": {\n        \"amount\": 1000000000,\n        \"type\": \"Employed - Full Time\",\n        \"sourceChanged\": true\n    },\n    \"enrollment\": \"Full-Time Student\",\n    \"housing\": {\n        \"payment\": 1000,\n        \"type\": \"Rent\"\n    },\n    \"degrees\": [\n        {\n            \"university\": \"Harvard University\",\n            \"gradDate\": \"2022-12-21\",\n            \"degreeType\": \"Bachelor of Arts (B.A.)\",\n            \"major\": \"Accounting\",\n            \"gpa\": \"3.50\"\n        }\n    ],\n    \"type\": \"PSL\",\n    \"additionalIncome\": {\n        \"amount\": 0,\n        \"frequency\": \"Annually\"\n    },\n    \"ssn\": \"100000000\",\n    \"subIds\": {\n        \"subId\": \"value\"\n    },\n    \"estimatedFicoScore\": 750\n}","options":{"raw":{"language":"json"}}},"url":"https://api.sparrowtest.com/pq/api/v1/qualify"},"code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n    \"url\": \"https://api.sparrowtest.com/pq/api/v1/da5f027c-37d5-4453-b354-f3e7f14cd884/offers\",\n    \"requestId\": \"da5f027c-37d5-4453-b354-f3e7f14cd884\"\n}"},{"id":"561d8085-cca3-4699-979d-ab89bdb07f82","name":"Failed Request","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n    \"firstName\": \"Test\",\n    \"lastName\": \"User\",\n    \"email\": \"testuser@gmail.com\",\n    \"phoneNumber\": \"+13104567890\",\n    \"permanentAddress\": {\n        \"addressLine1\": \"33 Irving Pl\",\n        \"city\": \"New York\",\n        \"state\": \"NY\",\n        \"zip\": \"10003\",\n        \"countryCode\": \"US\"\n    },\n    \"dob\": \"1970-01-01\",\n    \"citizenshipStatus\": {\n        \"type\": \"US Citizen or National\"\n    },\n    \"income\": {\n        \"amount\": 1000000000,\n        \"type\": \"Employed - Full Time\",\n        \"sourceChanged\": true\n    },\n    \"enrollment\": \"Full-Time Student\",\n    \"housing\": {\n        \"payment\": 1000,\n        \"type\": \"Rent\"\n    },\n    \"degrees\": [\n        {\n            \"university\": \"Harvard University\",\n            \"gradDate\": \"2022-12-21\",\n            \"degreeType\": \"Bachelor of Arts (B.A.)\",\n            \"major\": \"Accounting\",\n            \"gpa\": \"3.50\"\n        }\n    ],\n    \"type\": \"PSL\",\n    \"additionalIncome\": {\n        \"amount\": 0,\n        \"frequency\": \"Annually\"\n    },\n    \"ssn\": \"100000000\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.sparrowtest.com/pq/api/v1/qualify"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n    \"code\": 400,\n    \"description\": \"Bad request, missing or misformatted body\",\n    \"userDescription\": \"The body parameter loanAmount is missing or formatted incorrectly\"\n}"},{"id":"17c16811-f898-49be-b1df-57eb122d6d8c","name":"Success Request With Cosigner","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n    \"firstName\": \"Test\",\n    \"lastName\": \"User\",\n    \"loanAmount\": 1000000,\n    \"email\": \"testuser@gmail.com\",\n    \"phoneNumber\": \"+13104567890\",\n    \"permanentAddress\": {\n        \"addressLine1\": \"33 Irving Pl\",\n        \"city\": \"New York\",\n        \"state\": \"NY\",\n        \"zip\": \"10003\",\n        \"countryCode\": \"US\"\n    },\n    \"dob\": \"1970-01-01\",\n    \"citizenshipStatus\": {\n        \"type\": \"US Citizen or National\"\n    },\n    \"income\": {\n        \"amount\": 1000000000,\n        \"type\": \"Employed - Full Time\",\n        \"sourceChanged\": true\n    },\n    \"enrollment\": \"Full-Time Student\",\n    \"housing\": {\n        \"payment\": 1000,\n        \"type\": \"Rent\"\n    },\n    \"degrees\": [\n        {\n            \"university\": \"Harvard University\",\n            \"gradDate\": \"2022-12-21\",\n            \"degreeType\": \"Bachelor of Arts (B.A.)\",\n            \"major\": \"Accounting\",\n            \"gpa\": \"3.50\"\n        }\n    ],\n    \"type\": \"PSL\",\n    \"additionalIncome\": {\n        \"amount\": 0,\n        \"frequency\": \"Annually\"\n    },\n    \"ssn\": \"100000000\",\n    \"cosigner\": {\n        \"firstName\": \"string\",\n        \"lastName\": \"string\",\n        \"email\": \"cosigner@email.com\",\n        \"dob\": \"1970-01-01\",\n        \"citizenshipStatus\": {\n            \"type\": \"US Citizen or National\"\n        },\n        \"permanentAddress\": {\n            \"addressLine1\": \"33 Irving Pl\",\n            \"city\": \"New York\",\n            \"state\": \"NY\",\n            \"zip\": \"10003\",\n            \"countryCode\": \"US\"\n        },\n        \"income\": 100000000,\n        \"additionalIncome\": 0,\n        \"employment\": \"Employed - Full Time\",\n        \"housingPayment\": 0,\n        \"ssn\": \"100000000\",\n        \"estimatedFicoScore\": 825\n    },\n    \"estimatedFicoScore\": 750,\n    \"subIds\": {\n        \"subId\": \"value\"\n    }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.sparrowtest.com/pq/api/v1/qualify"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n    \"url\": \"https://api.sparrowtest.com/pq/api/v1/da5f027c-37d5-4453-b354-f3e7f14cd884/offers\",\n    \"requestId\": \"da5f027c-37d5-4453-b354-f3e7f14cd884\"\n}"}],"_postman_id":"7ffc29d2-df8a-47ac-8e5c-f2c7fa6feab9"},{"name":"Offers","id":"d68b3eba-e8c3-4be3-b1b5-61e3d975480d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":"<value>"}]},"isInherited":false},"method":"GET","header":[],"url":"https://api.sparrowtest.com/pq/api/v1/a69564ea-fb4f-4603-aed9-83fbd5f64eaa/offers","description":"<p>This endpoint is utilized to get the offers for the request. While we run our process, it will return a status of pending. As soon as we have generated offers, or found they are not eligible, it will return a status of either offers, or declined. In order to receive offers, this endpoint should be polled every 3 to 5 seconds (any faster and it may be rate limited).</p>\n<p>Notes:<br />The field applyWithoutCosigner indicates if the borrower received this offer despite the cosigner (IE adding the cosigner hurt them, and they would have received it if they had no cosigner and applied solo). In this case, borrowers should apply without the cosigner when they transition over with that offer.</p>\n","urlObject":{"protocol":"https","path":["pq","api","v1","a69564ea-fb4f-4603-aed9-83fbd5f64eaa","offers"],"host":["api","sparrowtest","com"],"query":[],"variable":[]}},"response":[{"id":"1b768e5d-4d80-4a5a-8f3f-e646a8005087","name":"Pending Response","originalRequest":{"method":"GET","header":[],"url":"https://api.sparrowtest.com/pq/api/v1/{requestId}/offers"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n    \"status\": \"pending\"\n}"},{"id":"3b59be60-16bb-4424-b311-5dcaae4911cc","name":"Offers Response","originalRequest":{"method":"GET","header":[],"url":"https://api.sparrowtest.com/pq/api/v1/{requestId}/offers"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n    \"status\": \"offers\",\n    \"offers\": [\n        {\n            \"id\": \"offerId\",\n            \"loanType\": \"fixed\",\n            \"lender\": \"Earnest\",\n            \"type\": \"SLR\",\n            \"term\": 10,\n            \"repaymentTerms\": 120,\n            \"amount\":  {\n                \"amount\": 30000,\n                \"display\": \"$300.00\",\n                \"currency\": \"USD\"\n            },\n            \"totalInterestExpense\":  {\n                \"amount\": 10000,\n                \"display\": \"$100.00\",\n                \"currency\": \"USD\"\n            },\n            \"averagePayment\": {\n                \"amount\": 15970,\n                \"display\": \"$159.70\",\n                \"currency\": \"USD\"\n            },\n            \"fixedAPR\": 7.45,\n            \"discount\": 0.25,\n            \"borrowerBenefits\": \"Benefits 1...2...3...\",\n            \"personalizedUrl\": \"https://www...\",\n            \"paymentPlan\": \"Immediate\",\n            \"imageUrl\": \"https://www...\",\n            \"cosignerRelease\": \"There's no option to add a co-signer, but refinancing removes the original co-signer\",\n            \"fees\": {\n                \"originationFee\": 0.00,\n                \"applicationFee\": 0.00,\n                \"prepaymentPenalty\": 0.00\n            }\n        },\n        {\n            \"id\": \"offerId2\",\n            \"loanType\": \"variable\",\n            \"lender\": \"Nelnet\",\n            \"type\": \"SLR\",\n            \"term\": 10,\n            \"repaymentTerms\": 120,\n            \"amount\": {\n                \"amount\": 30000,\n                \"display\": \"$300.00\",\n                \"currency\": \"USD\"\n            },\n            \"totalInterestExpense\": {\n                \"amount\": 10000,\n                \"display\": \"$100.00\",\n                \"currency\": \"USD\"\n            },\n            \"averagePayment\": {\n                \"amount\": 15970,\n                \"display\": \"$159.70\",\n                \"currency\": \"USD\"\n            },\n            \"startingAPR\": 7.45,\n            \"aprCap\": 23,\n            \"discount\": 0.25,\n            \"borrowerBenefits\": \"Benefits 1...2...3...\",\n            \"personalizedUrl\": \"https://www...\",\n            \"paymentPlan\": \"Immediate\",\n               \"imageUrl\": \"https://www...\",\n            \"cosignerRelease\": \"There's no option to add a co-signer, but refinancing removes the original co-signer\",\n            \"fees\": {\n                \"originationFee\": 0.00,\n                \"applicationFee\": 0.00,\n                \"prepaymentPenalty\": 0.00\n            }\n        }\n    ],\n    \"disclosures\": [\n        {\n            \"lenderName\": \"Earnest\",\n            \"disclosure\": \"disclosure string\"\n        },\n        {\n            \"lenderName\": \"Ascent\",\n            \"disclosure\": \"disclosure string\"\n        }\n    ]\n}"},{"id":"7ff8b414-a5c8-4b32-9a6d-56e6e2d9256a","name":"Declined Response","originalRequest":{"method":"GET","header":[],"url":"https://api.sparrowtest.com/pq/api/v1/{requestId}/offers"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n    \"status\": \"declined\",\n    \"offers\": [],\n    \"incomeBasedOffers\": [],\n   \n    \"disclosures\": [\n        {\n            \"lenderName\": \"Arkansas Student Loan Authority\",\n            \"disclosure\": \"<p>Loans are made available by the Arkansas Student Loan Authority (ASLA), a division of the Arkansas Development Finance Authority, which is an Arkansas state government agency.<br/><br/>Loan terms are subject to change. All loans are subject to approval based upon underwriting guidelines determined by ASLA and its advisors. Interest rates for approved loans will be based upon the borrower’s credit history as reported under the FICO credit scoring system. <br/><br/>Non-Arkansas residents must attend an eligible institution of higher education within the state of Arkansas to be eligible for an ASLA loan. Arkansas residents may attend an eligible institution of higher education within or outside of the state of Arkansas to be eligible for an ASLA loan. <br/><br/>For more information related to the Arkansas Student Loan Authority and its loan products, visit www.asla.info.</p>\"\n        },\n        {\n            \"lenderName\": \"Brazos\",\n            \"disclosure\": \"<p>It is recommended that you utilize scholarships, grants and other federal student loans, such as the Federal Direct Student Loans, available to you before you use a Brazos Student Loan.</p><p>By providing your email, you are consenting to receive periodic emails from Brazos regarding the Brazos Student Loan, as well as general student loan information, information on other Brazos loan products or services, and other information we believe you will find informative and helpful.</p><p>Rates and terms provided as a result of a soft credit check do not mean you have been approved for the Brazos Student Loan but will give you an indicator of if, and on what terms, you may qualify. In order to qualify and be approved for the loan, you must apply, have a hard credit pull performed, and provide all necessary documents and information. A hard credit inquiry may impact your credit score.</p><p>Credit Review and Approval. If you choose to apply for a Brazos Student Loan, Brazos Parent Loan, or Brazos Refinance Loan and continue your application past the pre-credit eligibility stage, we will request your full credit report from one or more consumer reporting agencies, which is considered a hard credit inquiry. Hard credit inquiries (or hard credit pulls) are required for Brazos to be able to issue you a Brazos loan. In addition to requiring your explicit permission, these credit pulls may impact your credit score. The initial credit review is based on review of all the information you and your cosigner (if applicable) provide during the application process and the information obtained from your credit report(s). If you pass the initial credit review, you will need to provide acceptable documentation such as your income verification before the final loan approval.</p><p>Brazos Education Lending Corporation (Brazos) is a part of a group of several non-affiliated nonprofit companies that are all managed by The Brazos Higher Education Service Corporation, Inc. and are commonly referred to as the Brazos Managed Companies. The first of the Brazos Managed Companies was organized in 1975 in Waco, Texas, as a secondary market for student loans. Since that time, the Brazos Managed Companies have, on a combined basis, served an estimated 2 million student borrowers and have helped fund an estimated $30 billion in student loans.</p>\"\n        },\n        {\n            \"lenderName\": \"College Ave\",\n            \"disclosure\": \"<p>College Ave Student Loans products are made available through Firstrust Bank, member FDIC, First Citizens Community Bank, member FDIC, or M.Y. Safra Bank, FSB, member FDIC. All loans are subject to individual approval and adherence to underwriting guidelines. Program restrictions, other terms, and conditions apply.</p><p>*The 0.25% auto-pay interest rate reduction applies as long as the borrower or cosigner, if applicable, enrolls in auto-pay and authorizes our loan servicer to automatically deduct your monthly payments from a valid bank account via Automated Clearing House (“ACH”). The rate reduction applies for as long as the monthly payment amount is successfully deducted from the designated bank account and is suspended during periods of forbearance and certain deferments. Variable rates may increase after consummation.</p><p>$5,000 is the minimum requirement to refinance. The maximum loan amount is $300,000 for those with medical, dental, pharmacy or veterinary doctorate degrees, and $150,000 for all other undergraduate or graduate degrees. Information advertised valid as of 08/25/2022. Variable interest rates may increase after consummation.</p><p>This informational repayment example uses typical loan terms for a refi borrower with a Full Principal & Interest Repayment and a 10-year repayment term, has a $40,000 loan and a 5.5% Annual Percentage Rate (“APR”): 120 monthly payments of $434.11 while in the repayment period, for a total amount of payments of $52,092.61. Loans will never have a full principal and interest monthly payment of less than $50. Your actual rates and repayment terms may vary.</p><p>Information advertised valid as of 09/08/2022. Variable interest rates may increase after consummation. Approved interest rate will depend on creditworthiness of the applicant(s), lowest advertised rates only available to the most creditworthy applicants and require selection of full principal and interest payments with the shortest available loan term.</p>\"\n        },\n        {\n            \"lenderName\": \"Earnest\",\n            \"disclosure\": \"<h3 style=\\\"text-decoration:underline;\\\">Auto Pay Discount Disclosure</h3><p>You can take advantage of the Auto Pay interest rate reduction by setting up and maintaining active and automatic ACH withdrawal of your loan payment. The interest rate reduction for Auto Pay will be available only while your loan is enrolled in Auto Pay. Interest rate incentives for utilizing Auto Pay may not be combined with certain private student loan repayment programs that also offer an interest rate reduction. For multi-party loans, only one party may enroll in Auto Pay.</p><h3 style=\\\"text-decoration:underline;\\\">Student Loan Refinancing Interest Rate Disclosure</h3><p>Actual rate and available repayment terms will vary based on your income. Fixed rates range from 3.99% APR to 8.74% APR (excludes 0.25% Auto Pay discount). Variable rates range from 2.74% APR to 8.24% APR (excludes 0.25% Auto Pay discount). Earnest variable interest rate student loan refinance loans are based on a publicly available index, the 30-day Average Secured Overnight Financing Rate (SOFR) published by the Federal Reserve Bank of New York. The variable rate is based on the rate published on the 25th day, or the next business day, of the preceding calendar month, rounded to the nearest hundredth of a percent. The rate will not increase more than once per month. The maximum rate for your loan is 8.95% if your loan term is 10 years or less. For loan terms of more than 10 years to 15 years, the interest rate will never exceed 9.95%. For loan terms over 15 years, the interest rate will never exceed 11.95%. Please note, we are not able to offer variable rate loans in AK, IL, MN, NH, OH, TN, and TX. Our lowest rates are only available for our most credit qualified borrowers and contain our .25% auto pay discount from a checking or savings account. Sparrow receives compensation from Earnest on a per-funded loan basis.</p><h3 style=\\\"text-decoration:underline;\\\">Student Loan Refinancing Loan Cost Examples</h3><p>These examples provide estimates based on payments beginning immediately upon loan disbursement. Variable APR: A $10,000 loan with a 20-year term (240 monthly payments of $72) and a 5.89% APR would result in a total estimated payment amount of $17,042.39. For a variable loan, after your starting rate is set, your rate will then vary with the market. Fixed APR: A $10,000 loan with a 20-year term (240 monthly payments of $72) and a 6.04% APR would result in a total estimated payment amount of $17,249.77. Your actual repayment terms may vary.Terms and Conditions apply. Visit https://www.earnest.com/terms-of-service, e-mail us at hello@earnest.com, or call 888-601-2801 for more information on our student loan refinance product.<br/><br/></p><p> Earnest Loans are made by Earnest Operations LLC or One American Bank, Member FDIC. Earnest Operations LLC, NMLS #1204917. 535 Mission St., Suite 1663, San Francisco, CA 94105. California Financing Law License 6054788. Visit Lending Licenses - Earnest for a full list of licensed states. For California residents (Student Loan Refinance Only): Loans will be arranged or made pursuant to a California Financing Law License. </p><p>One American Bank, 515 S. Minnesota Ave, Sioux Falls, SD 57104. Earnest loans are serviced by Earnest Operations LLC with support from Navient Solutions LLC (NMLS #212430). One American Bank and Earnest LLC and its subsidiaries are not sponsored by or agencies of the United States of America.</p><p> © 2021 Earnest LLC. All rights reserved.</p>\"\n        },\n        {\n            \"lenderName\": \"EDvestinU\",\n            \"disclosure\": \"<p>EDvestinU Refinance Loan Disclosure</p><p>APR or \\\"annual percentage rate\\\" is a calculation of what the loan will cost, taking into consideration interest, fees and length of loan. Accordingly, the APR is subject to increase or decrease due to factors such as changes in the interest rate of variable rate loans, changes in principal due to the capitalization of interest or presence of a cosigner.</p><p>Variable APR rates may increase or decrease depending on fluctuations in the One-Month CME Term SOFR Index. Monthly interest rate accrual is based on the published One-Month CME Term SOFR Index rate as of the second to last business day of the previous month plus your applicable margin. If the One-Month CME Term SOFR Index is negative, it will be deemed to be equal to zero.</p><p>Lowest rate requires application with a cosigner and 0.25 percentage point interest rate reduction for automatic debit. Once the repayment period commences, the borrower may enroll in automatic debit. The interest rate reduction for authorizing our servicer to automatically debit monthly payments from a savings or checking account will not reduce the monthly payment, but will reduce the monthly finance charge, resulting in a lower total cost of loan. APR’s provided include a 0.25 percent interest rate reduction for authorizing our loan servicer to automatically debit your payments each month from your bank account.</p><p>Loans are funded by the New Hampshire Higher Education Loan Corporation (NHHELCO) NMLS ID# 1527348 www.nmlsconsumeraccess.org. EDvestinU® is a trademark of NHHELCO.</p>\"\n        },\n        {\n            \"lenderName\": \"INvestEd Refi Loan\",\n            \"disclosure\": \"<h3>INvestEd Refinance Loan Disclosures</h3><p>Subject to credit approval, loans are made by INvestEd or Bank of Lake Mills. Bank of Lake Mills does not have an ownership interest in INvestEd. Bank of Lake Mills is Member FDIC.</p><p>Rates shown are expressed as an APR and are for eligible, creditworthy applicants, requires shortest length of repayment and our Automatic Payment discount of 0.25 percentage points. Annual percentage rates (APR) listed are based on borrowing $10,000 in a single disbursement. Automatic payments are not required.</p><p>Fixed rate will not change during the term.</p><p>Variable rate is subject to increase after consummation. The maximum variable interest rate is 18.00%. The variable interest rate that is charged to the borrower is reset quarterly, may increase or decrease, and is based on an Index and Margin. That means that your rate could move lower or higher than the rates on this form. The variable rate is based upon the average of the three-month forward term version of the 90-day Secured Overnight Financing Rate (SOFR) published by a source approved by the Alternative Reference Rate Committee (ARRC).</p>\"\n        },\n        {\n            \"lenderName\": \"ISL Education Lending\",\n            \"disclosure\": \"<p>Subject to credit approval. Loans are made by Iowa Student Loan Liquidity Corporation or Bank of Lake Mills. Bank of Lake Mills does not have an ownership interest in Iowa Student Loan Liquidity Corporation. Bank of Lake Mills is Member FDIC. Annual percentage rate (APR) shown is dependent on if you are viewing this page with or without the auto-debit discount applied. If viewing with auto-debit discount applied, the APR rate will range from 3.94% APR to 9.08% APR and assumes you are enrolled in and maintain auto-debit payments from the date of origination. Enrolling in auto-debit results in a 0.25% interest rate reduction. Without enrolling in auto-debit, the rate will range from 4.19% APR to 9.33% APR. Not all borrowers receive the lowest rate. If you are approved for a loan, the rate offered will depend on your credit profile, the term you select, your state of residence or your current lender and will be within the ranges shown above.</p>\"\n        },\n        {\n            \"lenderName\": \"LendKey\",\n            \"disclosure\": \"<h3>1 – Terms and Conditions Apply</h3><p>Loan products, terms, and benefits may be modified or discontinued by participating lenders at any time without notice. Rates displayed are reserved for the most creditworthy consumers who enroll to make automatic monthly payments. Your initial rate will be determined after a review of your application and credit profile.  Variable rates may increase after consummation. You must be either a U.S. citizen or Permanent Resident in an eligible state and from an eligible school, and meet the lender's credit and income requirements to qualify for a loan. Certain membership requirements (including the opening of a share account, a minimum share account deposit, and the payment of any applicable association fees in connection with membership) may apply in the event that an applicant wishes to apply with, and accept a loan offered from, a credit union lender. If you are not a member of the credit union lender, you may apply and become a member during the loan application process if you meet the lender's eligibility criteria. Applying with a creditworthy cosigner may result in a better chance of loan approval and/or lower interest rate. Loans for exam preparation classes, including, but not limited to, loans for LSAT, MCAT, GMAT, and GRE preparation, are not available via LendKey.com.</p><h3>2 – Cosigner Release</h3><p>Some lenders participating on LendKey.com may offer the benefit of cosigner release. Cosigner release is subject to lender approval. In order to qualify, the borrower, alone, must meet the following requirements: (1) Make the required number of consecutive, on-time full principal and interest payments as indicated in the borrower’s credit agreement during the repayment period (excluding interest-only payments) immediately prior to the request. Any period of forbearance will reset the repayment clock; (2) The account cannot be in delinquent status; (3) The borrower must provide proof of income indicating that he/she meets the income requirements and pass a credit review demonstrating that he/she has a satisfactory credit history and the ability to assume full responsibility of loan repayment; (4) No bankruptcies or foreclosures in the last sixty months; and (5) No loan defaults.</p><h3>3 – Autopay Rate Reduction</h3><p>Subject to floor rate and may require the automatic payments be made from a checking or savings account with the lender. The rate reduction will be removed and the rate will be increased by 0.25% upon any cancellation or failed collection attempt of the automatic payment and will be suspended during any period of deferment or forbearance. As a result, during the forbearance or suspension period, and/or if the automatic payment is canceled, any increase will take the form of higher payments.</p><h3> 4 – AutoPay Discount & Lowest Interest Rate</h3><p>Subject to floor rate and may require the automatic payments be made from a checking or savings account with the lender. The rate reduction will be removed and the rate will be increased by 0.25% upon any cancellation or failed collection attempt of the automatic payment and will be suspended during any period of deferment or forbearance. As a result, during the forbearance or suspension period, and/or if the automatic payment is canceled, any increase will take the form of higher payments. The lowest advertised APR is only available for loan terms of 10 years and is reserved for the highest qualified applicants, taking into consideration the applicant’s credit and other factors.</p>\"\n        },\n        {\n            \"lenderName\": \"MPOWER Financing\",\n            \"disclosure\": \"<a href=\\\"https://registration.mpowerfinancing.com/pdf/refi/Refi_Truth_In_Lending_Act_Application_Disclosures.pdf\\\" target=_blank>MPOWER Financing Refi Disclosure</a>\"\n        },\n        {\n            \"lenderName\": \"Nelnet Bank\",\n            \"disclosure\": \"<h3>Credit Score</h3><p>A soft credit pull—whether on Sparrow or on Nelnet Bank’s platform-- will not affect your credit score. If you continue with your application, Nelnet Bank will request your permission to obtain your full credit report from one or more consumer reporting agencies. This is a hard credit pull and may affect your credit score.</p><h3>Auto Debit (Auto Pay)</h3><p>Interest rate reduction of .25% for automatically withdrawn payments from any designated bank account (“auto debit discount”). Auto debit discount applies when full payments (including both principal and interest) are automatically drafted from a bank account. The auto debit discount will continue to apply during periods of approved forbearance or deferment if the auto debit discount was in effect at the time of receiving the forbearance or deferment. Auto debit discount will remain on the account unless (1) the automatic deduction of payments is canceled or (2) there are three consecutive automatic deductions returned for insufficient funds at any time during the term of the loan.</p><h3>Cosigner Release</h3><p>A request for the cosigner to be released can be made by either the borrower or cosigner when each of the following conditions has been met:</p><ul><li>The account must have been in full principal and interest repayment for at least 24 months.</li><li>Twenty-four consecutive, on-time principal and interest payments, or lump sum equivalent, must have been made.<br/>NOTE: A lump sum payment does not replace the requirement to have been in full principal and interest repayment for at least 24 months. Interest-only or fixed-pay payments while enrolled in school do not qualify towards the 24 consecutive on-time payments.</li><li>The loan must be current at the time of request.</li><li>The loan must not have been in deferment, hardship forbearance, or other alternative payment assistance plan within the past 24 months.</li><li>The loan must not have been permanently modified from its original terms in the credit agreement.</li><li>The primary borrower must be a U.S. citizen or have permanent residency in the United States.</li><li>The primary borrower must meet the age of majority requirement in their permanent state of residency.</li><li>Requirements are subject to change.</li></ul><p>If all of these conditions have been met, then an application for cosigner release may be submitted. The primary borrower is required to demonstrate they have the ability to assume sole responsibility for the loan(s) by providing proof of income, meeting debt-to-income requirements, and having a satisfactory credit history. (A credit report will be obtained during the review process).</p><p>If you have questions on cosigner release, or would like to apply, contact us via email or phone at <a href=\\\"mailto:Loans@NelnetBank.com\\\" style=\\\"color:green;\\\">Loans@NelnetBank.com</a> or 800.446.4190.</p><h3>Hardship Forbearance</h3><p>Hardship forbearance allows you to temporarily suspend payments on your loan(s) while you are experiencing financial hardship. It is offered in increments of two or three months, with a maximum of 12 months available, in aggregate, over the life of the loan. If your loan(s) are in good standing at the time of your request, you will be eligible for forbearance in increments of two monthly payments. If, at the time of your initial request, your loan(s) are considered past-due, you will be eligible for forbearance in increments of three monthly payments. Future increments of forbearance, up to a life-time maximum of 12 months, may be requested upon the completion of making a certain number of principal and interest payments. During the two- or three-month forbearance period, you will not be required to make payments; however, any unpaid interest will continue to accrue and will be capitalized (added) onto your principal balance at the end of the forbearance period. You may continue making payments in any amount without penalty during the forbearance period. Your loan repayment term will be extended by the number of months in the forbearance period.</p><h3>Loan Eligibility</h3><p><strong>Refinance Loan Eligibility:</strong>You must be a U.S. citizen or permanent resident alien with a valid U.S. Social Security number, and be the legal age to enter into binding contracts in your state/territory of residency, or be at least 17 years of age and apply with a cosigner who is at least the age of majority in their state/territory. Non-residents can apply with an eligible cosigner who is a U.S. citizen or permanent resident alien with a valid U.S. Social Security number. The student loans you refinance must be in their grace or repayment period, and you can no longer be enrolled in school on a half-time or more basis. You must have at least $5,000 in student loans to refinance. You, or your eligible cosigner, must have an annual income of at least $36,000. Approval subject to credit review. Other credit criteria may apply.</p><p><strong>Refinance Loan Limits:</strong></p><ul><li>Minimum loan amount: $5,000</li><li>Maximum student loan limits:<ul><li>$125,000 for borrowers with an undergraduate degree.</li><li>$175,000 for borrowers with a graduate or doctorate degree.</li><li>$175,000 for borrowers with an MBA or graduate law degree.</li><li>$500,000 for borrowers with a graduate health professions degree.</li></ul></li></ul><p>Loan Refinancing Risks: Federal student loans include benefits that may not be offered with private student loans. Carefully review any potential benefits that may be lost by refinancing federal and private education loans, such as the loss of any remaining grace periods. To learn more about what to take into consideration when refinancing federal student loans with private education loans, click <a href=\\\"https://www.nelnetbank.com/loan-refinancing-risks/\\\" target='_blank' rel=\\\"noreferrer\\\">here</a>.</p><h3>Interest Rates</h3><h4>Refinance Loan</h4><p>Fixed interest rates range from 4.49% APR (with auto debit discount) to 8.44% APR (without auto debit discount). Your interest rate will depend on your (and if applicable, your cosigner’s) credit qualifications. The fixed interest rate will remain the same for the life of the loan.</p><p>Variable interest rates range from 5.31% APR (with auto debit discount) to 11.97% APR (without auto debit discount). Your interest rate will depend on your (and if applicable, your cosigner’s) credit qualifications. Variable rates may increase after consummation. Variable rates for Nelnet Bank Refinance Loans are calculated as the One-Month SOFR plus the applicable Margin percentage. Variable rates will be based on the highest One-Month SOFR as published by the Federal Reserve Bank of New York and/or the Wall Street Journal “Money Rates” table on the twenty-fifth day (or the next business day) of the immediately preceding calendar month. The variable rate may change on the first day of each month if the SOFR index changes. This may result in higher monthly payments. The current One-Month SOFR index is 2.44% as of September 1, 2022.</p><p>The lowest rate for each loan type requires automatically withdrawn (“auto debit”) payment. The lowest rate is available only to the most creditworthy applicants. Not all borrowers will receive the lowest rate. The interest rate and Annual Percentage Rate (APR) may be higher depending upon (1) the credit history of the borrower and, if applicable, the cosigner, (2) the repayment option and loan term selected, (3) the loan type selected, and (4) the highest level of education attained. If approved, applicants will be notified of the rate qualified for within the stated range.</p><h3>Savings</h3><p>Your actual savings, if any, may vary based on interest rates, balances, remaining repayment terms and other factors. Refinancing to a longer term may lower your monthly payments, but may also increase the total interest paid over the life of the loan. Refinancing to a shorter term may increase your monthly payments, but may lower the total interest paid over the life of the loan.</p>\"\n        },\n        {\n            \"lenderName\": \"SoFi\",\n            \"disclosure\": \"<p>Fixed rates range from 3.49% APR to 7.99% APR with a 0.25% autopay discount. Variable rates from 2.24% APR to 7.99% APR with a 0.25% autopay discount. Unless required to be lower to comply with applicable law, Variable Interest rates on 5-, 7-, and 10-year terms are capped at 8.95% APR; 15- and 20-year terms are capped at 9.95% APR. Your actual rate will be within the range of rates listed above and will depend on the term you select, evaluation of your creditworthiness, income, presence of a co-signer and a variety of other factors. Lowest rates reserved for the most creditworthy borrowers. For the SoFi variable-rate product, the variable interest rate for a given month is derived by adding a margin to the 30-day average SOFR index, published two business days preceding such calendar month, rounded up to the nearest one hundredth of one percent (0.01% or 0.0001). APRs for variable-rate loans may increase after origination if the SOFR index increases. The SoFi 0.25% autopay interest rate reduction requires you to agree to make monthly principal and interest payments by an automatic monthly deduction from a savings or checking account. This benefit will discontinue and be lost for periods in which you do not pay by automatic deduction from a savings or checking account. The benefit lowers your interest rate but does not change the amount of your monthly payment. This benefit is suspended during periods of deferment and forbearance. Autopay is not required to receive a loan from SoFi.</p>\"\n        }\n    ]\n}"}],"_postman_id":"d68b3eba-e8c3-4be3-b1b5-61e3d975480d"},{"name":"Explore Offer","id":"9735ead4-7ba4-4b13-b48c-91f20d7d632e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"<value>"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n    \"requestId\": \"requestId1\",\n    \"offerId\": \"offerId1\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.sparrowtest.com/pq/api/v1/explore","description":"<p>This endpoint is used whenever a borrower wants to explore an offer. This endpoint returns back the url to redirect the borrower to. This endpoint must be used in order to ensure that the link the borrower goes to is as up to date as possible. This is the case as some links have expiring tokens, and if the borrower is redirected to a link with an expiring token without this endpoint, the borrower will be directed to an error page, instead of their offers. As such, this endpoint should be called every time right before a borrower explores.</p>\n","urlObject":{"protocol":"https","path":["pq","api","v1","explore"],"host":["api","sparrowtest","com"],"query":[],"variable":[]}},"response":[{"id":"b05ec23a-08e2-4e67-838a-5be2504d320b","name":"Success Response","originalRequest":{"method":"POST","header":[],"url":"https://api.sparrowtest.com/pq/api/v1/explore"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n    \"externalUrl\": \"example.com/subId=test\"\n}"}],"_postman_id":"9735ead4-7ba4-4b13-b48c-91f20d7d632e"},{"name":"Schools","id":"9a5f3922-007d-48e9-a939-bc34948a815d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":"<value>"}]},"isInherited":false},"method":"GET","header":[],"url":"https://api.sparrowtest.com/pq/api/v1/schools","description":"<p>GET /schools - Returns all schools, colleges, and universities supported by Sparrow. The JSON response contains three fields:</p>\n<ol>\n<li>\"schools\": string array of all schools.</li>\n<li>\"degrees\": string array of all degrees.</li>\n<li>\"majors\": string array of all majors.</li>\n</ol>\n","urlObject":{"protocol":"https","path":["pq","api","v1","schools"],"host":["api","sparrowtest","com"],"query":[{"disabled":true,"key":"","value":""}],"variable":[]}},"response":[{"id":"160a324b-d81c-40ac-ade2-4b226ed181f4","name":"Schools","originalRequest":{"method":"GET","header":[],"url":"https://api.sparrowtest.com/pq/api/v1/schools"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n    \"majors\": [\n        \"major1\", \"major2\"\n    ],\n    \"schools\": [\n        \"school1\", \"school2\"\n    ],\n    \"degrees\": [\n        \"degrees1\", \"degrees2\"\n    ]\n}"}],"_postman_id":"9a5f3922-007d-48e9-a939-bc34948a815d"},{"name":"Disclosures","id":"25a24486-2812-4c20-bf35-fd6db414d317","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":"<value>"}]},"isInherited":false},"method":"GET","header":[],"url":"https://api.sparrowtest.com/pq/api/v1/disclosures?type=","description":"<p>This endpoint is called to return a list of the disclosures by lender for in school (PSL) or refi (SLR).  </p>\n<p>Type can be either PSL or SLR.</p>\n","urlObject":{"protocol":"https","path":["pq","api","v1","disclosures"],"host":["api","sparrowtest","com"],"query":[{"key":"type","value":""}],"variable":[]}},"response":[{"id":"81ed7cc6-740b-46d4-b9aa-30e63d946dd0","name":"Success Example","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.sparrowtest.com/pq/api/v1/lenders?type=<value>","protocol":"https","host":["api","sparrowtest","com"],"path":["pq","api","v1","lenders"],"query":[{"key":"type","value":"<value>"}]}},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n     \"disclosures\": [\n        {\n            \"lenderName\": \"Earnest\",\n            \"disclosure\": \"disclosure string\"\n        },\n        {\n            \"lenderName\": \"Ascent\",\n            \"disclosure\": \"disclosure string\"\n        }\n    ]\n}"}],"_postman_id":"25a24486-2812-4c20-bf35-fd6db414d317"},{"name":"Lenders","id":"fc0398fc-ed11-49ee-acd2-e8387c0ddaa4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":"<value>"}]},"isInherited":false},"method":"GET","header":[],"url":"https://api.sparrowtest.com/pq/api/v1/lenders","description":"<p>This endpoint is called to return a list of the lender's that are supported for the affiliate and their corresponding logo.</p>\n","urlObject":{"protocol":"https","path":["pq","api","v1","lenders"],"host":["api","sparrowtest","com"],"query":[],"variable":[]}},"response":[{"id":"f6d02ce2-41b2-4e98-b4ba-de9a4191651d","name":"Success Example","originalRequest":{"method":"GET","header":[],"url":"https://api.sparrowtest.com/pq/api/v1/lenders"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n    \"lenders\": [\n        {\n            \"name\": \"Ascent\",\n            \"logo\": \"logo.png\",\n            \"supportsPrequalPSL\": true,\n            \"supportsPrequalSLR\": false,\n            \"supportsNonPrequalPSL\": true,\n            \"supportsNonPrequalSLR\": false\n        },\n        {\n            \"name\": \"SoFi\",\n            \"logo\": \"logo.png\",\n            \"supportsPrequalPSL\": false,\n            \"supportsPrequalSLR\": true,\n            \"supportsNonPrequalPSL\": true,\n            \"supportsNonPrequalSLR\": true\n        }\n    ]\n}"}],"_postman_id":"fc0398fc-ed11-49ee-acd2-e8387c0ddaa4"},{"name":"Lender Reported Data For Individual","id":"b09a8d4c-426a-40e4-b643-2545c32259c2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":"<value>"}]},"isInherited":false},"method":"GET","header":[],"url":"https://api.sparrowtest.com/pq/api/v1/22e345c2-11a7-4c97-a975-c977af76ffff/lender-reported-data","description":"<p>This endpoint is called in order to get all lender reported data for the particular request. If the request does not have any lender reported data, the lenderReportedData object will be empty.</p>\n","urlObject":{"protocol":"https","path":["pq","api","v1","22e345c2-11a7-4c97-a975-c977af76ffff","lender-reported-data"],"host":["api","sparrowtest","com"],"query":[],"variable":[]}},"response":[{"id":"c1cd9ddf-ec66-4d4b-a712-2417af9bf18d","name":"Success Response","originalRequest":{"method":"GET","header":[],"url":"https://api.sparrowtest.com/pq/api/v1/22e345c2-11a7-4c97-a975-c977af76ffff/lender-reported-data"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n    \"requestId\": \"requestId\",\n    \"lenderReportedData\": {\n        \"lender\": \"Earnest\",\n        \"lenderStatus\": \"3 - Denied\",\n        \"lenderApprovedAmount\": 2000000,\n        \"lenderSignedAmount\": 2000000,\n        \"lenderRequestedAmount\": 2000000,\n        \"lenderSubmittedAmount\": 2000000,\n        \"lenderDisbursedAmount1\": 2000000,\n        \"lenderDisbursedAmount2\": 0,\n        \"lenderDisbursedAmount3\": 0,\n        \"lenderDisbursedAmount4\": 0,\n        \"lenderDeniedAmount\": 2000000,\n        \"lenderCancelledAmount\": 2000000,\n        \"lenderStartedDate\": 1655769600,\n        \"lenderSubmittedDate\": 1655769620,\n        \"lenderApprovedDate\": 1655769645,\n        \"lenderSignedDate\": \"1970-01-01\",\n        \"lenderDisbursedDate1\": \"1970-01-01\",\n        \"lenderDisbursedDate2\": \"1970-01-01\",\n        \"lenderDisbursedDate3\":  \"1970-01-01\",\n        \"lenderDisbursedDate4\":  \"1970-01-01\",\n        \"lenderDeniedDate\":  \"1970-01-01\",\n        \"lenderCancelledDate\": \"1970-01-01\",\n        \"lenderDeclineReasons\": \"\"\n    }\n}"}],"_postman_id":"b09a8d4c-426a-40e4-b643-2545c32259c2"},{"name":"Lender Reported Data For Partner","id":"0c1abd74-6d87-4aef-8ada-ecd3d26656fc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":"<value>"}]},"isInherited":false},"method":"GET","header":[],"url":"https://api.sparrowtest.com/pq/api/v1/lender-reported-data","description":"<p>This endpoint is called in order to get all lender reported data for the partner. This request returns all data for all requests that originated from the partner, reached a lender, and then had data reported back to Sparrow.</p>\n","urlObject":{"protocol":"https","path":["pq","api","v1","lender-reported-data"],"host":["api","sparrowtest","com"],"query":[],"variable":[]}},"response":[{"id":"a96c1274-2214-41ac-b646-8520d00b82a6","name":"Success Response","originalRequest":{"method":"GET","header":[],"url":"https://api.sparrowtest.com/pq/api/v1/lender-reported-data"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n    \"lenderResults\": [\n        {\n            \"requestId\": \"requestId\",\n            \"lenderReportedData\": {\n                \"lender\": \"Earnest\",\n                \"lenderStatus\": \"3 - Denied\",\n                \"lenderApprovedAmount\": 2000000,\n                \"lenderSignedAmount\": 2000000,\n                \"lenderRequestedAmount\": 2000000,\n                \"lenderSubmittedAmount\": 2000000,\n                \"lenderDisbursedAmount1\": 2000000,\n                \"lenderDisbursedAmount2\": 0,\n                \"lenderDisbursedAmount3\": 0,\n                \"lenderDisbursedAmount4\": 0,\n                \"lenderDeniedAmount\": 2000000,\n                \"lenderCancelledAmount\": 2000000,\n                \"lenderStartedDate\": 1655769600,\n                \"lenderSubmittedDate\": 1655769620,\n                \"lenderApprovedDate\": 1655769645,\n                \"lenderSignedDate\": \"1970-01-01\",\n                \"lenderDisbursedDate1\": \"1970-01-01\",\n                \"lenderDisbursedDate2\": \"1970-01-01\",\n                \"lenderDisbursedDate3\":  \"1970-01-01\",\n                \"lenderDisbursedDate4\":  \"1970-01-01\",\n                \"lenderDeniedDate\":  \"1970-01-01\",\n                \"lenderCancelledDate\": \"1970-01-01\",\n                \"lenderDeclineReasons\": \"\"\n            }\n        }\n    ]\n    \n}"}],"_postman_id":"0c1abd74-6d87-4aef-8ada-ecd3d26656fc"},{"name":"Schools And OPEIDs","id":"fe146fae-4ac8-4ae7-b66b-3743df77b6ba","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":"<value>"}]},"isInherited":false},"method":"GET","header":[],"url":"https://api.sparrowtest.com/pq/api/v1/schools/opeids","description":"<p>GET /schools/opeids - Returns all schools, colleges, universities, and opeids supported by Sparrow. The JSON response contains three fields:</p>\n<ol>\n<li>\"schools\": array of {school: string, opeid: string} objects of all schools and opeids.</li>\n<li>\"degrees\": string array of all degrees.</li>\n<li>\"majors\": string array of all majors.</li>\n</ol>\n<p>NOTE: The difference between /schools/opeids and /schools is that the former will return \"schools\" as an array of objects where each object has the fields: 1) school and 2) opeid, both of which are strings.</p>\n","urlObject":{"protocol":"https","path":["pq","api","v1","schools","opeids"],"host":["api","sparrowtest","com"],"query":[],"variable":[]}},"response":[{"id":"7be80fa9-98d0-4abe-a63a-7527574ecc18","name":"Schools And OPEIDs","originalRequest":{"method":"GET","header":[],"url":"https://api.sparrowtest.com/pq/api/v1/schools/opeids"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n    \"majors\": [\n        \"major1\", \"major2\"\n    ],\n    \"schools\": [\n        {school: \"school1\", opeid: \"opeid1\"}, {school: \"school2\", opeid: \"opeid2\"}\n    ],\n    \"degrees\": [\n        \"degrees1\", \"degrees2\"\n    ]\n}"}],"_postman_id":"fe146fae-4ac8-4ae7-b66b-3743df77b6ba"},{"name":"Webhooks","id":"52392508-e3c2-4db4-92c4-f363d58d43af","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"authorization"},{"key":"value","value":"<value>"}]},"isInherited":false},"method":"POST","header":[],"url":"https://www.example.com","description":"<p>There are four different situations where we would send a webhook with data to our partners (assuming it has been configured). We are able to enable all four, or just the one's wanted by the partner. The events are:</p>\n<p>1. Prequalification Submitted</p>\n<p>2. Prequalification Results (Submission finished)</p>\n<p>3. Rate Explored (Borrower or cosigner explored a rate)</p>\n<p>4. Lender Reported Data (Lender reported new data back to Sparrow)</p>\n<p>To see the four events, please look at the four examples for this request.</p>\n","urlObject":{"protocol":"https","host":["www","example","com"],"query":[],"variable":[]}},"response":[{"id":"c9c8f1fe-3cda-4334-9d58-04cc9ecaba5c","name":"Prequalification Submitted Webhook Fields","originalRequest":{"method":"POST","header":[],"url":"https://www.example.com"},"_postman_previewlanguage":"text","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n    payload: {\n        requestId: string\n        borrower: {\n            firstName: string\n            lastName: string\n            email: string\n            dob: request.dob,\n            loanSize: number (in cents)\n            citizenshipStatus: string\n            address: {\n                addressLine1: string;\n                addressLine2: string;\n                city: string;\n                state: string;\n                zip: string;\n                countryCode: string;\n            }\n            housing: string\n            monthlyHousingExpense: number (in cents)\n            employment: string\n            primaryPreTaxIncome: number (in cents)\n            university: string\n            degree: string\n            major: string\n            graduationDate: number (seconds since epoch)\n            enrollmentStatus: string \n            userId: string\n        },\n        cosigner: {\n            firstName: string\n            lastName: string\n            email: string\n            dob: request.dob,\n            citizenshipStatus: string\n            address: {\n                addressLine1: string;\n                addressLine2: string;\n                city: string;\n                state: string;\n                zip: string;\n                countryCode: string;\n            }\n            monthlyHousingExpense: number (in cents)\n            employment: string\n            primaryPreTaxIncome: number (in cents)\n            userId: string\n        },\n        requestStartTime: number (seconds since epoch)\n        requestSubmitTime: number (seconds since epoch)\n    },\n    type: \"PAAASRequestSubmitted\"\n}"},{"id":"5328fe47-c6b7-49fe-8127-03b47b92526e","name":"Prequalification Results Webhook Fields","originalRequest":{"method":"POST","header":[],"url":"https://www.example.com"},"_postman_previewlanguage":"text","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n    payload: {\n        requestId: string,\n        sparrowValidationError: string,\n        sparrowEligible: string,\n        averageFixedAprOfOffersReceived: string,\n        averageVariableAprOfOffersReceived: string.\n        highestFixedAprOfOffersReceived: string,\n        highestVariableAprOfOffersReceived: string,\n        lowestFixedAprOfOffersReceived: string,\n        lowestVariableAprOfOffersReceived: string,\n        averageMonthlyPaymentOfOffersReceived: string,\n        averageTotalLoanCostOfOffersReceived: string,\n        highestMonthlyPaymentOfOffersReceived: string,\n        highestMonthlyPaymentInSchoolOfOffersReceived: string,\n        highestTotalLoanCostOfOffersReceived: string,\n        lowestMonthlyPaymentOfOffersReceived: string,\n        lowestMonthlyPaymentInSchoolOfOffersReceived: string,\n        lowestTotalLoanCostOfOffersReceived: string,\n        numberOfPrequalOffersReceived: string,\n        lendersOffersReceived: string\n    },\n    type: \"PAAASRequestSubmitted\"\n}"},{"id":"c8df8eed-dce4-4ffe-b49c-eaedcdbf6edc","name":"Rate Explored Webhook Fields","originalRequest":{"method":"POST","header":[],"url":"https://www.example.com"},"_postman_previewlanguage":"text","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n    payload: {\n       requestId: string,\n        offerId: string,\n        lenderExplored: string,\n        lenderOfferExploredApr: string,\n        lenderOfferExploredMonthlyPayment: string,\n        lenderOfferExploredTerm: string,\n        lenderOfferExploredTotalLoanCost: string\n    },\n    type: \"PAAASOfferExplored\"\n}"},{"id":"5f5b809f-7ff4-4a3e-8f1d-b892423194e1","name":"Lender Reported Data Webhook Fields","originalRequest":{"method":"POST","header":[],"url":"https://www.example.com"},"_postman_previewlanguage":"text","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n    payload: {\n        Loan App ID: string\n        Request ID: string\n        Lender Requested Loan Size: number\n        Lender Approved Loan Size: number\n        Lender Disbursed to Date Loan Size: number\n        Lender Remaining to Disburse Loan Size: number\n        Total Disbursements to Date: number\n        Recent Conversion Action: string\n        Recent Conversion Action Time: number\n        Lender Status: string\n        Lender Name: string\n        Lender Application Started: boolean\n        Lender Application Started Time: number\n        Lender Application Submitted: boolean\n        Lender Application Submitted Time: number\n        Lender Application Decided: boolean\n        Lender Application Decided Time: number\n        Lender Application Approved: boolean\n        Lender Application Approved Time: number\n        Lender Decline Reasons: string\n        Lender Application Signed: boolean\n        Lender Application Signed Time: number\n        Lender Disbursed: boolean\n    },\n    type: \"LenderDataReceived\"\n}"}],"_postman_id":"52392508-e3c2-4db4-92c4-f363d58d43af"},{"name":"Prefill","id":"1b964ac8-22f5-4062-9b5d-2b2a18c5c982","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":"<value>"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n    \"firstName\": \"Test\",\n    \"lastName\": \"User\",\n    \"loanAmount\": 1000000,\n    \"email\": \"borrowers-email-here\",\n    \"phoneNumber\": \"+13104567890\",\n    \"permanentAddress\": {\n        \"addressLine1\": \"33 Irving Pl\",\n        \"city\": \"New York\",\n        \"state\": \"NY\",\n        \"zip\": \"10003\",\n        \"countryCode\": \"US\"\n    },\n    \"dob\": \"1970-01-01\",\n    \"citizenshipStatus\": {\n        \"type\": \"US Citizen or National\"\n    },\n    \"income\": {\n        \"amount\": 1000000000,\n        \"type\": \"Employed - Full Time\",\n        \"sourceChanged\": true\n    },\n    \"enrollment\": \"Full-Time Student\",\n    \"housing\": {\n        \"payment\": 1000,\n        \"type\": \"Rent\"\n    },\n    \"degrees\": [\n        {\n            \"university\": \"Duke University\",\n            \"gradDate\": \"2022-12-21\",\n            \"degreeType\": \"Bachelor of Arts (B.A.)\",\n            \"major\": \"Accounting\",\n            \"gpa\": \"3.50\"\n        }\n    ],\n    \"type\": \"PSL\",\n    \"additionalIncome\": {\n        \"amount\": 0,\n        \"frequency\": \"Annually\"\n    },\n    \"ssn\": \"100000000\",\n    \"cosigner\": {\n        \"firstName\": \"string\",\n        \"lastName\": \"string\",\n        \"email\": \"cosigner@email.com\",\n        \"dob\": \"1970-01-01\",\n        \"citizenshipStatus\": {\n            \"type\": \"US Citizen or National\"\n        },\n        \"permanentAddress\": {\n            \"addressLine1\": \"33 Irving Pl\",\n            \"city\": \"New York\",\n            \"state\": \"NY\",\n            \"zip\": \"10003\",\n            \"countryCode\": \"US\"\n        },\n        \"income\": 100000000,\n        \"additionalIncome\": 0,\n        \"employment\": \"Employed - Full Time\",\n        \"housingPayment\": 0,\n        \"ssn\": \"100000000\"\n    }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.sparrowtest.com/pq/api/v1/prefill","description":"<h1 id=\"fields\">Fields:</h1>\n<h2 id=\"required\">Required:</h2>\n<p>The following fields are required by the API:</p>\n<ol>\n<li>type (PSL or SLR)</li>\n<li>email (must match the email sent to login)</li>\n</ol>\n<h2 id=\"optional\"><strong>Optional:</strong></h2>\n<p>The following fields are optional for the API:</p>\n<ol>\n<li>loanAmount</li>\n<li>dob</li>\n<li>housing</li>\n<li>degrees</li>\n<li>citizenshipStatus</li>\n<li>permanentAddress</li>\n<li>income</li>\n<li>phoneNumber</li>\n<li>subIds</li>\n<li>enrollment</li>\n<li>ssn</li>\n<li>cosigner</li>\n<li>mailingAddress</li>\n<li>additionalIncome</li>\n</ol>\n<h4 id=\"additional-income\">Additional Income</h4>\n<p>The frequency field can take on of the following values:</p>\n<ol>\n<li>Annually</li>\n<li>Monthly</li>\n</ol>\n<h4 id=\"amounts\">Amounts</h4>\n<p>All amounts should be the value in cents.</p>\n<h4 id=\"citizenship-status\">Citizenship Status</h4>\n<p>The type for citizenshipStatus can be one of the following:</p>\n<ol>\n<li>US Citizen or National</li>\n<li>Permanent Resident</li>\n<li>Non-Permanent Resident</li>\n<li>Visa Holder</li>\n<li>DACA Recipient</li>\n<li>International Citizen</li>\n</ol>\n<h4 id=\"cosigner\">Cosigner:</h4>\n<h5 id=\"required-1\">Required:</h5>\n<p>If a cosigner is included, the following are required fields:</p>\n<ol>\n<li>firstName</li>\n<li>lastName</li>\n<li>email</li>\n<li>dob</li>\n<li>employment</li>\n<li>ssn</li>\n<li>citizenshipStatus</li>\n<li>permanentAddress</li>\n<li>income</li>\n<li>housingPayment</li>\n</ol>\n<h5 id=\"optional-1\">Optional:</h5>\n<p>If a cosigner is included, the following are optional fields:</p>\n<ol>\n<li>phoneNumber</li>\n<li>mailingAddress</li>\n<li>additionalIncome</li>\n</ol>\n<h4 id=\"dates\">Dates</h4>\n<p>All dates should be in the format YYYY-MM-DD</p>\n<h4 id=\"degrees\">Degrees</h4>\n<p>The expected major, degreeType, and university values can all be obtained by calling the schools request above.<br />Gpa should be a string.</p>\n<h4 id=\"enrollment-options\"><strong>Enrollment Options</strong></h4>\n<ol>\n<li>Full-Time Student</li>\n<li>More than half-time</li>\n<li>Less than half-time</li>\n<li>Not currently enrolled</li>\n</ol>\n<h4 id=\"housing\">Housing</h4>\n<p>The type field can take on of the following values:</p>\n<ol>\n<li>Rent</li>\n<li>Own with mortgage</li>\n<li>Own without mortgage</li>\n<li>Live with family or friends</li>\n<li>Other</li>\n</ol>\n<h4 id=\"income-and-cosigner-employment\">Income and Cosigner Employment</h4>\n<p>The type field of the income object and the employment field of the cosigner can take on one of the following values:</p>\n<ol>\n<li>Employed - Full Time</li>\n<li>Employed - Part Time</li>\n<li>Employed - Military</li>\n<li>Self Employed</li>\n<li>Future Employed</li>\n<li>Retired</li>\n<li>Unemployed</li>\n</ol>\n<h4 id=\"permanent-address\">Permanent Address</h4>\n<p>Country code must be formatted in the ISO 3166-1 alpha-2 code (that is it must be the standard two letter format).</p>\n<p>If in the US, the state must follow the format of the standard two letter state abbreviation.</p>\n<p>If in the US, zip should be five characters long.</p>\n<h4 id=\"type\"><strong>Type</strong></h4>\n<p>The type field can take on one of the following values:</p>\n<ol>\n<li>PSL</li>\n<li>SLR</li>\n</ol>\n<p>PSL (private student loan) represents an in school loan , and SLR (student loan refinance) represents a refinancing loan.</p>\n","urlObject":{"protocol":"https","path":["pq","api","v1","prefill"],"host":["api","sparrowtest","com"],"query":[],"variable":[]}},"response":[{"id":"8acecd12-23b3-46fd-a7bc-05821ad60076","name":"Success Request","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"api-key-here","type":"text"},{"key":"sparrow-access-token","value":"access-token-here","type":"text"}],"body":{"mode":"raw","raw":"{\n    \"type\": \"PSL\",\n    \"email\": \"testuser@gmail.com\",\n\n    \"loanAmount\": 1000000,\n    \"phoneNumber\": \"+13104567890\",\n    \"permanentAddress\": {\n        \"addressLine1\": \"33 Irving Pl\",\n        \"city\": \"New York\",\n        \"state\": \"NY\",\n        \"zip\": \"10003\",\n        \"countryCode\": \"US\"\n    },\n    \"dob\": \"1970-01-01\",\n    \"citizenshipStatus\": {\n        \"type\": \"US Citizen or National\"\n    },\n    \"income\": {\n        \"amount\": 1000000000,\n        \"type\": \"Employed - Full Time\",\n        \"sourceChanged\": true\n    },\n    \"enrollment\": \"Full-Time Student\",\n    \"housing\": {\n        \"payment\": 1000,\n        \"type\": \"Rent\"\n    },\n    \"degrees\": [\n        {\n            \"university\": \"Harvard University\",\n            \"gradDate\": \"2022-12-21\",\n            \"degreeType\": \"Bachelor of Arts (B.A.)\",\n            \"major\": \"Accounting\",\n            \"gpa\": \"3.50\"\n        }\n    ],\n\n    \"additionalIncome\": {\n        \"amount\": 0,\n        \"frequency\": \"Annually\"\n    },\n    \"ssn\": \"100000000\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.sparrowtest.com/pq/api/v1/qualify"},"code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n    \"redirectUrl\": \"https://sparrowtest.com/...\",\n    \"accessToken\": \"new-sparrow-access-token\"\n}"}],"_postman_id":"1b964ac8-22f5-4062-9b5d-2b2a18c5c982"},{"name":"Access Token","id":"b2eb1539-2b40-47cc-a01a-7c25bec778b7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":"<value>"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n    \"email\": \"borrowers-email-here\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.sparrowtest.com/pq/api/v1/access-token","description":"<p>This endpoint is required to get an access token for the prefill endpoint. This access token will then be used in the header sparrow-access-token for the prefill endpoint (alongside the API Key). The email for the borrower who's information will be prefilled should be utilized when calling this endpoint.</p>\n","urlObject":{"protocol":"https","path":["pq","api","v1","access-token"],"host":["api","sparrowtest","com"],"query":[],"variable":[]}},"response":[{"id":"44a06bff-311f-456c-9c11-fe96e8fd33bc","name":"Success Request","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"API-KEY-HERE","type":"text"}],"url":"https://api.sparrowtest.com/pq/api/v1/access-token"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n   \"accessToken\": \"access_token_here\" \n}"}],"_postman_id":"b2eb1539-2b40-47cc-a01a-7c25bec778b7"}]}