{"_id":"5ba178b00a916500030c69bf","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":"5ba178b00a916500030c69aa","project":"59f79e3c584eb200345ceafc","version":"5ba178b00a916500030c6a21","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2017-09-21T23:56:39.346Z","from_sync":false,"order":22,"slug":"ui-as-a-service","title":"UI as a Service"},"user":"54e4044e8ef7552300409dcb","__v":0,"parentDoc":null,"githubsync":"","updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-09-22T00:37:24.756Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":2,"body":"Our bank logins UI tool is a quick way to link a bank account without building your own UI. View our [bank logins demo](https://uat-uiaas.synapsefi.com/link?oauth_key=oauth_y4NKwCgfj2QF1svkoV5pqHuU7Im8OXaxZTAtd0hL&public_key=public_key_n7YOZjuGemJ9cPWBKQLNMH2h0iaU1X0v5CrdgAIx). Setup instructions are below:\n\n1. Issue Public Key: Issue a  [public key](doc:issuing-public-key) with scope `CLIENT|CONTROLS`.\n\n2. Issue OAuth Key: Issue an [OAuth Key](doc:get-oauth_key-refresh-token) for the user, with scopes `USER|GET`, `NODES|GET`, `NODES|POST`, `NODE|PATCH`.\n\n3. Create the URL with the public and Oauth keys.\nEx: https://uat-uiaas.synapsefi.com/link?oauth_key=oauth_key&public_key=public_key\n\n4. Test the UI to ensure everything is rendering properly.\nTest in Sandbox: https://uat-uiaas.synapsefi.com/link\nTest in Production: https://uiaas.synapsefi.com/link\n\n##GET Params needed in the URL\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"GET Param\",\n    \"h-1\": \"Note\",\n    \"0-0\": \"oauth_key\",\n    \"1-0\": \"public_key\",\n    \"0-1\": \"OAuth key of the user who needs to link new accounts\",\n    \"1-1\": \"Your public key\"\n  },\n  \"cols\": 2,\n  \"rows\": 2\n}\n[/block]\nThe final URL would look something like this:\n\nhttps://uat-uiaas.synapsefi.com/link?oauth_key=oauth_key&public_key=public_key.\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Android webviews\",\n  \"body\": \"If you are rendering this component inside an Android webview, please make sure that you have DOM storage enabled `settings.setDomStorageEnabled(true);`\"\n}\n[/block]\n\n[block:api-header]\n{}\n[/block]\n## GET Params on redirect\n\nGET Params returned on `success_uri`:\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"GET Param\",\n    \"h-1\": \"Note\",\n    \"0-0\": \"user_id\",\n    \"0-1\": \"Synapse ID of the user\"\n  },\n  \"cols\": 2,\n  \"rows\": 1\n}\n[/block]\nGET Params returned on `failure_uri`:\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"GET Param\",\n    \"h-1\": \"Note\",\n    \"0-0\": \"error_code\",\n    \"1-0\": \"http_code\",\n    \"2-0\": \"message\",\n    \"3-0\": \"user_id\",\n    \"0-1\": \"Error code from [Errors Section](doc:errors)\",\n    \"1-1\": \"HTTP code from [Errors Section](doc:errors)\",\n    \"2-1\": \"Reason for failure\",\n    \"3-1\": \"Synapse ID of the user\"\n  },\n  \"cols\": 2,\n  \"rows\": 4\n}\n[/block]\n\n[block:api-header]\n{}\n[/block]\n## Customizing the UI\n\nYou can customize the following things on the UI. If you wish to change any of these fields, please go to [Client Manager](https://help.synapsefi.com/hc/en-us/articles/215602077-Creating-a-production-account) on the dashboard to do so.\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field\",\n    \"h-1\": \"Comment\",\n    \"0-0\": \"Color Palette\",\n    \"0-1\": \"You can update the color with any hex value. By default it uses our [colors](https://synapsefi.com/resources#colors)\",\n    \"2-0\": \"Disclosure\",\n    \"2-1\": \"The footer disclosure text can be modified. By default it says **Banking services are provided by Evolve Bank and Trust; Members FDIC.**\",\n    \"3-0\": \"Legal Agreements\",\n    \"3-1\": \"Any bank login privacy agreements that you want the user to agree to while logging into a bank. By default the user agrees to our [Website Terms of Use](https://synapsefi.com/website-terms-of-use) and our [Privacy Policy](https://synapsefi.com/privacy)\",\n    \"1-0\": \"Logo\",\n    \"1-1\": \"Any landscape logo (recommended: 1388 × 367 pixels). By default it uses [our logo](https://synapsefi.com/resources#logos)\",\n    \"4-0\": \"Success URI\",\n    \"5-0\": \"Failure URI\",\n    \"4-1\": \"Once login is successful where should we redirect the user\",\n    \"5-1\": \"If login fails or user wants to abandon the login, where should we redirect the user\"\n  },\n  \"cols\": 2,\n  \"rows\": 6\n}\n[/block]","excerpt":"Bank Logins UI is a simple user interface built on top of our Bank Login API.","slug":"bank-logins","type":"basic","title":"Bank Logins UI"}

