This request allows the partners to create a loan in Apollo's Loan Management System: Sonic.
\nLoans can be configured in innumerable amount of ways. At Apollo Finvest we support Personal Loans (Daily, Weekly, and Monthly Instalments), Microloans, Line of Credit, and Consumer loans. However, not every field within the payload of this request is required, and some are more important than others.
customer information, loan information and with necessary document links (S3) of the customerstage, loan_id and S3 link to KFS and Sanction letter if this is enabled in the systemHere's what else you need to know about this request:
\nThis is a post-request API for UAT/Test environment to create a loan in Apollo's database. After the successful integration of this API in UAT, we will provide you with the Production URL and credentials.
\nBefore hitting this API, the partner will have to do the following:
\nx-API-key and access tokens should be sent in request headers for authenticating the request. Apollo will provide x-API-key. Access tokens 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 API collection to understand more...
\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\nThe below attributes are important and must be required in the request to create a loan. New attributes can be collected and added to the API as per custom requirements from the partners. There are Validation has been added to all these fields and if there is any error in the requests the API will return the responses accordingly.
\n
In this section, the partner has to send all the necessary and required details of the borrower. These are a few fields mentioned here as an example, however, there can be more fields in the actual API based on the final business discussion. As mentioned above, these fields have validations and in case of any errors, it will return the response accordingly. The below-mentioned are the allowed values for a few fields. Please go through the validation document attached above for a better understanding.
In this section of the loan request body, the partner needs to send the loan details which is an essential part of the loan creation. There are validations in these inputs as well. You can find more details in the validation file.
\nThe partner has to upload all the required documents (as decided) into Apollo's S3 bucket and send urls in Loan Create API's request body. A few examples of the documents collected are PAN, Aadhaar xml, Selfie, etc. Apollo's system will validate whether we received all the documents in the S3 or not. For more information read the S3 Docs Upload section below.
\n\ndocument_urls = Contains S3 key of uploaded documents
\n
eg: \"cibil\": \"partner_tag/loan_type/partner_loan_id/cibil.json\"
{\n \"partner_tag\": \"Unique Partner Tag provided by Apollo\",\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 \"pan_uidai\": \"partner_tag/loan_type/partner_loan_id/pan.json\",\n \"bank_statement\": \"partner_tag/loan_type/partner_loan_id/bank_statement.pdf\",\n \"aadhar_uidai_xml\": \"partner_tag/loan_type/partner_loan_id/aadhar_uidai_xml.zip\",\n \"cibil\": \"partner_tag/loan_type/partner_loan_id/loan_agreement.pdf\"\n }\n}\n\nOnce the loan is created successfully, a preliminary credit check will be done simultaneously. The following response will be provided along with S3 URL to the sanction letter and KFS (Key Fact Statement). The same can be used to display to the borrower for signing. After the signing, it must be uploaded to Apollo's S3. Also, the partner will get to the stage of the loan.
\n{\n \"message\": \"loan successfully created\",\n \"loan_type\": \"PL\",\n \"partner_loan_id\": \"TEST2202\",\n \"state\": \"document_check_pending\",\n \"sanction_letter_and_KFS\": \"partner_tag/loan_type/TEST2202/sanction_letter_and_KFS.pdf\"\n}\n\nIf the partner_loan_id sent already exists in Apollo's system;
\n{\n \"message\": \"loan already exists with loan_type - PL and partner_loan_id-test1010\"\n}\n\nIf documents are not uploaded or S3 url to the particular doc is missing;
\n{\n \"message\": \"Missing doc in s3 - loan_agreement\"\n}\n\nOnce the loan is successfully created, and a preliminary credit check is done, S3 key/URL for the Sanction Letter and KFS will be added to the response. The KFS is a crucial document of the loan and important to show it to the borrower. If the signed Sanaction Letter-KFS and Loan Agreement (LA) are missing in Apollo's S3 the loan will not move to the next stages.
\nThe Loan agreement format must be shared by the partner and approved by Apollo Finvest.
The Loan Stages Flow and access to more related documents are here.
\n\n\nPlease note that the Sanction Letter and KFS will be available 99% of the time within 5 seconds on S3.
\n
The Sanction Letter and KFS can be downloaded any number of times using the same S3 Credentials shared by apollo.
\nDaily repayment or EDI (Equated Daily Installment) is a type of loan repayment available within the Personal Loan as a sub-product. This allows the borrower to repay the loan on a daily basis. Please request the EDI API documentation in case you would like to integrate the product.
These are the common error codes pushed by the API in case of any errors
\nThe allowed values and inputs for address states are mentioned below;
\n\"BIHAR\"\n\"SIKKIM\"\n\"ARUNACHAL PRADESH\"\n\"NAGALAND\"\n\"MANIPUR\"\n\"MIZORAM\"\n\"TRIPURA\"\n\"MEGHALAYA\"\n\"ASSAM\"\n\"WEST BENGAL\"\n\"WESTBENGAL\"\n\"JHARKHAND\"\n\"ORISSA\"\n\"ODISHA\"\n\"CHHATTISGARH\"\n\"MADHYA PRADESH\"\n\"GUJRAT\"\n\"GUJARAT\"\n\"DAMAN & DIU\"\n\"DAMAN AND DIU\"\n\"DADRA & NAGAR HAVELI\"\n\"DADRA AND NAGAR HAVELI\"\n\"MAHARASHTRA\"\n\"ANDHRA PRADESH\"\n\"KARNATAKA\"\n\"GOA\"\n\"LAKSHADWEEP\"\n\"KERALA\"\n\"TAMIL NADU\"\n\"PONDICHERRY\"\n\"PUDUCHERRY\"\n\"ANDAMAN & NICOBAR ISLANDS\"\n\"ANDAMAN AND NICOBAR ISLANDS\"\n\"TELANGANA\"\n\"APO ADDRESS\"\n\"JAMMU & KASHMIR\"\n\"JAMMU AND KASHMIR\"\n\"HIMACHAL PRADESH\"\n\"PUNJAB\"\n\"CHANDIGARH\"\n\"UTTARANCHAL\"\n\"UTTARAKHAND\"\n\"HARYANA\"\n\"DELHI\"\n\"RAJASTHAN\"\n\"UTTAR PRADESH\"\n\nYou can use the AWS SDK to upload objects in Amazon S3. The SDK provides wrapper libraries for you to upload data easily. We have listed some of the most popularly used. For information, see the List of supported SDKs.
\nThe following C# code example creates two objects with two PutObjectRequest requests:
PutObjectRequest request saves a text string as sample object data. It also specifies the bucket and object key names.PutObjectRequest request uploads a file by specifying the file name. This request also specifies the ContentType header and optional object metadata (a title).For instructions on how to create and test a working sample, using Amazon, see Running the Amazon S3 .NET Code Examples.
\nusing Amazon.S3;\nusing Amazon.S3.Model;\nusing System;\nusing System.Threading.Tasks;\nnamespace Amazon.DocSamples.S3\n{\n class UploadObjectTest\n {\n private const string bucketName = \"*** bucket name ***\";\n // For simplicity the example creates two objects from the same file.\n // You specify key names for these objects.\n private const string keyName1 = \"key name for first object created\";\n private const string keyName2 = \"key name for second object created\";\n private const string filePath = @\"*** file path ***\";\n private static readonly RegionEndpoint bucketRegion = RegionEndpoint.EUWest1; \n private static IAmazonS3 client;\n public static void Main()\n {\n client = new AmazonS3Client(bucketRegion);\n WritingAnObjectAsync().Wait();\n }\n static async Task WritingAnObjectAsync()\n {\n try\n {\n // 1. Put object-specify only key names for the new object.\n var putRequest1 = new PutObjectRequest\n {\n BucketName = bucketName,\n Key = keyName1,\n ContentBody = \"sample text\"\n };\n PutObjectResponse response1 = await client.PutObjectAsync(putRequest1);\n // 2. Put the object-set ContentType and add metadata.\n var putRequest2 = new PutObjectRequest\n {\n BucketName = bucketName,\n Key = keyName2,\n FilePath = filePath,\n ContentType = \"text/plain\"\n };\n putRequest2.Metadata.Add(\"x-amz-meta-title\", \"someTitle\");\n PutObjectResponse response2 = await client.PutObjectAsync(putRequest2);\n }\n catch (AmazonS3Exception e)\n {\n Console.WriteLine(\n \"Error encountered ***. Message:'{0}' when writing an object\"\n , e.Message);\n }\n catch (Exception e)\n {\n Console.WriteLine(\n \"Unknown encounter on server. Message:'{0}' when writing an object\"\n , e.Message);\n }\n }\n }\n}\n\nThe following example creates two objects. The first object has a text string as data, and the second object is a file. The example creates the first object by specifying the bucket name, object key, and text data directly in a call to AmazonS3Client.putObject(). The example creates the second object by using a PutObjectRequest that specifies the bucket name, object key, and file path. The PutObjectRequest also specifies the ContentType header and title metadata.
For instructions on creating and testing a working sample, see Testing the Amazon S3 Java Code Examples.
\nimport com.amazonaws.AmazonServiceException;\nimport com.amazonaws.SdkClientException;\nimport com.amazonaws.regions.Regions;\nimport com.amazonaws.services.s3.AmazonS3;\nimport com.amazonaws.services.s3.AmazonS3ClientBuilder;\nimport com.amazonaws.services.s3.model.ObjectMetadata;\nimport com.amazonaws.services.s3.model.PutObjectRequest;\nimport java.io.File;\nimport java.io.IOException;\npublic class UploadObject {\n public static void main(String[] args) throws IOException {\n Regions clientRegion = Regions.DEFAULT_REGION;\n String bucketName = \"*** Bucket name ***\";\n String stringObjKeyName = \"*** String object key name ***\";\n String fileObjKeyName = \"*** File object key name ***\";\n String fileName = \"*** Path to file to upload ***\";\n try {\n //This code expects that you have AWS credentials set up per:\n // https://docs.aws.amazon.com/sdk-for-java/v1/developer-guide/setup-credentials.html\n AmazonS3 s3Client = AmazonS3ClientBuilder.standard()\n .withRegion(clientRegion)\n .build();\n // Upload a text string as a new object.\n s3Client.putObject(bucketName, stringObjKeyName, \"Uploaded String Object\");\n // Upload a file as a new object with ContentType and title specified.\n PutObjectRequest request = new PutObjectRequest(bucketName, fileObjKeyName, new File(fileName));\n ObjectMetadata metadata = new ObjectMetadata();\n metadata.setContentType(\"plain/text\");\n metadata.addUserMetadata(\"title\", \"someTitle\");\n request.setMetadata(metadata);\n s3Client.putObject(request);\n } catch (AmazonServiceException e) {\n // The call was transmitted successfully, but Amazon S3 couldn't process \n // it, so it returned an error response.\n e.printStackTrace();\n } catch (SdkClientException e) {\n //Amazon S3 couldn't be contacted for a response, or the client\n // couldn't parse the response from Amazon S3.\n e.printStackTrace();\n }\n }\n}\n\nThe following example uploads an existing file to an Amazon S3 bucket. in a specific Region.\n\n// Import required AWS SDK clients and commands for Node.js.\nimport { PutObjectCommand } from \"@aws-sdk/client-s3\";\nimport { s3Client } from \"./libs/s3Client.js\"; // Helper function that creates Amazon S3 service client module.\nimport {path} from \"path\";\nimport {fs} from \"fs\";\nconst file = \"OBJECT_PATH_AND_NAME\"; // Path to and name of object. For example '../myFiles/index.js'.\nconst fileStream = fs.createReadStream(file);\n// Set the parameters\nconst uploadParams = {\n Bucket: \"BUCKET_NAME\",\n // Add the required 'Key' parameter using the 'path' module.\n Key: path.basename(file),\n // Add the required 'Body' parameter\n Body: fileStream,\n};\n// Upload file to specified bucket.\nconst run = async () => {\n try {\n const data = await s3Client.send(new PutObjectCommand(uploadParams));\n console.log(\"Success\", data);\n return data; // For unit tests.\n } catch (err) {\n console.log(\"Error\", err);\n }\n};\nrun();\n\nThis topic assumes that you are already following the instructions for Using the AWS SDK for PHP and Running PHP Examples and have the AWS SDK for PHP properly installed.
\nThe following PHP example creates an object in a specified bucket by uploading data using the putObject() method. For information about running the PHP examples in this guide, see Running PHP Examples.
require 'vendor/autoload.php';\nuse Aws\\S3\\S3Client;\nuse Aws\\S3\\Exception\\S3Exception;\n$bucket = '*** Your Bucket Name ***';\n$keyname = '*** Your Object Key ***';\n$s3 = new S3Client([\n 'version' => 'latest',\n 'region' => 'us-east-1'\n]);\ntry {\n // Upload data.\n $result = $s3->putObject([\n 'Bucket' => $bucket,\n 'Key' => $keyname,\n 'Body' => 'Hello, world!',\n 'ACL' => 'public-read'\n ]);\n // Print the URL to the object.\n echo $result['ObjectURL'] . PHP_EOL;\n} catch (S3Exception $e) {\n echo $e->getMessage() . PHP_EOL;\n}\n\nThe AWS SDK for Ruby - Version 3 has two ways of uploading an object to Amazon S3. The first uses a managed file uploader, which makes it easy to upload files of any size from disk. To use the managed file uploader method:\n\nAws::S3::Resource class.#upload_file on the object.require 'aws-sdk-s3'\n# Uploads an object to a bucket in Amazon Simple Storage Service (Amazon S3).\n#\n# Prerequisites:\n#\n# - An S3 bucket.\n# - An object to upload to the bucket.\n#\n# @param s3_client [Aws::S3::Resource] An initialized S3 resource.\n# @param bucket_name [String] The name of the bucket.\n# @param object_key [String] The name of the object.\n# @param file_path [String] The path and file name of the object to upload.\n# @return [Boolean] true if the object was uploaded; otherwise, false.\n# @example\n# exit 1 unless object_uploaded?(\n# Aws::S3::Resource.new(region: 'us-east-1'),\n# 'doc-example-bucket',\n# 'my-file.txt',\n# './my-file.txt'\n# )\ndef object_uploaded?(s3_resource, bucket_name, object_key, file_path)\n object = s3_resource.bucket(bucket_name).object(object_key)\n object.upload_file(file_path)\n return true\nrescue StandardError => e\n puts \"Error uploading object: #{e.message}\"\n return false\nend\n\nThe second way that AWS SDK for Ruby - Version 3 can upload an object uses the #put method of Aws::S3::Object. This is useful if the object is a string or an I/O object that is not a file on disk. To use this method:
Aws::S3::Resource class.#put, passing in the string or I/O object.require 'aws-sdk-s3'\n# Uploads an object to a bucket in Amazon Simple Storage Service (Amazon S3).\n# Prerequisites:\n# - An S3 bucket.\n# - An object to upload to the bucket.\n# @param s3_client [Aws::S3::Resource] An initialized S3 resource.\n# @param bucket_name [String] The name of the bucket.\n# @param object_key [String] The name of the object.\n# @param file_path [String] The path and file name of the object to upload.\n# @return [Boolean] true if the object was uploaded; otherwise, false.\n# @example\n# exit 1 unless object_uploaded?(\n# Aws::S3::Resource.new(region: 'us-east-1'),\n# 'doc-example-bucket',\n# 'my-file.txt',\n# './my-file.txt'\n# )\ndef object_uploaded?(s3_resource, bucket_name, object_key, file_path)\n object = s3_resource.bucket(bucket_name).object(object_key)\n File.open(file_path, 'rb') do |file|\n object.put(body: file)\n end\n return true\nrescue StandardError => e\n puts \"Error uploading object: #{e.message}\"\n return false\nend\n\nput_object(**kwargs)
Adds an object to a bucket. You must have WRITE permissions on a bucket to add an object to it.
Amazon S3 never adds partial objects; if you receive a success response, Amazon S3 has added the entire object to the bucket.
\nThe following example creates an object. If the bucket is versioning enabled, S3 returns version ID in response.
\nimport boto3\nclient = boto3.client(\n 's3',\n aws_access_key_id=AWS_ACCESS_KEY_ID,\n aws_secret_access_key=AWS_SECRET_ACCESS_KEY,\n region_name = 'ap-south-1'\n)\nresponse = client.put_object(\n Body='filetoupload',\n Bucket='examplebucket',\n Key='objectkey',\n)\nprint(response)\n\nParameters:
\n{\n 'ETag': '\"6805f2cfc46c0f04559748bb039d69ae\"',\n 'VersionId': 'Bvq0EDKxOcXLJXNo_Lkz37eM3R4pfzyQ',\n 'ResponseMetadata': {\n '...': '...',\n },\n}\n\n