{"_id":"5becab67032fe8042a71ed1f","project":"59f79e3c584eb200345ceafc","version":{"_id":"5ba178b00a916500030c6a21","project":"59f79e3c584eb200345ceafc","__v":24,"forked_from":"59f79e3c584eb200345ceaff","createdAt":"2015-09-17T03:47:20.956Z","releaseDate":"2015-09-17T03:47:20.956Z","categories":["5ba178b00a916500030c69a2","5ba178b00a916500030c69a3","5ba178b00a916500030c69a4","5ba178b00a916500030c69a5","5ba178b00a916500030c69a6","5ba178b00a916500030c69a7","5ba178b00a916500030c69a8","5ba178b00a916500030c69a9","5ba178b00a916500030c69aa","5ba178b00a916500030c69ab","5ba178b00a916500030c69ac","5afb6888212c690003ae3d3b","5ba178b00a916500030c69ad","5ba178b00a916500030c69ae","5ba2dcbc99f53f0003b97e2c","5babd73fa0ab3e0003ead030","5bb4038be7222e000334dd97","5bb55954478c1300031a44c2","5bb665a1607307000327c81e","5bb6f90229a7fb0003a0650d","5bb7f9bc29a7fb0003a07ac1","5bba58bd7ba7710003bd901d","5bba6dac7ba7710003bd908d","5bba6e257ba7710003bd9090","5bbac87810189c0003e619ea","5bbb9d02b5862c00036266b2","5bbbadb6219c3e000376c2de","5bc417751d1b0000182bf7f6","5bc59e3b2a5b4f0044db5b97","5bc7bbce2262cc0041f6eff2","5bce6a3580a7250031199f34","5bcfac2c4082510019f2d91b","5bcfac3757bed90030e45d68","5bcfac45d305bc0049941539","5bd2a43548bb6f00289c8fad","5bd3a42a026ebe001f66259e","5bd9d5afffe003005b02f97b","5becb7ee85c6b300557662b6"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":false,"codename":"","version_clean":"3.2.0","version":"3.2"},"category":{"_id":"5ba178b00a916500030c69ae","project":"59f79e3c584eb200345ceafc","version":"5ba178b00a916500030c6a21","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2018-09-16T22:26:26.400Z","from_sync":false,"order":15,"slug":"loans","title":"One-Time Loans"},"user":"5557e76e512c300d007730d1","__v":16,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2018-11-14T23:10:31.285Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"method":"post","examples":{"codes":[]},"results":{"codes":[]},"settings":"","auth":"required","params":[{"_id":"5b9eea62607b190003a37683","ref":"","in":"body","required":false,"desc":"Supply `LOAN-US`","default":"","type":"string","name":"type"},{"_id":"5b9eea62607b190003a37682","ref":"","in":"body","required":false,"desc":"","default":"","type":"string","name":"info.nickname"}],"url":"/v3.1/users/:user_id/nodes"},"isReference":false,"order":2,"body":"After you [Create a User](https://docs.synapsefi.com/v3.2/docs/create-a-user-1) and [OAuth the User](https://docs.synapsefi.com/v3.2/docs/oauth-the-user), the user is ready to apply for a loan.\n\nUpon applying for a loan, users will know instantly if they are approved and rejected, along with rejection reason.\n\nFollowing are permissible reasons an application could be rejected:\n\n1. Loan rejected because KYC is not finished.\n2. Loan rejected because currently we do not issue loans for your user type.\n3. Loan rejected because the requested loan amount is higher than what we currently allow. The limit *platform_limit*\n4. Loan rejected because you are over the limit of loans we currently allow. The limit is *platform_limit*.\n5. Loan rejected because your credit score is low. Your credit needs to be over *platform_limit*.\n\n\n##Loan Program:\nHere are all the features you can customize on your spec sheet for a loan:\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Program Details\",\n    \"h-1\": \"Comment\",\n    \"0-0\": \"Agreement Delivery\",\n    \"0-1\": \"Platform or Synapse\",\n    \"1-0\": \"Transaction Notification\",\n    \"1-1\": \"Platform or Synapse\",\n    \"2-0\": \"Loan Type\",\n    \"2-1\": \"One Time and/or Revolving\",\n    \"3-0\": \"Credit Score\",\n    \"3-1\": \"N/A\",\n    \"4-0\": \"APR\",\n    \"4-1\": \"XX%\",\n    \"5-0\": \"Cap Amount\",\n    \"5-1\": \"$XX\",\n    \"6-0\": \"Max Amount per Loan\",\n    \"6-1\": \"$XX\",\n    \"7-0\": \"Repayment\",\n    \"7-1\": \"Auto-Debit\",\n    \"8-0\": \"Schedule\",\n    \"8-1\": \"Monthly\",\n    \"9-0\": \"Custom Rules\",\n    \"9-1\": \"N/A\",\n    \"h-2\": \"Details\",\n    \"0-2\": \"You can decide if you want to send your end user the agreement or use our white labeled email notifications\",\n    \"1-2\": \"You can decide if you want to send your end users notifications about loans or use our white labeled text message notifications\",\n    \"2-2\": \"You can decide if you want to issue a one time loan or a revolving line of credit\",\n    \"3-2\": \"You can factor in soft credit score pulls as part of your decision. Here you can set a minimum credit score users should have to receive a loan\",\n    \"4-2\": \"This is the amount of interest charged on the loan that the user takes out\",\n    \"5-2\": \"Although the APR on a loan can increase, there will be cap on the dollar amount of interest that a end user gets charged. That way the interest can only increase to a certain amount at the most\",\n    \"6-2\": \"The maximum dollar amount that can be taken out per loan for the user.\",\n    \"7-2\": \"This is how the user will repay their loan. Auto-debit means that the user will be automatically debited on the same day/date on a monthly schedule\",\n    \"8-2\": \"Loan repayment can be scheduled to happen on a recurring monthly basis\",\n    \"9-2\": \"This accounts for any additional customization that you would have for loan decisioning\"\n  },\n  \"cols\": 3,\n  \"rows\": 10\n}\n[/block]\n##API ENDPOINT\nhttps://uat-api.synapsefi.com/v3.1/users/:user_id/nodes\n\n##PATH PARAMETERS\n[block:html]\n{\n  \"html\": \"<div class=\\\"api-manager\\\"> <div class=\\\"param-table\\\"> <div class=\\\"table\\\"> <div class=\\\"tr\\\"> <div class=\\\"td param\\\"> <strong>user_id <span class=\\\"colon\\\">:</span> </strong> <div class=\\\"required\\\">required</div></div><div class=\\\"td\\\"> <strong class=\\\"param-type\\\">string</strong> <div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"> <p>The user ID of the user you wish to add the LOAN-US node under</p></div></div></div></div></div></div>\"\n}\n[/block]\n##BODY PARAMETERS\n[block:html]\n{\n  \"html\": \"<div class=\\\"api-manager\\\"> <div class=\\\"param-table\\\"> <div class=\\\"table\\\"> <div class=\\\"tr\\\"> <div class=\\\"td param\\\"> <strong>type <span class=\\\"colon\\\">:</span> </strong> <div class=\\\"required\\\">required</div></div><div class=\\\"td\\\"> <strong class=\\\"param-type\\\">string</strong> <div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"> <p>LOAN-US</p></div></div></div><div class=\\\"tr\\\"> <div class=\\\"td param\\\"> <strong> <span class=\\\"text-muted\\\">info.</span>loan_type <span class=\\\"colon\\\">:</span> </strong> <div class=\\\"required\\\">required</div></div><div class=\\\"td\\\"> <strong class=\\\"param-type\\\">string</strong> <div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"> <p>Type of Loan (`ONE-TIME`)</p></div></div></div><div class=\\\"tr\\\"> <div class=\\\"td param\\\"> <strong> <span class=\\\"text-muted\\\">info.</span>nickname <span class=\\\"colon\\\">:</span> </strong> </div><div class=\\\"td\\\"> <strong class=\\\"param-type\\\">string</strong> <div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"> <p>nickname of the loan account</p></div></div></div><div class=\\\"tr\\\"> <div class=\\\"td param\\\"> <strong> <span class=\\\"text-muted\\\">info.credit_limit.</span>amount <span class=\\\"colon\\\">:</span> </strong> <div class=\\\"required\\\">required</div></div><div class=\\\"td\\\"> <strong class=\\\"param-type\\\">float</strong> <div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"> <p>limit of how much money can be borrowed out of this loan account</p></div></div></div><div class=\\\"tr\\\"> <div class=\\\"td param\\\"> <strong> <span class=\\\"text-muted\\\">info.credit_limit.</span>currency <span class=\\\"colon\\\">:</span> </strong> <div class=\\\"required\\\">required</div></div><div class=\\\"td\\\"> <strong class=\\\"param-type\\\">string</strong> <div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"> <p>currency of the loan account</p></div></div></div><div class=\\\"tr\\\"> <div class=\\\"td param\\\"> <strong> <span class=\\\"text-muted\\\">info.interest.</span>apr <span class=\\\"colon\\\">:</span> </strong></div><div class=\\\"td\\\"> <strong class=\\\"param-type\\\">float</strong> <div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"> <p>APR on the loan in percentage</p></div></div></div><div class=\\\"tr\\\"> <div class=\\\"td param\\\"> <strong> <span class=\\\"text-muted\\\">info.interest.</span>cap <span class=\\\"colon\\\">:</span> </strong></div><div class=\\\"td\\\"> <strong class=\\\"param-type\\\">float</strong> <div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"> <p>Max interest that will be charged on the loan in USD.</p></div></div></div><div class=\\\"tr\\\"> <div class=\\\"td param\\\"> <strong> <span class=\\\"text-muted\\\">info.</span>payment_node_id <span class=\\\"colon\\\">:</span> </strong></div><div class=\\\"td\\\"> <strong class=\\\"param-type\\\">string</strong> <div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"> <p>node ID of where we will collect payments from</p></div></div></div><div class=\\\"tr\\\"> <div class=\\\"td param\\\"> <strong> <span class=\\\"text-muted\\\">info.</span>disbursement_node_id: <span class=\\\"colon\\\"></span> </strong></div><div class=\\\"td\\\"> <strong class=\\\"param-type\\\">string</strong> <div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"> <p>node id of where the funds will be disbursed to.</p></div></div></div><div class=\\\"tr\\\"> <div class=\\\"td param\\\"> <strong> <span class=\\\"text-muted\\\">info.</span>document_id <span class=\\\"colon\\\">:</span> </strong> <div class=\\\"required\\\">required</div></div><div class=\\\"td\\\"> <strong class=\\\"param-type\\\">string</strong> <div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"> <p>KYC document ID of the user</p></div></div></div><div class=\\\"tr\\\"> <div class=\\\"td param\\\"> <strong> <span class=\\\"text-muted\\\">info.</span>schedule <span class=\\\"colon\\\">:</span> </strong> <div class=\\\"required\\\">required</div></div><div class=\\\"td\\\"> <strong class=\\\"param-type\\\">string</strong> <div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"> <p>Payment schedule. All schedules are listed below</p></div></div></div><div class=\\\"tr\\\"> <div class=\\\"td param\\\"> <strong> <span class=\\\"text-muted\\\">info.</span>next_payment <span class=\\\"colon\\\">:</span> </strong></div><div class=\\\"td\\\"> <strong class=\\\"param-type\\\">long</strong> <div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"> <p>when the next payment is due. In unixtime (milliseconds)</p></div></div></div><div class=\\\"tr\\\"> <div class=\\\"td param\\\"> <strong> <span class=\\\"text-muted\\\">info.</span>num_payments <span class=\\\"colon\\\">:</span> </strong></div><div class=\\\"td\\\"> <strong class=\\\"param-type\\\">long</strong> <div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"> <p>Number of payments due</p></div></div></div><div class=\\\"tr\\\"> <div class=\\\"td param\\\"> <strong> <span class=\\\"text-muted\\\">info.</span>installment_amount <span class=\\\"colon\\\">:</span> </strong></div><div class=\\\"td\\\"> <strong class=\\\"param-type\\\">float</strong> <div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"> <p>amount for each payment installment.</p></div></div></div><div class=\\\"tr\\\"> <div class=\\\"td param\\\"> <strong> <span class=\\\"text-muted\\\">extra.</span>supp_id <span class=\\\"colon\\\">:</span> </strong> </div><div class=\\\"td\\\"> <strong class=\\\"param-type\\\">string</strong> <div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"> <p>Supplement id for node</p></div></div></div></div></div></div>\"\n}\n[/block]\n##Example Request\nApplying for a loan is a `POST` API call to a Node.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"POST /v3.1/users/5b9ee70e04707a0067a724d5/nodes HTTP/1.1\\nHost: uat-api.synapsefi.com\\nX-SP-USER-IP: 255.127.79.76\\nX-SP-USER: oauth_F0rsnYzBpfZkNh91aERc5d|e83cf6ddcf778e37bfe3d48fc78a6502062fc\\nContent-Type: application/json\\nCache-Control: no-cache\\n\\n{\\n  \\\"type\\\": \\\"LOAN-US\\\",\\n  \\\"info\\\": {\\n  \\t\\\"loan_type\\\":\\\"ONE-TIME\\\",\\n    \\\"nickname\\\":\\\"My Loan\\\",\\n    \\\"credit_limit\\\":{\\n    \\t\\\"amount\\\":500.2,\\n    \\t\\\"currency\\\":\\\"USD\\\"\\n    },\\n    \\\"payment_node_id\\\":\\\"5be9296c4408930090ac92d2\\\",\\n    \\\"disbursement_node_id\\\":\\\"5be9296c4408930090ac92d2\\\",\\n    \\\"document_id\\\":\\\"2a4a5957a3a62aaac1a0dd0edcae96ea2c\\\",\\n    \\\"schedule\\\":\\\"MONTHLY\\\",\\n    \\\"next_payment\\\":30,\\n    \\\"num_payments\\\":10\\n  },\\n  \\\"extra\\\":{\\n  \\t\\\"supp_id\\\":\\\"xx123c\\\"\\n  }\\n}\",\n      \"language\": \"http\"\n    },\n    {\n      \"code\": \"curl -X POST \\\\\\n  https://uat-api.synapsefi.com/v3.1/users/5be9295b92571b00a74dc9c9/nodes \\\\\\n  -H 'Content-Type: application/json' \\\\\\n  -H 'X-SP-USER: oauth_QAdymv3UWO04u2kEXPV|e83cf6ddcf778e37' \\\\\\n  -H 'X-SP-USER-IP: 255.127.79.76' \\\\\\n  -d '{\\n  \\\"type\\\": \\\"LOAN-US\\\",\\n  \\\"info\\\": {\\n  \\t\\\"loan_type\\\":\\\"ONE-TIME\\\",\\n    \\\"nickname\\\":\\\"My Loan\\\",\\n    \\\"credit_limit\\\":{\\n    \\t\\\"amount\\\":500.2,\\n    \\t\\\"currency\\\":\\\"USD\\\"\\n    },\\n    \\\"payment_node_id\\\":\\\"5be9296c4408930090ac92d2\\\",\\n    \\\"disbursement_node_id\\\":\\\"5be9296c4408930090ac92d2\\\",\\n    \\\"document_id\\\":\\\"2a4a5957a3a62aaac1a0dd0edcae\\\",\\n    \\\"schedule\\\":\\\"MONTHLY\\\",\\n    \\\"next_payment\\\":30,\\n    \\\"num_payments\\\":10\\n  },\\n  \\\"extra\\\":{\\n  \\t\\\"supp_id\\\":\\\"xx123c\\\"\\n  }\\n}'\",\n      \"language\": \"curl\"\n    }\n  ]\n}\n[/block]\n##Examples Responses:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"error_code\\\": \\\"0\\\",\\n    \\\"http_code\\\": \\\"200\\\",\\n    \\\"limit\\\": 20,\\n    \\\"node_count\\\": 1,\\n    \\\"nodes\\\": [\\n        {\\n            \\\"_id\\\": \\\"5be9291d440893008eac92c4\\\",\\n            \\\"_links\\\": {\\n                \\\"self\\\": {\\n                    \\\"href\\\": \\\"https://uat-api.synapsefi.com/v3.1/users/5be921d3321f48008eac7810/nodes/5be9291d440893008eac92c4\\\"\\n                }\\n            },\\n            \\\"allowed\\\": \\\"CREDIT\\\",\\n            \\\"client\\\": {\\n                \\\"id\\\": \\\"589acd9ecb3cd400fa75ac06\\\",\\n                \\\"name\\\": \\\"SynapseFI\\\"\\n            },\\n            \\\"extra\\\": {\\n                \\\"note\\\": null,\\n                \\\"other\\\": {},\\n                \\\"supp_id\\\": \\\"xx123c\\\"\\n            },\\n            \\\"info\\\": {\\n                \\\"agreements\\\": [\\n                    {\\n                        \\\"type\\\": \\\"LOAN_AGREEMENT\\\",\\n                        \\\"url\\\": \\\"https://cdn.synapsepay.com/uploads/2018/11/12/W1jc2N4YGRhtI7uHMdX8AyvOmpPFgKeoqrD3VL0xBsE0UlTzfb.pdf\\\"\\n                    }\\n                ],\\n                \\\"balance\\\": {\\n                    \\\"amount\\\": 0,\\n                    \\\"currency\\\": \\\"USD\\\"\\n                },\\n                \\\"credit_limit\\\": {\\n                    \\\"amount\\\": 500.2,\\n                    \\\"currency\\\": \\\"cUSD\\\"\\n                },\\n                \\\"disbursement_node_id\\\": \\\"5be921e1fc0a9800b696eae2\\\",\\n                \\\"document_id\\\": \\\"2a4a5957a3a62aaac1a0dd0edcae96ea2cdee688ec6337b20745eed8869e3ac8\\\",\\n                \\\"installment_amount\\\": 52.53,\\n                \\\"interest\\\": {\\n                    \\\"accrued\\\": 0,\\n                    \\\"apr\\\": 10,\\n                    \\\"cap\\\": 25.01\\n                },\\n                \\\"loan_type\\\": \\\"ONE-TIME\\\",\\n                \\\"name_on_account\\\": \\\" \\\",\\n                \\\"next_payment\\\": 1544599063691,\\n                \\\"nickname\\\": \\\"My Loan\\\",\\n                \\\"num_payments\\\": 10,\\n                \\\"payment_node_id\\\": \\\"5be921e1fc0a9800b696eae2\\\",\\n                \\\"schedule\\\": \\\"MONTHLY\\\"\\n            },\\n            \\\"is_active\\\": true,\\n            \\\"timeline\\\": [\\n                {\\n                    \\\"date\\\": 1542007063691,\\n                    \\\"note\\\": \\\"Node created.\\\"\\n                }\\n            ],\\n            \\\"type\\\": \\\"LOAN-US\\\",\\n            \\\"user_id\\\": \\\"5be921d3321f48008eac7810\\\"\\n        }\\n    ],\\n    \\\"page_count\\\": 1,\\n    \\\"success\\\": true\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Approved\"\n    },\n    {\n      \"code\": \"{\\n    \\\"error_code\\\": \\\"0\\\",\\n    \\\"http_code\\\": \\\"200\\\",\\n    \\\"limit\\\": 20,\\n    \\\"node_count\\\": 1,\\n    \\\"nodes\\\": [\\n        {\\n            \\\"_id\\\": \\\"5be92f92f8733300bb5fbf6d\\\",\\n            \\\"_links\\\": {\\n                \\\"self\\\": {\\n                    \\\"href\\\": \\\"https://uat-api.synapsefi.com/v3.1/users/5be92f2292571b00a74dcbdf/nodes/5be92f92f8733300bb5fbf6d\\\"\\n                }\\n            },\\n            \\\"allowed\\\": \\\"REJECTED\\\",\\n            \\\"client\\\": {\\n                \\\"id\\\": \\\"589acd9ecb3cd400fa75ac06\\\",\\n                \\\"name\\\": \\\"SynapseFI\\\"\\n            },\\n            \\\"extra\\\": {\\n                \\\"note\\\": \\\"The LOANTYPE amount requested is higher than what we can offer you. Your limit is 1000.\\\",\\n                \\\"other\\\": {},\\n                \\\"supp_id\\\": \\\"xx123c\\\"\\n            },\\n            \\\"info\\\": {\\n                \\\"agreements\\\": [\\n                    {\\n                        \\\"type\\\": \\\"ADVERSE_ACTION\\\",\\n                        \\\"url\\\": \\\"https://cdn.synapsepay.com/uploads/2018/11/12/U007pH16AvzLqMDSoGsJ8QTnk4FWetbXd9rEYgVyh3maNBxc2i.pdf\\\"\\n                    }\\n                ],\\n                \\\"balance\\\": {\\n                    \\\"amount\\\": 0,\\n                    \\\"currency\\\": \\\"USD\\\"\\n                },\\n                \\\"credit_limit\\\": {\\n                    \\\"amount\\\": 0,\\n                    \\\"currency\\\": \\\"USD\\\"\\n                },\\n                \\\"disbursement_node_id\\\": \\\"5be92f6efc0a9800b287029f\\\",\\n                \\\"document_id\\\": \\\"2a4a5957a3a62aaac1a0dd0edcae9\\\",\\n                \\\"installment_amount\\\": 0,\\n                \\\"interest\\\": {\\n                    \\\"accrued\\\": 0,\\n                    \\\"apr\\\": 10,\\n                    \\\"cap\\\": 0.05\\n                },\\n                \\\"loan_type\\\": \\\"ONE-TIME\\\",\\n                \\\"name_on_account\\\": \\\" \\\",\\n                \\\"next_payment\\\": null,\\n                \\\"nickname\\\": \\\"My Loan\\\",\\n                \\\"num_payments\\\": 0,\\n                \\\"payment_node_id\\\": \\\"5be92f6efc0a9800b287029f\\\",\\n                \\\"schedule\\\": \\\"MONTHLY\\\"\\n            },\\n            \\\"is_active\\\": true,\\n            \\\"timeline\\\": [\\n                {\\n                    \\\"date\\\": 1542008719334,\\n                    \\\"note\\\": \\\"Node created.\\\"\\n                }\\n            ],\\n            \\\"type\\\": \\\"LOAN-US\\\",\\n            \\\"user_id\\\": \\\"5be92f2292571b00a74dcbdf\\\"\\n        }\\n    ],\\n    \\\"page_count\\\": 1,\\n    \\\"success\\\": true\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Rejected\"\n    }\n  ]\n}\n[/block]\n##Variable APRs\nYou can also specify the APR when you create a loan object. Any APR below what has been approved by us will work as a valid input. All you would need to do is add `info.interest.apr` in %.\n\nExample:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"POST /v3.1/users/5b9ee70e04707a0067a724d5/nodes HTTP/1.1\\nHost: uat-api.synapsefi.com\\nX-SP-USER-IP: 255.127.79.76\\nX-SP-USER: oauth_F0rsnYzBpfZkNh91aERc5d|e83cf6ddcf778e37bfe3d48fc78a6502062fc\\nContent-Type: application/json\\nCache-Control: no-cache\\n\\n{\\n  \\\"type\\\": \\\"LOAN-US\\\",\\n  \\\"info\\\": {\\n  \\t\\\"loan_type\\\":\\\"ONE-TIME\\\",\\n    \\\"nickname\\\":\\\"For a Tesla Model X\\\",\\n    \\\"credit_limit\\\":{\\n    \\t\\\"amount\\\":500.2,\\n    \\t\\\"currency\\\":\\\"USD\\\"\\n    },\\n    \\\"interest\\\": {\\n    \\t\\\"apr\\\": 10\\n    },\\n    \\\"payment_node_id\\\":\\\"5bb4ea879a835600b57fb1c2\\\",\\n    \\\"disbursement_node_id\\\":\\\"5bb4ea879a835600b57fb1c2\\\",\\n    \\\"document_id\\\":\\\"2a4a5957a3a62aaac1a0dd0edcae96ea2cdee68\\\",\\n    \\\"schedule\\\":\\\"MONTHLY\\\",\\n    \\\"next_payment\\\":30,\\n    \\\"num_payments\\\":10\\n  },\\n  \\\"extra\\\":{\\n  \\t\\\"supp_id\\\":\\\"xx123c\\\"\\n  }\\n}\",\n      \"language\": \"http\"\n    }\n  ]\n}\n[/block]\nBy default, funds are automatically disbursed to the user's disbursement node. If there is no disbursement node, your platform will have to create a transaction to draw funds from the node.\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Subscribe to Webhooks\",\n  \"body\": \"We recommend that you [subscribe to webhooks](https://docs.synapsefi.com/v3.2/docs/subscribe-to-webhooks) to stay updated on the status of nodes.\"\n}\n[/block]","excerpt":"Posting a loan with SynapseFI","slug":"apply-for-a-one-time-loan","type":"basic","title":"Apply for a One-Time Loan"}

Apply for a One-Time Loan

Posting a loan with SynapseFI

After you [Create a User](https://docs.synapsefi.com/v3.2/docs/create-a-user-1) and [OAuth the User](https://docs.synapsefi.com/v3.2/docs/oauth-the-user), the user is ready to apply for a loan. Upon applying for a loan, users will know instantly if they are approved and rejected, along with rejection reason. Following are permissible reasons an application could be rejected: 1. Loan rejected because KYC is not finished. 2. Loan rejected because currently we do not issue loans for your user type. 3. Loan rejected because the requested loan amount is higher than what we currently allow. The limit *platform_limit* 4. Loan rejected because you are over the limit of loans we currently allow. The limit is *platform_limit*. 5. Loan rejected because your credit score is low. Your credit needs to be over *platform_limit*. ##Loan Program: Here are all the features you can customize on your spec sheet for a loan: [block:parameters] { "data": { "h-0": "Program Details", "h-1": "Comment", "0-0": "Agreement Delivery", "0-1": "Platform or Synapse", "1-0": "Transaction Notification", "1-1": "Platform or Synapse", "2-0": "Loan Type", "2-1": "One Time and/or Revolving", "3-0": "Credit Score", "3-1": "N/A", "4-0": "APR", "4-1": "XX%", "5-0": "Cap Amount", "5-1": "$XX", "6-0": "Max Amount per Loan", "6-1": "$XX", "7-0": "Repayment", "7-1": "Auto-Debit", "8-0": "Schedule", "8-1": "Monthly", "9-0": "Custom Rules", "9-1": "N/A", "h-2": "Details", "0-2": "You can decide if you want to send your end user the agreement or use our white labeled email notifications", "1-2": "You can decide if you want to send your end users notifications about loans or use our white labeled text message notifications", "2-2": "You can decide if you want to issue a one time loan or a revolving line of credit", "3-2": "You can factor in soft credit score pulls as part of your decision. Here you can set a minimum credit score users should have to receive a loan", "4-2": "This is the amount of interest charged on the loan that the user takes out", "5-2": "Although the APR on a loan can increase, there will be cap on the dollar amount of interest that a end user gets charged. That way the interest can only increase to a certain amount at the most", "6-2": "The maximum dollar amount that can be taken out per loan for the user.", "7-2": "This is how the user will repay their loan. Auto-debit means that the user will be automatically debited on the same day/date on a monthly schedule", "8-2": "Loan repayment can be scheduled to happen on a recurring monthly basis", "9-2": "This accounts for any additional customization that you would have for loan decisioning" }, "cols": 3, "rows": 10 } [/block] ##API ENDPOINT https://uat-api.synapsefi.com/v3.1/users/:user_id/nodes ##PATH PARAMETERS [block:html] { "html": "<div class=\"api-manager\"> <div class=\"param-table\"> <div class=\"table\"> <div class=\"tr\"> <div class=\"td param\"> <strong>user_id <span class=\"colon\">:</span> </strong> <div class=\"required\">required</div></div><div class=\"td\"> <strong class=\"param-type\">string</strong> <div marked=\"\" class=\"ng-isolate-scope\"> <p>The user ID of the user you wish to add the LOAN-US node under</p></div></div></div></div></div></div>" } [/block] ##BODY PARAMETERS [block:html] { "html": "<div class=\"api-manager\"> <div class=\"param-table\"> <div class=\"table\"> <div class=\"tr\"> <div class=\"td param\"> <strong>type <span class=\"colon\">:</span> </strong> <div class=\"required\">required</div></div><div class=\"td\"> <strong class=\"param-type\">string</strong> <div marked=\"\" class=\"ng-isolate-scope\"> <p>LOAN-US</p></div></div></div><div class=\"tr\"> <div class=\"td param\"> <strong> <span class=\"text-muted\">info.</span>loan_type <span class=\"colon\">:</span> </strong> <div class=\"required\">required</div></div><div class=\"td\"> <strong class=\"param-type\">string</strong> <div marked=\"\" class=\"ng-isolate-scope\"> <p>Type of Loan (`ONE-TIME`)</p></div></div></div><div class=\"tr\"> <div class=\"td param\"> <strong> <span class=\"text-muted\">info.</span>nickname <span class=\"colon\">:</span> </strong> </div><div class=\"td\"> <strong class=\"param-type\">string</strong> <div marked=\"\" class=\"ng-isolate-scope\"> <p>nickname of the loan account</p></div></div></div><div class=\"tr\"> <div class=\"td param\"> <strong> <span class=\"text-muted\">info.credit_limit.</span>amount <span class=\"colon\">:</span> </strong> <div class=\"required\">required</div></div><div class=\"td\"> <strong class=\"param-type\">float</strong> <div marked=\"\" class=\"ng-isolate-scope\"> <p>limit of how much money can be borrowed out of this loan account</p></div></div></div><div class=\"tr\"> <div class=\"td param\"> <strong> <span class=\"text-muted\">info.credit_limit.</span>currency <span class=\"colon\">:</span> </strong> <div class=\"required\">required</div></div><div class=\"td\"> <strong class=\"param-type\">string</strong> <div marked=\"\" class=\"ng-isolate-scope\"> <p>currency of the loan account</p></div></div></div><div class=\"tr\"> <div class=\"td param\"> <strong> <span class=\"text-muted\">info.interest.</span>apr <span class=\"colon\">:</span> </strong></div><div class=\"td\"> <strong class=\"param-type\">float</strong> <div marked=\"\" class=\"ng-isolate-scope\"> <p>APR on the loan in percentage</p></div></div></div><div class=\"tr\"> <div class=\"td param\"> <strong> <span class=\"text-muted\">info.interest.</span>cap <span class=\"colon\">:</span> </strong></div><div class=\"td\"> <strong class=\"param-type\">float</strong> <div marked=\"\" class=\"ng-isolate-scope\"> <p>Max interest that will be charged on the loan in USD.</p></div></div></div><div class=\"tr\"> <div class=\"td param\"> <strong> <span class=\"text-muted\">info.</span>payment_node_id <span class=\"colon\">:</span> </strong></div><div class=\"td\"> <strong class=\"param-type\">string</strong> <div marked=\"\" class=\"ng-isolate-scope\"> <p>node ID of where we will collect payments from</p></div></div></div><div class=\"tr\"> <div class=\"td param\"> <strong> <span class=\"text-muted\">info.</span>disbursement_node_id: <span class=\"colon\"></span> </strong></div><div class=\"td\"> <strong class=\"param-type\">string</strong> <div marked=\"\" class=\"ng-isolate-scope\"> <p>node id of where the funds will be disbursed to.</p></div></div></div><div class=\"tr\"> <div class=\"td param\"> <strong> <span class=\"text-muted\">info.</span>document_id <span class=\"colon\">:</span> </strong> <div class=\"required\">required</div></div><div class=\"td\"> <strong class=\"param-type\">string</strong> <div marked=\"\" class=\"ng-isolate-scope\"> <p>KYC document ID of the user</p></div></div></div><div class=\"tr\"> <div class=\"td param\"> <strong> <span class=\"text-muted\">info.</span>schedule <span class=\"colon\">:</span> </strong> <div class=\"required\">required</div></div><div class=\"td\"> <strong class=\"param-type\">string</strong> <div marked=\"\" class=\"ng-isolate-scope\"> <p>Payment schedule. All schedules are listed below</p></div></div></div><div class=\"tr\"> <div class=\"td param\"> <strong> <span class=\"text-muted\">info.</span>next_payment <span class=\"colon\">:</span> </strong></div><div class=\"td\"> <strong class=\"param-type\">long</strong> <div marked=\"\" class=\"ng-isolate-scope\"> <p>when the next payment is due. In unixtime (milliseconds)</p></div></div></div><div class=\"tr\"> <div class=\"td param\"> <strong> <span class=\"text-muted\">info.</span>num_payments <span class=\"colon\">:</span> </strong></div><div class=\"td\"> <strong class=\"param-type\">long</strong> <div marked=\"\" class=\"ng-isolate-scope\"> <p>Number of payments due</p></div></div></div><div class=\"tr\"> <div class=\"td param\"> <strong> <span class=\"text-muted\">info.</span>installment_amount <span class=\"colon\">:</span> </strong></div><div class=\"td\"> <strong class=\"param-type\">float</strong> <div marked=\"\" class=\"ng-isolate-scope\"> <p>amount for each payment installment.</p></div></div></div><div class=\"tr\"> <div class=\"td param\"> <strong> <span class=\"text-muted\">extra.</span>supp_id <span class=\"colon\">:</span> </strong> </div><div class=\"td\"> <strong class=\"param-type\">string</strong> <div marked=\"\" class=\"ng-isolate-scope\"> <p>Supplement id for node</p></div></div></div></div></div></div>" } [/block] ##Example Request Applying for a loan is a `POST` API call to a Node. [block:code] { "codes": [ { "code": "POST /v3.1/users/5b9ee70e04707a0067a724d5/nodes HTTP/1.1\nHost: uat-api.synapsefi.com\nX-SP-USER-IP: 255.127.79.76\nX-SP-USER: oauth_F0rsnYzBpfZkNh91aERc5d|e83cf6ddcf778e37bfe3d48fc78a6502062fc\nContent-Type: application/json\nCache-Control: no-cache\n\n{\n \"type\": \"LOAN-US\",\n \"info\": {\n \t\"loan_type\":\"ONE-TIME\",\n \"nickname\":\"My Loan\",\n \"credit_limit\":{\n \t\"amount\":500.2,\n \t\"currency\":\"USD\"\n },\n \"payment_node_id\":\"5be9296c4408930090ac92d2\",\n \"disbursement_node_id\":\"5be9296c4408930090ac92d2\",\n \"document_id\":\"2a4a5957a3a62aaac1a0dd0edcae96ea2c\",\n \"schedule\":\"MONTHLY\",\n \"next_payment\":30,\n \"num_payments\":10\n },\n \"extra\":{\n \t\"supp_id\":\"xx123c\"\n }\n}", "language": "http" }, { "code": "curl -X POST \\\n https://uat-api.synapsefi.com/v3.1/users/5be9295b92571b00a74dc9c9/nodes \\\n -H 'Content-Type: application/json' \\\n -H 'X-SP-USER: oauth_QAdymv3UWO04u2kEXPV|e83cf6ddcf778e37' \\\n -H 'X-SP-USER-IP: 255.127.79.76' \\\n -d '{\n \"type\": \"LOAN-US\",\n \"info\": {\n \t\"loan_type\":\"ONE-TIME\",\n \"nickname\":\"My Loan\",\n \"credit_limit\":{\n \t\"amount\":500.2,\n \t\"currency\":\"USD\"\n },\n \"payment_node_id\":\"5be9296c4408930090ac92d2\",\n \"disbursement_node_id\":\"5be9296c4408930090ac92d2\",\n \"document_id\":\"2a4a5957a3a62aaac1a0dd0edcae\",\n \"schedule\":\"MONTHLY\",\n \"next_payment\":30,\n \"num_payments\":10\n },\n \"extra\":{\n \t\"supp_id\":\"xx123c\"\n }\n}'", "language": "curl" } ] } [/block] ##Examples Responses: [block:code] { "codes": [ { "code": "{\n \"error_code\": \"0\",\n \"http_code\": \"200\",\n \"limit\": 20,\n \"node_count\": 1,\n \"nodes\": [\n {\n \"_id\": \"5be9291d440893008eac92c4\",\n \"_links\": {\n \"self\": {\n \"href\": \"https://uat-api.synapsefi.com/v3.1/users/5be921d3321f48008eac7810/nodes/5be9291d440893008eac92c4\"\n }\n },\n \"allowed\": \"CREDIT\",\n \"client\": {\n \"id\": \"589acd9ecb3cd400fa75ac06\",\n \"name\": \"SynapseFI\"\n },\n \"extra\": {\n \"note\": null,\n \"other\": {},\n \"supp_id\": \"xx123c\"\n },\n \"info\": {\n \"agreements\": [\n {\n \"type\": \"LOAN_AGREEMENT\",\n \"url\": \"https://cdn.synapsepay.com/uploads/2018/11/12/W1jc2N4YGRhtI7uHMdX8AyvOmpPFgKeoqrD3VL0xBsE0UlTzfb.pdf\"\n }\n ],\n \"balance\": {\n \"amount\": 0,\n \"currency\": \"USD\"\n },\n \"credit_limit\": {\n \"amount\": 500.2,\n \"currency\": \"cUSD\"\n },\n \"disbursement_node_id\": \"5be921e1fc0a9800b696eae2\",\n \"document_id\": \"2a4a5957a3a62aaac1a0dd0edcae96ea2cdee688ec6337b20745eed8869e3ac8\",\n \"installment_amount\": 52.53,\n \"interest\": {\n \"accrued\": 0,\n \"apr\": 10,\n \"cap\": 25.01\n },\n \"loan_type\": \"ONE-TIME\",\n \"name_on_account\": \" \",\n \"next_payment\": 1544599063691,\n \"nickname\": \"My Loan\",\n \"num_payments\": 10,\n \"payment_node_id\": \"5be921e1fc0a9800b696eae2\",\n \"schedule\": \"MONTHLY\"\n },\n \"is_active\": true,\n \"timeline\": [\n {\n \"date\": 1542007063691,\n \"note\": \"Node created.\"\n }\n ],\n \"type\": \"LOAN-US\",\n \"user_id\": \"5be921d3321f48008eac7810\"\n }\n ],\n \"page_count\": 1,\n \"success\": true\n}", "language": "json", "name": "Approved" }, { "code": "{\n \"error_code\": \"0\",\n \"http_code\": \"200\",\n \"limit\": 20,\n \"node_count\": 1,\n \"nodes\": [\n {\n \"_id\": \"5be92f92f8733300bb5fbf6d\",\n \"_links\": {\n \"self\": {\n \"href\": \"https://uat-api.synapsefi.com/v3.1/users/5be92f2292571b00a74dcbdf/nodes/5be92f92f8733300bb5fbf6d\"\n }\n },\n \"allowed\": \"REJECTED\",\n \"client\": {\n \"id\": \"589acd9ecb3cd400fa75ac06\",\n \"name\": \"SynapseFI\"\n },\n \"extra\": {\n \"note\": \"The LOANTYPE amount requested is higher than what we can offer you. Your limit is 1000.\",\n \"other\": {},\n \"supp_id\": \"xx123c\"\n },\n \"info\": {\n \"agreements\": [\n {\n \"type\": \"ADVERSE_ACTION\",\n \"url\": \"https://cdn.synapsepay.com/uploads/2018/11/12/U007pH16AvzLqMDSoGsJ8QTnk4FWetbXd9rEYgVyh3maNBxc2i.pdf\"\n }\n ],\n \"balance\": {\n \"amount\": 0,\n \"currency\": \"USD\"\n },\n \"credit_limit\": {\n \"amount\": 0,\n \"currency\": \"USD\"\n },\n \"disbursement_node_id\": \"5be92f6efc0a9800b287029f\",\n \"document_id\": \"2a4a5957a3a62aaac1a0dd0edcae9\",\n \"installment_amount\": 0,\n \"interest\": {\n \"accrued\": 0,\n \"apr\": 10,\n \"cap\": 0.05\n },\n \"loan_type\": \"ONE-TIME\",\n \"name_on_account\": \" \",\n \"next_payment\": null,\n \"nickname\": \"My Loan\",\n \"num_payments\": 0,\n \"payment_node_id\": \"5be92f6efc0a9800b287029f\",\n \"schedule\": \"MONTHLY\"\n },\n \"is_active\": true,\n \"timeline\": [\n {\n \"date\": 1542008719334,\n \"note\": \"Node created.\"\n }\n ],\n \"type\": \"LOAN-US\",\n \"user_id\": \"5be92f2292571b00a74dcbdf\"\n }\n ],\n \"page_count\": 1,\n \"success\": true\n}", "language": "json", "name": "Rejected" } ] } [/block] ##Variable APRs You can also specify the APR when you create a loan object. Any APR below what has been approved by us will work as a valid input. All you would need to do is add `info.interest.apr` in %. Example: [block:code] { "codes": [ { "code": "POST /v3.1/users/5b9ee70e04707a0067a724d5/nodes HTTP/1.1\nHost: uat-api.synapsefi.com\nX-SP-USER-IP: 255.127.79.76\nX-SP-USER: oauth_F0rsnYzBpfZkNh91aERc5d|e83cf6ddcf778e37bfe3d48fc78a6502062fc\nContent-Type: application/json\nCache-Control: no-cache\n\n{\n \"type\": \"LOAN-US\",\n \"info\": {\n \t\"loan_type\":\"ONE-TIME\",\n \"nickname\":\"For a Tesla Model X\",\n \"credit_limit\":{\n \t\"amount\":500.2,\n \t\"currency\":\"USD\"\n },\n \"interest\": {\n \t\"apr\": 10\n },\n \"payment_node_id\":\"5bb4ea879a835600b57fb1c2\",\n \"disbursement_node_id\":\"5bb4ea879a835600b57fb1c2\",\n \"document_id\":\"2a4a5957a3a62aaac1a0dd0edcae96ea2cdee68\",\n \"schedule\":\"MONTHLY\",\n \"next_payment\":30,\n \"num_payments\":10\n },\n \"extra\":{\n \t\"supp_id\":\"xx123c\"\n }\n}", "language": "http" } ] } [/block] By default, funds are automatically disbursed to the user's disbursement node. If there is no disbursement node, your platform will have to create a transaction to draw funds from the node. [block:callout] { "type": "info", "title": "Subscribe to Webhooks", "body": "We recommend that you [subscribe to webhooks](https://docs.synapsefi.com/v3.2/docs/subscribe-to-webhooks) to stay updated on the status of nodes." } [/block]