Bank Logins UI

Bank Logins UI is a simple user interface built on top of our Bank Login API.

Our bank logins UI tool is a quick way to link a bank account without building your own UI. View our [bank logins demo](https://uat-uiaas.synapsefi.com/link?oauth_key=oauth_y4NKwCgfj2QF1svkoV5pqHuU7Im8OXaxZTAtd0hL&public_key=public_key_n7YOZjuGemJ9cPWBKQLNMH2h0iaU1X0v5CrdgAIx). Setup instructions are below: 1. Issue Public Key: Issue a [public key](doc:issuing-public-key) with scope `CLIENT|CONTROLS`. 2. Issue OAuth Key: Issue an [OAuth Key](doc:get-oauth_key-refresh-token) for the user, with scopes `USER|GET`, `NODES|GET`, `NODES|POST`, `NODE|PATCH`. 3. Create the URL with the public and Oauth keys. Ex: https://uat-uiaas.synapsefi.com/link?oauth_key=oauth_key&public_key=public_key 4. Test the UI to ensure everything is rendering properly. Test in Sandbox: https://uat-uiaas.synapsefi.com/link Test in Production: https://uiaas.synapsefi.com/link ##GET Params needed in the URL [block:parameters] { "data": { "h-0": "GET Param", "h-1": "Note", "0-0": "oauth_key", "1-0": "public_key", "0-1": "OAuth key of the user who needs to link new accounts", "1-1": "Your public key" }, "cols": 2, "rows": 2 } [/block] The final URL would look something like this: https://uat-uiaas.synapsefi.com/link?oauth_key=oauth_key&public_key=public_key. [block:callout] { "type": "info", "title": "Android webviews", "body": "If you are rendering this component inside an Android webview, please make sure that you have DOM storage enabled `settings.setDomStorageEnabled(true);`" } [/block] [block:api-header] {} [/block] ## GET Params on redirect GET Params returned on `success_uri`: [block:parameters] { "data": { "h-0": "GET Param", "h-1": "Note", "0-0": "user_id", "0-1": "Synapse ID of the user" }, "cols": 2, "rows": 1 } [/block] GET Params returned on `failure_uri`: [block:parameters] { "data": { "h-0": "GET Param", "h-1": "Note", "0-0": "error_code", "1-0": "http_code", "2-0": "message", "3-0": "user_id", "0-1": "Error code from [Errors Section](doc:errors)", "1-1": "HTTP code from [Errors Section](doc:errors)", "2-1": "Reason for failure", "3-1": "Synapse ID of the user" }, "cols": 2, "rows": 4 } [/block] [block:api-header] {} [/block] ## Customizing the UI You can customize the following things on the UI. If you wish to change any of these fields, please go to [Client Manager](https://help.synapsefi.com/hc/en-us/articles/215602077-Creating-a-production-account) on the dashboard to do so. [block:parameters] { "data": { "h-0": "Field", "h-1": "Comment", "0-0": "Color Palette", "0-1": "You can update the color with any hex value. By default it uses our [colors](https://synapsefi.com/resources#colors)", "2-0": "Disclosure", "2-1": "The footer disclosure text can be modified. By default it says **Banking services are provided by Evolve Bank and Trust; Members FDIC.**", "3-0": "Legal Agreements", "3-1": "Any bank login privacy agreements that you want the user to agree to while logging into a bank. By default the user agrees to our [Website Terms of Use](https://synapsefi.com/website-terms-of-use) and our [Privacy Policy](https://synapsefi.com/privacy)", "1-0": "Logo", "1-1": "Any landscape logo (recommended: 1388 × 367 pixels). By default it uses [our logo](https://synapsefi.com/resources#logos)", "4-0": "Success URI", "5-0": "Failure URI", "4-1": "Once login is successful where should we redirect the user", "5-1": "If login fails or user wants to abandon the login, where should we redirect the user" }, "cols": 2, "rows": 6 } [/block]