{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"e740a587-65a2-4b25-ac60-4342845a8785","name":"Apollo Finvest Loan Creation UAT API","description":"# Apollo Finvest Loan Creation API\n\n## Requirements\n\n* * *\n\nBefore hitting this API, the partner will have to do the following:\n\n*   Upload documents on S3\n*   Hit the bureau API to get the S3 key of bureau documents\n    \n\n## Description\n\n* * *\n\nThis is post request API for UAT/test environment, creating a loan in Apollo's database. After successful integration with this API, we will provide you production URL and credentials.\n\n## Authentication/Authorisation\n\n* * *\n\nX-api-key is an API aunthentication key provided by Apollo used to manage access control\n\n*   Content-Type = application/json\n*   x-api-key = ****\n    \n\n## Required Fields\n\n* * *\n\n*   action = create\n*   partner_tag = Unique Partner Tag provided by Apollo\n*   loan_type = ML(Micro Loan)/PL(Personal Loan)/CL(Consumer Loan)\n*   partner_loan_id = Unique loan id maintained by partner\n*   loan_information\n    *   disbursement_date = Date string e.g. \"06/05/2021\"\n    *   emi_frequency = Variavble field depends on loan type(custom/monthly)\n    *   first_emi_date = Date string e.g. \"06/05/2021\"\n    *   loan_amount = Numeric Value\n    *   tenure = integer value(1 in case of ML)\n    *   loan_tenure_in_days = applicable for ML only\n    *   fees\n        *   processing_fee\n            *   fee_amount = Numeric Value\n            *   gst_amount = Numeric Value\n        *   subvention_fee = Same values as processing fee\n        *   other_fee = Same values as processing fee\n    *   interest_rate = Numeric Value\n    *   interest_type = \"flat\"/\"reducing\"\n    *   has_pre_emi = (true/false)\n    *   partner_computed_disbursement_amount = Disbursement amount calculated by Partner\n    *   partner_computed_interest_amount = Interest amount calculated by Partner\n    *   partner_computed_pre-emi_amount = Contains pre emi value calculated by partner if applicable\n    *   partner_computed_emi_amount = EMI amount calculated by partner\n*   customer_information = Contains variable set of fields for different partners\n*   Customer Information Enums:\n    *   bank_account_type_enum = \\['current', 'savings'\\]\n    *   gender_enum = \\['male', 'female', 'other'\\]\n    *   marital_status_enum = \\['married', 'unmarried', 'divorced'\\]\n    *   residence_type_enum = \\['owned', 'rented'\\]\n    *   address_type_enum = \\['permanent', 'residence', 'office'\\]\n    *   occupation_enum = \\['employed', 'self_employed'\\]\n*   document_urls = Contains S3 key of uploaded documents\n    \n\n## Sample Request Body\n\n* * *\n\n```\n{\n    \"partner_tag\": \"MOC\",\n    \"action\": \"create\",\n    \"loan_type\": \"PL\",\n    \"partner_loan_id\": \"TEST2202\",\n    \"customer_id\": \"12345\",\n    \"loan_information\": {\n        \"disbursement_date\": \"19/11/2020\",\n        \"emi_frequency\": \"monthly\",\n        \"first_emi_date\": \"05/12/2020\",\n        \"loan_amount\": 5000.00,\n        \"tenure\": 1,\n        \"fees\": {\n            \"processing_fee\": {\n                \"fee_amount\": 250.00,\n                \"gst_amount\": 90.00\n            }\n        },\n        \"interest_rate\": 0.2268,\n        \"interest_type\": \"reducing\",\n        \"has_pre_emi\": false,\n        \"partner_computed_disbursement_amount\": 241150,\n        \"partner_computed_interest_amount\": 25660,\n        \"partner_computed_pre-emi_amount\": 0.00,\n        \"partner_computed_emi_amount\": 30629.00\n    },\n    \"customer_information\": {\n        \"first_name\": \"Deelip\",\n        \"last_name\": \"Kumar\",\n        \"aadhaar\": \"12121212\",\n        \"employee_name\": \"Sona Patel\",\n        \"address\": \"102, Sneha Apat, Andheri west, Mumbai Maharashtra 400090\",\n        \"permanent_address\": \"102, Sneha Apat, Andheri west, Mumbai Maharashtra 400090\",\n        \"date_of_birth\": \"12/09/1987\",\n        \"gender\": \"female\",\n        \"employment_status\": \"active\",\n        \"mtd_payable_days\": \"30\",\n        \"date_of_joining\": \"15/07/2012\",\n        \"net_salary\": \"34000\",\n        \"gross_salary\": \"38000\",\n        \"employer_name\": \"JK Store\",\n        \"emp_id\": \"1550\",\n        \"mobile_number\": \"7878654523\",\n        \"phone\": \"7878654523\",\n        \"bank_name\": \"HDFC Bank\",\n        \"bank_account_number\": \"50100211470817\",\n        \"bank_account_type\": \"savings\",\n        \"bank_account_name\": \"Sona Patel\",\n        \"ifsc_code\": \"HDFC0001046\",\n        \"pan\": \"AFGPL6787R\"\n    },\n    \"document_urls\": {\n        \"loan_agreement\": \"PAYM/PL/5f327af7d45277317daa3887/loan_agreement.pdf\",\n        \"sanction_letter\": \"AMZ/PL/TEST1017/sanction_letter.pdf\",\n        \"pan_uidai\": \"PAYM/PL/5f327af7d45277317daa3887/loan_agreement.pdf\",\n        \"bank_statement\": \"PAYM/PL/5f327af7d45277317daa3887/loan_agreement.pdf\",\n        \"aadhar_uidai_xml\": \"PAYM/PL/5f327af7d45277317daa3887/loan_agreement.pdf\",\n        \"cibil\": \"PAYM/PL/5f327af7d45277317daa3887/loan_agreement.pdf\"\n    }\n}\n\n```\n\n## Sample Response\n\n* * *\n\nOn successful loan creation, the following response will be provided.\n\n```\n{\n    \"message\": \"loan successfully created\",\n    \"loan_type\": \"PL\",\n    \"partner_loan_id\": \"TEST2202\",\n    \"state\": \"document_check_pending\",\n    \"sanction_letter\": \"MOC/TEST2202/sanction_letter.pdf\"\n}\n\n```\n\nFor duplicate, partner_loan_id response will be\n\n```\n{\n    \"message\": \"loan already exists with loan_type - PL and partner_loan_id-test1010\"\n}\n\n```\n\nIf documents are not uploaded then the response will be\n\n```\n{\n    \"message\": \"Missing doc in s3 - loan_agreement\"\n}\n\n```\n\n### **Sanction letter Flow**\n\nOnce the loan is successfully created, an S3 key for the sanction letter will be added to the response.\n\nPlease note that the sanction letter will not be available immediately.\n\nIt will be available 99% of the time within 5 seconds on S3.\n\nThe Sanction letter can be downloaded any number of times using the same S3 Credentials shared by apollo.\n\n## Status Codes\n\n1.  **200**  \n    : Successful Request\n2.  **400**  \n    : Invalid Request\n3.  **500**  \n    : Internal Server Error (Rare)\n4.  **504** bad gateway  \n    : The server is down. Please inform immediately to tech POC. You can retry within a few seconds.\n    \n\n# Rate Limit\n\n*   **Throttling**  \n    :10000 requests per second.\n*   **Quota**  \n    :Unlimited total number of API calls\n    \n\n# SLA breakdown\n\n*   **Standard Support**  \n    : 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.\n*   **Uptime commitment**  \n    : 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:\n*   **Scheduled downtime**  \n    : 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.\n*   **Updates**  \n    : 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.","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"12930268","collectionId":"e740a587-65a2-4b25-ac60-4342845a8785","publishedId":"TzeXmTZm","public":true,"publicUrl":"https://documenter-api.postman.tech/view/12930268/TzeXmTZm","privateUrl":"https://go.postman.co/documentation/12930268-e740a587-65a2-4b25-ac60-4342845a8785","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"documentationLayout":"classic-double-column","customisation":null,"version":"8.10.0","publishDate":"2021-06-18T13:28:55.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/768118b36f06c94b0306958b980558e6915839447e859fe16906e29d683976f0","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/TzeXmTZm"}