{"info":{"_postman_id":"8ad2e142-e52c-4407-a7af-da2437649573","name":"Apollo Finvest: Borrower Status API","description":"<html><head></head><body><h1 id=\"negative-borrower-list-read-api\"><strong>Negative Borrower List Read API</strong></h1>\n<h2 id=\"overview\">Overview</h2>\n<p>This is a GET request API for UAT/ Test Environment to check whether the borrower belongs to the negative list of Apollo. After successfully integrating this API, we will provide you with the production URL and credentials.</p>\n<h2 id=\"authenticationauthorization\">Authentication/Authorization:</h2>\n<hr>\n<p><code>x-API-key</code> and <code>access token</code> should be sent in request headers for authenticating the request. Apollo will provide <code>x-API-key</code>. <code>Access token</code> should be generated by the partners. Therefore please generate a new access token using the below code piece. Token will expire in 5 minutes.<br>Please refer API collection to understand more.</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-python\">import requests\nimport base64\nurl = \"will be shared by apollo\"\napp_client_id = \"will be shared by apollo\"\napp_secret = \"will be shared by apollo\"\nbasic = base64.b64encode((app_client_id+':'+app_secret).encode())\npayload = 'grant_type=client_credentials&amp;scope='\nheaders = {\n    'Authorization': 'Basic '+basic.decode(),\n    'Content-Type': 'application/x-www-form-urlencoded',\n}\nresponse = requests.request(\"POST\", url, headers=headers, data=payload)\nprint(response.json())\n\n</code></pre>\n<h2 id=\"required-query-parameters\">Required Query Parameters:</h2>\n<hr>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Parameters</strong></th>\n<th><strong>Vales</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>pan</td>\n<td>The Pan number of the borrower. Eg: \"ABCPD1122K\"</td>\n<td><strong><code>Required</code></strong> This is will be the PAN number of the borrower whose status needs to be checked</td>\n</tr>\n<tr>\n<td>phone</td>\n<td>The Phone number of the borrower. Eg: \"9920123456\"</td>\n<td><strong><code>Required</code></strong> This is will be <strong>10 digit</strong> Phone number of the borrower whose status needs to be checked</td>\n</tr>\n<tr>\n<td>partner_tag</td>\n<td>Unique Partner Tag provided by Apollo. Eg: \"ABC\"</td>\n<td><strong><code>Required.</code></strong> This is a unique value assigned by Apollo to its partners to identify them to create and store loans in Apollo's system</td>\n</tr>\n</tbody>\n</table>\n</div><h2 id=\"sample-response\">Sample Response:</h2>\n<p>If the status is active where the borrower doesn't belong to the Negative List of Apollo then the following response will be provided:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n    \"status\": \"ACTIVE\",\n    \"message\": \"Congratulations! The particular borrower is eligible for the loan\"\n}\n\n</code></pre>\n<p>If the status is inactive where provided PAN number of the borrower belongs to the Negative List of Apollo then the following response will be provided:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n    \"status\": \"INACTIVE\",\n    \"message\": \"Sorry for the inconvenience, The particular PAN holder is not eligible for the loan. This PAN belongs to the negative borrowers list of Apollo.\"\n}\n\n</code></pre>\n<p>If the status is inactive where provided the mobile number of the borrower belongs to the Negative List of Apollo then the following response will be provided:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n    \"status\": \"INACTIVE\",\n    \"message\": \"Sorry for the inconvenience, The particular Phone number holder is not eligible for the loan. This Phone number belongs to the negative borrowers list of Apollo.\"\n}\n\n</code></pre>\n<h1 id=\"response-status-codes\">Response Status Codes:</h1>\n<hr>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Status Code</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><strong>200</strong></td>\n<td>Successful Request</td>\n</tr>\n<tr>\n<td><strong>400</strong></td>\n<td>Invalid Request</td>\n</tr>\n<tr>\n<td><strong>401</strong></td>\n<td>Unauthorized (The incoming token has expired)</td>\n</tr>\n<tr>\n<td><strong>403</strong></td>\n<td>Forbidden (x-API-key is wrong or partner is not allowed to use this API)</td>\n</tr>\n<tr>\n<td><strong>404</strong></td>\n<td>Not Found (No such loan exists)</td>\n</tr>\n<tr>\n<td><strong>500</strong></td>\n<td>Internal Server Error (Rare)</td>\n</tr>\n<tr>\n<td><strong>504 bad gateway</strong></td>\n<td>The server is down. Please inform immediately to Tech POC. Also can be retried in a few seconds</td>\n</tr>\n</tbody>\n</table>\n</div><h1 id=\"rate-limit\">Rate Limit</h1>\n<hr>\n<h2 id=\"throttling\">Throttling</h2>\n<p>10000 requests per second.</p>\n<h2 id=\"quota\">Quota</h2>\n<p>Unlimited total number of API calls</p>\n<h1 id=\"sla-breakdown\">SLA breakdown</h1>\n<hr>\n<h2 id=\"standard-support\">Standard Support</h2>\n<p>Apollo will provide standard technical support twenty-four (24) hours per day, five (5) days per week, excluding weekends and national Indian holidays. Standard Support will be offered via email.</p>\n<h2 id=\"uptime-commitment\">Uptime commitment</h2>\n<p>Uptime is the percentage of total possible minutes API was available during a fiscal year. Our commitment is to maintain at least 99.99% uptime:</p>\n<h2 id=\"scheduled-downtime\">Scheduled downtime</h2>\n<p>Sometimes we need to perform maintenance to keep API working smoothly. If scheduled downtime is necessary, we’ll give you at least 48 hours advance notice. In a year, scheduled downtime won’t exceed 12 hours.</p>\n<h2 id=\"updates\">Updates:</h2>\n<p>As our business evolves, we may change our service level agreement. Customers can review the most current version of the service level agreement at any time by visiting this page.</p>\n</body></html>","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Negative Borrower List Read API","slug":"negative-borrower-list-read-api"},{"content":"Response Status Codes:","slug":"response-status-codes"},{"content":"Rate Limit","slug":"rate-limit"},{"content":"SLA breakdown","slug":"sla-breakdown"}],"owner":"19353747","collectionId":"8ad2e142-e52c-4407-a7af-da2437649573","publishedId":"2s7ZLhqXYN","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2022-09-23T10:44:25.000Z"},"item":[{"name":"access token generator","id":"d8eeef6d-c944-4858-a0fd-54279ba159f0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"clientId","value":"<client-id>"},{"key":"clientSecret","value":"<client-secret>"},{"key":"grant_type","value":"<grant_type>"},{"key":"client_authentication","value":"<client_authentication>"},{"key":"accessTokenUrl","value":"<access-token-url>"},{"key":"authUrl","value":"<auth-url>"}]},"isInherited":false},"method":"GET","header":[],"url":"https://{name-api-app.auth.ap-server-name-2.{servercognito}.com/{auth2}/token","urlObject":{"protocol":"https","path":["{auth2}","token"],"host":["{name-api-app","auth","ap-server-name-2","{servercognito}","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"d8eeef6d-c944-4858-a0fd-54279ba159f0"},{"name":"Borrower status","id":"acfd298e-f142-4be0-ac53-c3ead0434716","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"**********","type":"text"},{"key":"x-api-key","value":"**********","type":"text"}],"url":"https://{servername.com}/{env}/{version}/{apiname}/?pan={Valid PAN number of borrower}&phone={Valid 10 digits mobile number of borrower}&partner_tag={Valid partner tag}","urlObject":{"protocol":"https","path":["{env}","{version}","{apiname}",""],"host":["{servername","com}"],"query":[{"key":"pan","value":"{Valid PAN number of borrower}"},{"key":"phone","value":"{Valid 10 digits mobile number of borrower}"},{"key":"partner_tag","value":"{Valid partner tag}"}],"variable":[]}},"response":[],"_postman_id":"acfd298e-f142-4be0-ac53-c3ead0434716"}]}