{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"c9799605-e746-4a27-90fe-19c6a77c93b2","name":"Apollo Finvest: Loan Read API","description":"# Apollo Finvest Loan Read API\n\nThis API allows the partner to know the Loan Status for the loans created on Apollo's system\n\n## **Overview**\n\n---\n\nThis API will help Fintech to get to know the current status of the loans that are created in Apollo's System. The loan moves through various stages and it's important for both parties to communicate the status to function smoothly. Fintechs have the option to integrate a **Callback URL or Webhook** to fetch the status to avoid hitting the APIs frequently.\n\n##### **`There are 3 key elements to Loan Read API`**\n\n1. **Authentication/Authorisation**\n    \n2. **Loan Read API**\n    \n3. **Callback URL or Webhook**\n    \n\n## Authentication/Authorisation:\n\n---\n\n`x-API-key` and access token should be sent in request headers for authenticating the request. Apollo will provide `x-API-key`. Access token should be generated by the partners. Therefore please generate a new access token using the below code piece. The token will expire in 5 minutes.\n\nPlease refer to API collection to understand more.\n\n``` python\nimport 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&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 ```\n\n---\n\n## **Required Query Parameters:**\n\n---\n\n| **Request** | **Values** | **Description** |\n| --- | --- | --- |\n| partner-tag | Unique Partner Tag provided by Apollo. Eg: \"ABC\" | **`Required.`**This act as an identification to capture the right information belonging to the right fintech partner. This tag is created by Apollo |\n| loan_type | PL (Personal Loan), ML (Micro Loan), CL (Consumer Loan), CL_2 (Consumer Loan) | **`Required.`** Use the right product as input. This should be the product type added at the time of creating a particular loan |\n| partner_loan_id | Unique Loan Id created and maintained by a partner. Eg: \"Test001\" | **`Required.`**This is the loan_id pushed by the partner to Apollo's system at the time of loan creation |\n\n## **Sample Response:**\n\n---\n\nIf a loan was successfully created in Apollo's system, the following response will be provided:\n\n``` json\n{ \n\"message\": \"loan successfully created\",\n\"partner_loan_id\": \"TEST10011\",\n\"loan_type\":\"ML\",\n\"state\": \"Document Check Pending\"\n}\n\n ```\n\nIf the sanction letter flow is on for the partner, the following response will be provided. The sanction letter or key fact statement will be provided only after a preliminary credit assessment carried out by Apollo.\n\n``` json\n{ \n\"message\": \"loan successfully created\",\n\"partner_loan_id\": \"TEST10011\",\n\"loan_type\":\"ML\",\n\"state\": \"Document Check Pending\",\n\"sanction_letter_and_KFS\": \"https://apollo-cacms-staging.s3.amazonaws.com/NRA/PL/TEST1/sanction_letter_and_KFS.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=ASIAVKNL4ZEUI2GH6DAY/20250630/ap-south-1/s3/aws4_request&X-Amz-Date=20250630T095834Z&X-Amz-Expires=300&X-Amz-SignedHeaders=host&X-Amz-Security-Token=IQoJb3JpZ2luX2VjEML//////////wEaCmFwLXNvdXRoLTEiSDBGAiEAuiR/PkYbJ3AgchPIjT8hBrWYNjmyy6Yu/fnehMNo1osCIQCOzSEXZgO7oyQswkemu5xirH21N3C07Kx98XC0L6SUOyqvAwi7//////////8BEAQaDDM2NTk2OTU5MDU2OCIMcrbnlBAmLKFC/tnkKoMDgqDbbQHh35ZHnRe5qHI4znYeM59MPerUJ5HaylzjszQ3jINJZwQmguTHjvBTYv2vcVxh7xs0pdqtC5nv2r6cEJaapVq082mzMsZpNvEBerqCNBiEzSL4zdGmNIi6uSMRggZOjMjm6GGOk3mDoL/htwExwSghEoqTVIsznWHna614K2Uah9PgwLti5n3Cn+TKerjfmcwYCz4fJXVsAMUxMyaWu+DodHTQPa4DqSVyzIG9vNLK667qOZmltMVqnUrJ5mWsio3Bcg0p+ljuMVl2eZmQtM1CQMH/68LbpZvtF3OVec7rxKn1y1GFDCp/mx6XJJIb+ty0gD+RVN9EJsULFVgeRuACbQCn8KNgfwXYM523GFPjYk3qCFAzrOxPnQTBPheWJykp3zfbRR1qsDby5zP9BkwCU+0xoo+mWitRjh5JclElI4DQYYb//qsA/QTwLdHYfcjmBV+6evXIcUHyh71cX6N/rXD9ya6O61162Zi3KDCO6X9pG86KNqkToZvCSBYfMMu9icMGOpwBWKt3ewSxcPBOgpC61OP5OgrMPCLy55L47Or9KnIXslsznz5falrMR3bv6fUpRONN/mP9iK7pph05MPlOLxk+iQsKjOZrgAIt1R3C/4hQhZ9ZNMmk+jCKRd9T+OlT8VkKlK6yjM5mrRl4hmhmStYH6xrS4WOfPg4ReRZEjRLgunpNXbLQL62QipIA/kKuR/Iak0u8M+GcO1jZHY9y&X-Amz-Signature=8de1383fc4793a398690884758f679dbed62278539e01ec60dd6b7148d5a8545\",\n\"loan_agreement\":\"https://apollo-cacms-staging.s3.amazonaws.com/NRA/PL/TEST1/sanction_letter_and_KFS.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=ASIAVKNL4ZEUI2GH6DAY/20250630/ap-south-1/s3/aws4_request&X-Amz-Date=20250630T095834Z&X-Amz-Expires=300&X-Amz-SignedHeaders=host&X-Amz-Security-Token=IQoJb3JpZ2luX2VjEML//////////wEaCmFwLXNvdXRoLTEiSDBGAiEAuiR/PkYbJ3AgchPIjT8hBrWYNjmyy6Yu/fnehMNo1osCIQCOzSEXZgO7oyQswkemu5xirH21N3C07Kx98XC0L6SUOyqvAwi7//////////8BEAQaDDM2NTk2OTU5MDU2OCIMcrbnlBAmLKFC/tnkKoMDgqDbbQHh35ZHnRe5qHI4znYeM59MPerUJ5HaylzjszQ3jINJZwQmguTHjvBTYv2vcVxh7xs0pdqtC5nv2r6cEJaapVq082mzMsZpNvEBerqCNBiEzSL4zdGmNIi6uSMRggZOjMjm6GGOk3mDoL/htwExwSghEoqTVIsznWHna614K2Uah9PgwLti5n3Cn+TKerjfmcwYCz4fJXVsAMUxMyaWu+DodHTQPa4DqSVyzIG9vNLK667qOZmltMVqnUrJ5mWsio3Bcg0p+ljuMVl2eZmQtM1CQMH/68LbpZvtF3OVec7rxKn1y1GFDCp/mx6XJJIb+ty0gD+RVN9EJsULFVgeRuACbQCn8KNgfwXYM523GFPjYk3qCFAzrOxPnQTBPheWJykp3zfbRR1qsDby5zP9BkwCU+0xoo+mWitRjh5JclElI4DQYYb//qsA/QTwLdHYfcjmBV+6evXIcUHyh71cX6N/rXD9ya6O61162Zi3KDCO6X9pG86KNqkToZvCSBYfMMu9icMGOpwBWKt3ewSxcPBOgpC61OP5OgrMPCLy55L47Or9KnIXslsznz5falrMR3bv6fUpRONN/mP9iK7pph05MPlOLxk+iQsKjOZrgAIt1R3C/4hQhZ9ZNMmk+jCKRd9T+OlT8VkKlK6yjM5mrRl4hmhmStYH6xrS4WOfPg4ReRZEjRLgunpNXbLQL62QipIA/kKuR/Iak0u8M+GcO1jZHY9y&X-Amz-Signature=8de1383fc4793a398690884758f679dbed62278539e01ec60dd6b7148d5a8545\"\n}\n\n ```\n\nIf the loan is not created in Apollo's system:\n\n``` json\n{\n\"message\": \"No Such Loan Exists\"\n}\n\n ```\n\n## Callback URL or Webhook Integration\n\n---\n\nThe partner can provide a Callback URL or Webhook at the time of integration. Apollo's Loan Management System: Sonic sends notifications through this URL whenever a loan's stage gets updated. This URL will be added to the partner’s configuration on Sonic to enable this feature.\n\n### How will this feature works:\n\nWhenever Apollo update or move a loan from one stage to another, the same would be communicated to the partner on this URL. The response will be shared with certain params which will provide a clear status to the partner about the loans created with Apollo.\n\n### **Response body:**\n\n| **Key** | **Value** |\n| --- | --- |\n| State | State on which the loan currently is on |\n| Loan Type | Type of the loan (PL/ML) |\n| Message | Message corresponding to the state of the loan |\n| Partner Loan ID | loan ID given by the partner at the time of loan creation |\n| Partner Tag | Partner tag on which the loan exists |\n\n### Loan Stages/States with Messages\n\n| **Stage/State** | **Message** |\n| --- | --- |\n| KYC Check | \"Loan processed for KYC check\" |\n| KYC Failed | \"KYC Failed\" |\n| Credit Check | \"Credit underwriting is in process\" |\n| Disbursement Pending | \"Congrats! The loan is ready for disbursement\" |\n| Loan Ongoing | \"Success! The disbursement is done and the loan is ongoing\" |\n| Failed | \"Oops! The disbursement is failed\" |\n| Rejected | \"Sorry! The loan is rejected; not eligible to process\" |\n| Loan Complete | \"The loan is completed\" |\n\n## Sample Response:\n\n---\n\nBelow is a sample response passed through the Callback URL or Webhook. Please go through the **`Loan Read Response Handbook`** to understand the states and messages in more detail. [Click here to access](https://drive.google.com/file/d/1UqwNbXfMnPTyM049-PkULQ6xYIWzm-fB/view?usp=sharing).\n\n``` json\n  \"state\": \"Disbursement Pending\",\n  \"loan_type\": \"PL\",\n  \"message\": \"Congrats! The loan is ready for disbursement\",\n  \"partner_loan_id\": \"TESTLoan\",\n  \"partner_tag\": \"AFIL\"\n\n ```\n\n## **Response Status Codes:**\n\n---\n\n| **Status Codes** | **Description** |\n| --- | --- |\n| **200** | Successful Request |\n| **400** | Invalid Request |\n| **401** | Unauthorized (The incoming token has expired) |\n| **403** | Forbidden (x-API-key is wrong or partner is not allowed to use this API |\n| **404** | Not Found (No such loan exists) |\n| **500** | Internal Server Error (Rare) |\n| **504 bad gateway** | The server is down. Please inform the tech POC immediately. You can retry within few seconds |\n\n# **Rate Limit**\n\n---\n\n### **Throttling**\n\n:10000 requests per second.\n\n### **Quota**\n\n:Unlimited total number of API calls\n\n# **SLA breakdown**\n\n---\n\n- ### **Standard Support**\n    \n\nApollo 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.\n\n- ### **Uptime commitment**\n    \n\nUptime is the percentage of total possible minutes API was available during a fiscal year. Our commitment is to maintain at least 99.99% uptime\n\n- ### **Scheduled downtime**\n    \n\nSometimes 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.\n\n# **Updates**\n\nAs 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.","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"19353747","team":1156724,"collectionId":"c9799605-e746-4a27-90fe-19c6a77c93b2","publishedId":"UVeMHPHR","public":true,"publicUrl":"https://documenter-api.postman.tech/view/19353747/UVeMHPHR","privateUrl":"https://go.postman.co/documentation/19353747-c9799605-e746-4a27-90fe-19c6a77c93b2","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"documentationLayout":"classic-double-column","customisation":null,"version":"8.11.6","publishDate":"2022-02-11T06:28:15.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/87e241c84e614759761cb3ee48d6e0fc0a0562472ca2ed15e13f486c3b809bf6","favicon":""},"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://documenter.gw.postman.com/view/metadata/UVeMHPHR"}