Apollo uses in-house developed serverless APIs to get credit information of borrowers from different credit bureaus. This API is used to fetch the credit information from CIBIL.
\nThis API is developed on a serverless infrastructure that offers high scalability and the ability to serve millions of requests at the same time. The specific API Postman collection will be shared at the time of integration.
\nIt's a Post Request API given to partners by Apollo to fetch the credit information from CIBIL. When the partner hit this API, Apollo hits the Credit Bureau API to fetch the information and then share relevant details with the partner. The response will be in JSON format.
These are the necessary fields that must be present in the request body with particular values as mentioned below. A successful response will be provided if all these inputs are added to the request.
\nThese are the optional fields in the request body. In a few scenarios, the partner will get a response even if these inputs are missing in the request body.
\nfalse in the request body, then the partner doesn't need to push these inputs.\n\nNote: If any required field is missing or type is not \"string\" it will return the response with the particular field's name or the error (eg: firstName/addressType) in the response body.
\n
{\n \"creditBureau\":\"Credit 1\",\n \"loanType\":\"personal\",\n \"addressCategory\":\"residence\",\n \"partnerTag\":\"TEST\",\n \"partnerLoanId\":\"13c5609\",\n \"telephoneNumber\":\"9595453711\",\n \"firstName\":\"Varun\",\n \"lastName\":\"Kapoor\",\n \"gender\":\"male\",\n \"dateOfBirth\":\"30031997\",\n \"panNumber\":\"PANNUM123345\",\n \"loanAmount\":\"10000\",\n \"addressLine1\":\"PLOT NO 76, BEHIND KRISHNA MANDIR,\",\n \"addressLine2\":\"GURUDEV BHAVAN Ayodhya Nagar\",\n \"city\":\"Nagpur\",\n \"stateCode\":\"27\",\n \"state\":\"Maharashtra\",\n \"pinCode\":\"440024\",\n \"callbackUrl\":\"https://google.com\"\n}\n\n{\n \"creditBureau\":\"Credit 1\",\n \"loanType\":\"personal\",\n \"addressCategory\":\"office\",\n \"partnerTag\":\"TEST\",\n \"partnerLoanId\":\"112233\",\n \"telephoneNumber\":\"7002064556\",\n \"firstName\":\"DEBAJEET\",\n \"lastName\":\"KALITA\",\n \"gender\":\"female\",\n \"dateOfBirth\":\"01121983\",\n \"panNumber\":\"CAQPK2869F\",\n \"loanAmount\":\"10000\",\n \"addressLine1\":\"15, Jyoti Path, Japorigog Krishnanagar,\",\n \"addressLine2\":\"Knishnanagar LP School, Dispur, Kamrup\",\n \"city\":\"Guwahati\",\n \"stateCode\":\"18\",\n \"state\":\"Assam\",\n \"pinCode\":\"781005\",\n \"callbackUrl\":\"https://google.com\",\n \"hasCoApplicant\":true,\n \"coApplicanntDetails\":{\n \"addressCategory\":\"office\",\n \"telephoneNumber\":\"7002064556\",\n \"firstName\":\"SAMARJEET\",\n \"lastName\":\"SINGH\",\n \"gender\":\"male\",\n \"dateOfBirth\":\"01121983\",\n \"panNumber\":\"CA1124567\",\n \"addressLine1\":\"15, Jyoti Path, Japorigog Krishnanagar,\",\n \"addressLine2\":\"Knishnanagar LP School, Dispur,Kamrup\",\n \"city\":\"Guwahati\",\n \"stateCode\":\"18\",\n \"state\":\"Assam\",\n \"pinCode\":\"781005\",\n \"callbackUrl\":\"https://google.com\"\n }\n }\n\nOnce the partner hit Credit Bureau API 1, Apollo accepts the request and fetches the data from Bureau. This derived json report will be shared when the partner hit Read Result API.
\n{\n \"partnerLoanId\":\"XX1245XXX\",\n \"partnerTag\":\"TEST123\"\n}\n\nAPI response on callback url when the processing is finished, or when the partner queries previously submitted a request through Apollo API:
\n i. partnerLoanID: unique identifier provided by partner in the request\n\nii. parsed_report: the processed data in JSON format.
\niii. errorCode: If any error is received from the Bureau directly, we will return that at the end of the response. if no error is received then it will show \"no error\".
\n*Please go through this document to understand all the responses received from Read Result API.
*Cibil Read Result API Responses
In case the request had co-applicant details: the response is sent in 2 different POST requests.
\nWhere:
\na. For main applicant details, partnerLoanID =partnerLoanID (e.g: “12345”)\nb. For co-applicant details, partnerLoanID =partnerLoanID + “/co-applicant” (e.g:“12345/co-applicant”)\n\ni. application_details:
\n1. date_processed: date when report was pulled from Credit 1 API\n2. time_proceessed: time when report was pulled from Credit 1 API\n3. partner_loan_id: unique identifier provided by partner in the request\n4. s3_url: s3 location of where this report is stored by Apollo\n a. Partner needs to keep a track of this if, this customer loan is sent to Apollo for disbursement approval\n\nii.consumer_details:
\n1. “name_field_n”: name variations recorded in Credit 1\n2. “gender”\n a. 1 - female\n b. 2 - male\n c. 3 - transgender\n3. “date_of_birth”: format - “ddmmyyyy”\n4. “Score_range”\n a. Credit 1 score in a range of 10\n b. e.g: for a Credit 1 score of 652, the response will be “650-660”.\n c. for score below and equal 650 score_range will return \"below 650\".\n d. for score above and equal 850 score_range will return \"above 850\".\n5. “active_accounts”\n a. Aggregated & computed details of all active accounts of the customer\n b. The actual data present here depends on\n i. The availability of data with Credit 1\n ii. Type of account\n c. Attributes:\n i. Account_type: classification id as per Credit 1 of different account types\n ii. Account_type_name: name of the account type\n iii. Currrent_balance: The entire amount of credit/loan, including the current and overdue portion, if any, outstanding as of the date in the Date Reported and Certified field. This is inclusive of interest for Credit Cards\n iv. High_credit_or_sanctioned: For Credit Card (Account Type 10), Fleet Card (Account Type 16), Secured Credit Card (Account Type 31) and Corporate Credit Card (Account Type 35), this field contains the highest amount of credit used in the history of the account.\n For all other accounts, this field contains the amount of loan sanctioned. This amount is a whole number and is assumed to be positive.\n v. Amount_overdue: The amount past due as of the date reported in the Date Reported and Certified field.\n This amount is a whole number and is assumed to be positive.\n vi. Date_opened_or_disbursed: This is the date of first disbursement of the account.For Credit/Fleet cards, this is the date the card becomes active. Format is DDMMYYYY.\n vii. Credit_limit: Only available when the account type is 10 (credit card)\n viii. Emi_amount: Emi amount associated with the account repayment\n ix. Repayments: customer repayment history for the specific account\n 1. Detailed specification below\n6. “Inactive_accounts”\n a. Aggregated & computed details of all inactive accounts of the customer. The actual data present here depends on\n i. The availability of data with Credit 1\n ii. Type of account\n c. Attributes:\n i. Account_type: defined above (under active accounts)\n ii. Account_type_name: defined above (under active accounts)\n iii. High_credit_or_sanctioned: defined above (under active accounts)\n iv. Emi_amount: defined above (under active accounts)\n v. Date_opened_or_disbursed: defined above (under active accounts)\n vi. Date_closed: This is the date the account was closed. Format is DDMMYYYY.\n vii. Suit_filed_or_wilful_default:\n 1. If false - no suit filed or willful default\n 2. If true - suit filed or willful default or both\n Viii. Written_off_and_settled\n 1. If false - not written off or settled\n 2. If true- either written off or settled\n7. Repayments (common section for active & inactive accounts)\n a. Reported_payment_start_date: This is the date of the beginning of the payment history.Format is DDMMYYYY.\n b. Reported_payment_end_date: This is the date of the end of the payment history. Format is DDMMYYYY.\n c. Number_of_reported_payments: number of reported payments for this account\n d. Highest_reported_dpd: highest reported dpd tracked for this account\n e. Number_of_0_dpd_reported_payments: number of repayments with no defaults\n f. Number_of_1_to_15_dpd_reported_payments:\n number of repayments with days past due between 1 to 15\n g. Number_of_15_to_31_dpd_reported_payments:\n number of repayments with days past due between 15 to 31\n h. Number_of_31_to_60_dpd_reported_payments:\n number of repayments with days past due between 31 to 60\n i. Number_of_60_to_90_dpd_reported_payments:\n number of repayments with days past due between 60 to 90\n j. Number_of_90_plus_dpd_reported_payments:\n number of repayments with days past due are 90 +\n k. Lastest_month_dpd: dpd off the latest reported month\n l. Latest_3_months: aggregated metrics for dpd (days past due) over the last 3 months\n m. Latest_6_months: aggregated metrics for dpd (days past due) over the last 6 months. Latest_12_months: aggregated metrics for dpd (days past due) over the last 12 months\n n. Latest_18_months: aggregated metrics for dpd (days past due) over the last 18 months \n o. Latest_24_months: aggregated metrics for dpd (days past due) over the last 24 months\n p. Latest_30_months: aggregated metrics for dpd (days past due) over the last 30 months\n q. Latest_36_months: aggregated metrics for dpd (days past due) over the last 36 months\n8. “Enquiries”:\n a. ate_of_enquiry: date of the previous enquiry made on behalf of the customer\n b. Enquiry_purpose: purpose of the previous enquiry made on behalf of the customer\n c. Enquiry_amount: amount of the previous enquiry made on behalf of the customer\n9. “emails”: customer email variations present with Credit 1\n\nNTC means New To Credit. In a normal scenario, NTC will be provided in NTC score in the report, and this will be always -1 in the score field. It is now possible to get a credit score for the previous NTC (New to Credit) borrowers. This will be a paid feature.
\nYou don't have to change anything while sending requests via the create API.
There will be a new field in the CIBIL response called \"NTC\" under the parsed_report field as shown below. This is the risk band provided by CIBIL, especially for the NTC. However, this will be enabled only if the partner is doing an NTC product and it comes with a nominal charge.
\"NTC\": {\n\"ntc_data\": {\n\"risk_band\": \"119\"\n},j\n\"ntc_status\": {\n\"ErrorMessage\": null,\n\"IsSuccess\": \"True\"\n}\n}\nrisk_band field range will be 100-200.py\n\nPlease consume the ntc_data only if the value of IsSuccess field under the ntc_status field is True.
\n10000 requests per second.
\nUnlimited total number of API calls
\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.
\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:
\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.
\nPlease refer to the Bureau guidelines file for more details.
\n\"Jammu and Kashmir\": \"01\",\n\"Himachal Pradesh\": \"02\",\n\"Punjab\": \"03\",\n\"Chandigarh\": \"04\",\n\"Uttaranchal\": \"05\",\n\"Uttarakhand\": \"05\",\n\"Haryana\": \"06\",\n\"Delhi\": \"07\",\n\"Rajasthan\": \"08\",\n\"Uttar Pradesh\": \"09\",\n\"Bihar\": \"10\",\n\"Sikkim\": \"11\",\n\"Arunachal Pradesh\": \"12\",\n\"Nagaland\": \"13\",\n\"Manipur\": \"14\",\n\"Mizoram\": \"15\",\n\"Tripura\": \"16\",\n\"Meghalaya\": \"17\",\n\"Assam\": \"18\",\n\"West Bengal\": \"19\",\n\"Jharkhand\": \"20\",\n\"Orissa\": \"21\",\n\"Odisha\": \"21\",\n\"Chhattisgarh\": \"22\",\n\"Madhya Pradesh\": \"23\",\n\"Gujarat\": \"24\",\n\"Daman & Diu\": \"25\",\n\"Daman and Diu\": \"25\",\n\"Dadra & Nagar Haveli\": \"26\",\n\"Dadra and Nagar Haveli\": \"26\",\n\"Maharashtra\": \"27\",\n\"Andhra Pradesh\": \"28\",\n\"Karnataka\": \"29\",\n\"Goa\": \"30\",\n\"Lakshadweep\": \"31\",\n\"Kerala\": \"32\",\n\"Tamil Nadu\": \"33\",\n\"Pondicherry\": \"34\",\n\"Andaman & Nicobar Islands\": \"35\",\n\"Andaman and Nicobar Islands\": \"35\",\n\"Telangana\": \"36\"\n\n