{"_id":"5bc417b1cf6319000ead62fc","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":"5bc417751d1b0000182bf7f6","project":"59f79e3c584eb200345ceafc","version":"5ba178b00a916500030c6a21","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2018-10-15T04:28:37.853Z","from_sync":false,"order":13,"slug":"custody-accounts","title":"Custody Accounts"},"user":"5bbfef1d7d1cb0000384bec5","__v":0,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2018-10-15T04:29:37.534Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":0,"body":"With our custody product, platforms can issue accounts on behalf of users, where funds are held by a third party trustee. These accounts are denoted as `CUSTODY-US` in our system.\n\nCustody accounts are a great choice for platforms that want to avoid being in the flow of funds. These accounts are similar to a clearing account but allow you to ledger fund ownership. These accounts are also great for platforms attempting crowdfunding, or those that want to develop a custom escrow account. Custody accounts are also fully insured by FDIC up to $250,000.\n\nUnlike Deposit accounts, custody accounts also have light-weight KYC requirements similar to that of subaccounts (within a platform's FBO account). Standard KYC includes a user's base document, plus phone number and email 2FA if we were unable to verify phone number and email.\n\n##Node Type\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"CUSTODY-US\",\n    \"0-1\": \"CREDIT-AND-DEBIT\",\n    \"h-0\": \"Type\",\n    \"h-1\": \"Default Permissions\",\n    \"0-2\": \"A custody account held in the name of our partner bank's trust department that functions like a deposit account. FDIC insured.\",\n    \"h-2\": \"Comment\"\n  },\n  \"cols\": 3,\n  \"rows\": 1\n}\n[/block]\n##NODE STRUCTURE\n\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>_id<span class=\\\"colon\\\">:</span></strong></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">string</strong><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>Object ID of the node</p>\\n</div></div></div><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong><span class=\\\"text-muted\\\">_links.self.</span>href<span class=\\\"colon\\\">:</span></strong></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">string</strong><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>HAL style link for the node</p>\\n</div></div></div><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong>allowed<span class=\\\"colon\\\">:</span></strong></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">string</strong><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>Denotes the account standing. Look at the <a href=\\\"#section-node-permissions\\\">node permissions</a> section below to learn more</p>\\n</div></div></div><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong><span class=\\\"text-muted\\\">client.</span>id<span class=\\\"colon\\\">:</span></strong></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">string</strong><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>ID of the client that created the node</p>\\n</div></div></div><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong><span class=\\\"text-muted\\\">client.</span>name<span class=\\\"colon\\\">:</span></strong></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">string</strong><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>Name of the client that created the node</p>\\n</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>Any nickname/common name given to the node. Eg. Savings Node</p>\\n</div></div></div><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong><span class=\\\"text-muted\\\">info.</span>name_on_account<span class=\\\"colon\\\">:</span></strong></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">string</strong><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>[Deprecated] Name of the user who owns the node</p>\\n</div></div></div><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong><span class=\\\"text-muted\\\">info.balance.</span>amount<span class=\\\"colon\\\">:</span></strong></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">double</strong><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>Balance associated with the node.</p>\\n</div></div></div><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong><span class=\\\"text-muted\\\">info.balance.</span>currency<span class=\\\"colon\\\">:</span></strong></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">string</strong><span class=\\\"param-default text-muted\\\">USD</span><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>Currency of the node</p>\\n</div></div></div><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong>type<span class=\\\"colon\\\">:</span></strong></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">string</strong><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>Type of node</p>\\n</div></div></div><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong>timeline<span class=\\\"colon\\\">:</span></strong></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">array of objects</strong><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>Array that tracks node updates as they occur</p>\\n</div></div></div><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong>is_active<span class=\\\"colon\\\">:</span></strong></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">boolean</strong><span class=\\\"param-default text-muted\\\">true</span><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>If the node is indexed or marked deleted.</p>\\n</div></div></div><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong>user_id<span class=\\\"colon\\\">:</span></strong></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">string</strong><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>ID of the user who owns the node</p>\\n</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>Any supplied ID given by the client that created the node</p>\\n</div></div></div></div></div></div>\"\n}\n[/block]\n##Node Permissions\nEvery account has the following permissions associated with them:\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"PERMISSION\",\n    \"h-1\": \"COMMENT\",\n    \"0-0\": \"CREDIT-AND-DEBIT\",\n    \"1-0\": \"INACTIVE\",\n    \"2-0\": \"LOCKED\",\n    \"0-1\": \"Node can be used for sending or receiving funds\",\n    \"1-1\": \"Node has been disabled and cannot be used for any transactions\",\n    \"2-1\": \"Node has been locked and cannot be used for any transactions. This can be used in the case of fraudulent activity\"\n  },\n  \"cols\": 2,\n  \"rows\": 3\n}\n[/block]","excerpt":"Custody account resources","slug":"custody-accounts-intro","type":"basic","title":"Custody Account Intro"}

Custody Account Intro

Custody account resources

With our custody product, platforms can issue accounts on behalf of users, where funds are held by a third party trustee. These accounts are denoted as `CUSTODY-US` in our system. Custody accounts are a great choice for platforms that want to avoid being in the flow of funds. These accounts are similar to a clearing account but allow you to ledger fund ownership. These accounts are also great for platforms attempting crowdfunding, or those that want to develop a custom escrow account. Custody accounts are also fully insured by FDIC up to $250,000. Unlike Deposit accounts, custody accounts also have light-weight KYC requirements similar to that of subaccounts (within a platform's FBO account). Standard KYC includes a user's base document, plus phone number and email 2FA if we were unable to verify phone number and email. ##Node Type [block:parameters] { "data": { "0-0": "CUSTODY-US", "0-1": "CREDIT-AND-DEBIT", "h-0": "Type", "h-1": "Default Permissions", "0-2": "A custody account held in the name of our partner bank's trust department that functions like a deposit account. FDIC insured.", "h-2": "Comment" }, "cols": 3, "rows": 1 } [/block] ##NODE STRUCTURE [block:html] { "html": "<div class=\"api-manager\"><div class=\"param-table\"><div class=\"table\"><div class=\"tr\"><div class=\"td param\"><strong>_id<span class=\"colon\">:</span></strong></div><div class=\"td\"><strong class=\"param-type\">string</strong><div marked=\"\" class=\"ng-isolate-scope\"><p>Object ID of the node</p>\n</div></div></div><div class=\"tr\"><div class=\"td param\"><strong><span class=\"text-muted\">_links.self.</span>href<span class=\"colon\">:</span></strong></div><div class=\"td\"><strong class=\"param-type\">string</strong><div marked=\"\" class=\"ng-isolate-scope\"><p>HAL style link for the node</p>\n</div></div></div><div class=\"tr\"><div class=\"td param\"><strong>allowed<span class=\"colon\">:</span></strong></div><div class=\"td\"><strong class=\"param-type\">string</strong><div marked=\"\" class=\"ng-isolate-scope\"><p>Denotes the account standing. Look at the <a href=\"#section-node-permissions\">node permissions</a> section below to learn more</p>\n</div></div></div><div class=\"tr\"><div class=\"td param\"><strong><span class=\"text-muted\">client.</span>id<span class=\"colon\">:</span></strong></div><div class=\"td\"><strong class=\"param-type\">string</strong><div marked=\"\" class=\"ng-isolate-scope\"><p>ID of the client that created the node</p>\n</div></div></div><div class=\"tr\"><div class=\"td param\"><strong><span class=\"text-muted\">client.</span>name<span class=\"colon\">:</span></strong></div><div class=\"td\"><strong class=\"param-type\">string</strong><div marked=\"\" class=\"ng-isolate-scope\"><p>Name of the client that created the node</p>\n</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>Any nickname/common name given to the node. Eg. Savings Node</p>\n</div></div></div><div class=\"tr\"><div class=\"td param\"><strong><span class=\"text-muted\">info.</span>name_on_account<span class=\"colon\">:</span></strong></div><div class=\"td\"><strong class=\"param-type\">string</strong><div marked=\"\" class=\"ng-isolate-scope\"><p>[Deprecated] Name of the user who owns the node</p>\n</div></div></div><div class=\"tr\"><div class=\"td param\"><strong><span class=\"text-muted\">info.balance.</span>amount<span class=\"colon\">:</span></strong></div><div class=\"td\"><strong class=\"param-type\">double</strong><div marked=\"\" class=\"ng-isolate-scope\"><p>Balance associated with the node.</p>\n</div></div></div><div class=\"tr\"><div class=\"td param\"><strong><span class=\"text-muted\">info.balance.</span>currency<span class=\"colon\">:</span></strong></div><div class=\"td\"><strong class=\"param-type\">string</strong><span class=\"param-default text-muted\">USD</span><div marked=\"\" class=\"ng-isolate-scope\"><p>Currency of the node</p>\n</div></div></div><div class=\"tr\"><div class=\"td param\"><strong>type<span class=\"colon\">:</span></strong></div><div class=\"td\"><strong class=\"param-type\">string</strong><div marked=\"\" class=\"ng-isolate-scope\"><p>Type of node</p>\n</div></div></div><div class=\"tr\"><div class=\"td param\"><strong>timeline<span class=\"colon\">:</span></strong></div><div class=\"td\"><strong class=\"param-type\">array of objects</strong><div marked=\"\" class=\"ng-isolate-scope\"><p>Array that tracks node updates as they occur</p>\n</div></div></div><div class=\"tr\"><div class=\"td param\"><strong>is_active<span class=\"colon\">:</span></strong></div><div class=\"td\"><strong class=\"param-type\">boolean</strong><span class=\"param-default text-muted\">true</span><div marked=\"\" class=\"ng-isolate-scope\"><p>If the node is indexed or marked deleted.</p>\n</div></div></div><div class=\"tr\"><div class=\"td param\"><strong>user_id<span class=\"colon\">:</span></strong></div><div class=\"td\"><strong class=\"param-type\">string</strong><div marked=\"\" class=\"ng-isolate-scope\"><p>ID of the user who owns the node</p>\n</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>Any supplied ID given by the client that created the node</p>\n</div></div></div></div></div></div>" } [/block] ##Node Permissions Every account has the following permissions associated with them: [block:parameters] { "data": { "h-0": "PERMISSION", "h-1": "COMMENT", "0-0": "CREDIT-AND-DEBIT", "1-0": "INACTIVE", "2-0": "LOCKED", "0-1": "Node can be used for sending or receiving funds", "1-1": "Node has been disabled and cannot be used for any transactions", "2-1": "Node has been locked and cannot be used for any transactions. This can be used in the case of fraudulent activity" }, "cols": 2, "rows": 3 } [/block]