{"info":{"_postman_id":"58e45cee-be3a-4c63-9ffc-663d15516d75","name":"Apollo Finvest: NOC API","description":"

Get NOC Document API

\n

This API is to generate NOC (No dues letter) from Apollo Finvest for the loans that are closed and there are no overdue.

\n

Overview:

\n

This API will help the partner generate NOC for the loans that are closed. The loans will be closed or completed in Apollo's Loan Management System when the borrower repays all the overdue EMIs and when there is no principal outstanding.

\n

This is a GET request API for UAT/ Test Environment to get the NOC document from Apollo. After successfully integrating this API, we will provide you with the production URL and credentials.

\n

Authentication/Authorization:

\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.
Please refer to the API collection to understand more.

\n
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&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

Required Query Parameters:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
RequestValuesDescription
partner_loan_idUnique Loan Id created and maintained by the partnerRequired. This loan_id must be the same one used at the time of loan creation on Apollo's LMS. It should not be more than 10 digits. It is created by the partner
loan_typePL/ML/CLRequired. Use the right input same as the one used at the time of loan creation for that particular loan_id. PL- Personal Loan, ML- Micro Loan, CL- Consumer Loan
partner_tagUnique Partner Tag provided by ApolloRequired. This helps to identify the partner on Apollo's system. This is created by Apollo.
\n

Sample Response:

\n

If a loan is closed then NOC will get generated by giving the below response

\n
{\n    \"partner_tag\": \"TEST\",\n    \"loan_type\": \"PL\",\n    \"partner_loan_id\": \"test\",\n    \"S3 key\": \"This would be the presigned url for the document\"\n}\n\n
\n

If the loan is not closed on Apollo's platform then the following response will be provided (Status code 404):

\n
{\n    \"message\": \"NOC cannot be generated as the requested loan is not closed yet\"\n}\n\n
\n

If the loan doesn't exist on Apollo's platform then the following response will be provided:

\n
{\n    \"message\": \"Loan does not exist\"\n}\n\n
\n

If the partner tag given is invalid then the following response will be provided:

\n
{\n    \"message\": \"Invalid partner tag\"\n}\n\n
\n

If the loan type given is invalid then the following response will be provided:

\n
{\n    \"message\": \"Unsupported loan type KL\"\n}\n\n
\n

Response status Codes:

\n

200

\n

Successful Request

\n

400

\n

Invalid Request

\n

401

\n

Unauthorized (The incoming token has expired)

\n

403

\n

Forbidden (x-api-key is wrong or partner is not allowed to use this API)

\n

404

\n

Not Found (Noc Not Found)

\n

500

\n

Internal Server Error (Rare)

\n

504

\n

Bad gateway

\n

Rate Limit

\n\n

SLA breakdown

\n\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Get NOC Document API","slug":"get-noc-document-api"},{"content":"Rate Limit","slug":"rate-limit"},{"content":"SLA breakdown","slug":"sla-breakdown"}],"owner":"16291369","collectionId":"58e45cee-be3a-4c63-9ffc-663d15516d75","publishedId":"2s7YYsbiuU","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2022-09-13T11:24:46.000Z"},"item":[{"name":"NOC Request API","id":"e0e77975-0661-4054-875a-ee3b1e0ace47","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","value":"*******","type":"text"},{"key":"Authorization","value":"*******","type":"text"}],"url":"https://{servername.com}/{env}/{version}/noc?partner_tag=TEST&loan_type=PL&partner_loan_id=TST10","urlObject":{"protocol":"https","path":["{env}","{version}","noc"],"host":["{servername","com}"],"query":[{"key":"partner_tag","value":"TEST"},{"key":"loan_type","value":"PL"},{"key":"partner_loan_id","value":"TST10"}],"variable":[]}},"response":[],"_postman_id":"e0e77975-0661-4054-875a-ee3b1e0ace47"},{"name":"Access Token Generator","id":"c630ea49-eb95-4308-846d-16441718e6cc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":""},{"key":"clientSecret","value":""},{"key":"clientId","value":""},{"key":"headerPrefix","value":""},{"key":"grant_type","value":""},{"key":"authUrl","value":""}]},"isInherited":false},"method":"GET","header":[],"body":{"mode":"formdata","formdata":[{"key":"grant_type","value":"client_credentials","type":"text"}]},"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":"c630ea49-eb95-4308-846d-16441718e6cc"}]}