{"_id":"5be0f0ef673aee00194e26dc","project":"59f79e3c584eb200345ceafc","version":{"_id":"59f79e3c584eb200345ceaff","project":"59f79e3c584eb200345ceafc","__v":8,"createdAt":"2015-09-17T03:47:20.956Z","releaseDate":"2015-09-17T03:47:20.956Z","categories":["59f79e3c584eb200345ceb3a","59f79e3c584eb200345ceb3b","59f79e3c584eb200345ceb3c","59f79e3c584eb200345ceb3d","59f79e3c584eb200345ceb3e","59f79e3c584eb200345ceb3f","59f79e3c584eb200345ceb45","59f79e3c584eb200345ceb46","59f79e3c584eb200345ceb48","59f79e3c584eb200345ceb49","5aa21b60c0bda0002d1568b6","5afb6888212c690003ae3d3b","5b4bdcd3737d1800031d2293","5b9ed89212362100036b5a1c","5bb29bec77c22500034757ea","5bb29bfe77c22500034757ec","5bc8fa8063924c00186c5ded","5bc8fe9fa472190014a6b103"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"3.1.0","version":"3.1"},"category":{"_id":"59f79e3c584eb200345ceb3b","version":"59f79e3c584eb200345ceaff","project":"59f79e3c584eb200345ceafc","__v":0,"sync":{"url":"","isSync":false},"reference":true,"createdAt":"2015-06-06T05:42:37.534Z","from_sync":false,"order":3,"slug":"users","title":"Users"},"user":"5557e76e512c300d007730d1","__v":0,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2018-11-06T01:39:59.857Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":true,"order":20,"body":"This API call allows you to automatically create and upload an Ultimate Beneficial Ownership (UBO) and REG GG form as a physical document under the Business’s base document. This physical document is called `REG_GG`.\n\n**What is this form?** \nTo help the government fight financial crime, Federal regulations require that we obtain, verify, and record information about the beneficial owners of businesses opening deposit accounts. Requiring beneficial owner & key individual information helps law enforcement investigate and prosecute crimes, such as terrorist financing, money laundering, tax evasion, corruption, fraud, and other financial crimes.\n\t\t\t\t\n**What information do I need to provide?**\nWhen you open a new deposit account `DEPOSIT-US` on behalf of a business, we ask for beneficial owner information. Beneficial owners are:\n\n1. Each individual, if any, who owns, directly or indirectly, 10 percent or more of the equity interests of the legal entity customer (e.g., each natural person that owns 10 percent or more of the shares of a corporation; and\n2. An individual with significant responsibility for managing the legal entity customer (e.g., a Chief Executive Officer, Chief Financial Officer, Chief Operating Officer, Managing Member, General Partner, President, Vice President, or Treasurer).\n\nThe number of individuals that satisfy this definition of “beneficial owner” may vary. Up to ten individuals (but as few as zero) may need to be identified. Regardless of the number of individuals identified, you must provide the identifying information of at least one controlling person. In some cases, the beneficial owner is also the controlling person.\n\n##API ENDPOINT\nhttps://uat-api.synapsefi.com/v3.1/users/:user_id/ubo\n\n##PATH PARAMETER\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 retrieve</p></div></div></div></div></div></div>\"\n}\n[/block]\n##BODY PARAMETER\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> <span class=\\\"text-muted\\\">signer.</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>Document ID of individual completing the form</p></div></div></div><div class=\\\"tr\\\"> <div class=\\\"td param\\\"> <strong> <span class=\\\"text-muted\\\">signer.</span>relationship_to_entity:<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>Signer's title at the business</p></div></div></div><div class=\\\"tr\\\"> <div class=\\\"td param\\\"> <strong> <span class=\\\"text-muted\\\">entity_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>Document ID of business opening DEPOSIT-US Account</p></div></div></div><div class=\\\"tr\\\"> <div class=\\\"td param\\\"> <strong> <span class=\\\"text-muted\\\">entity_info.</span>gamble <span class=\\\"colon\\\">:</span> </strong> <div class=\\\"required\\\">required</div></div><div class=\\\"td\\\"> <strong class=\\\"param-type\\\">boolean</strong> <div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"> <p>FALSE if business does not engage in the internet gambling business</p></div></div></div><div class=\\\"tr\\\"> <div class=\\\"td param\\\"> <strong> <span class=\\\"text-muted\\\">primary_controlling_contact.</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>Document ID of business’s primary controlling contact. This is typically an executive officer or senior manager (ex: CEO or CFO) OR an individual who regularly performs similar functions</p></div></div></div><div class=\\\"tr\\\"> <div class=\\\"td param\\\"> <strong> <span class=\\\"text-muted\\\">primary_controlling_contact.</span>relationship_to_entity <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>Primary controlling contact's title at the business</p></div></div></div><div class=\\\"tr\\\"> <div class=\\\"td param\\\"> <strong> <span class=\\\"text-muted\\\">compliance_contact.</span>relationship_to_entity <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>Compliance contact's title at the business</p></div></div></div><div class=\\\"tr\\\"> <div class=\\\"td param\\\"> <strong> <span class=\\\"text-muted\\\">compliance_contact.</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>Document ID of business’s compliance contact</p></div></div></div><div class=\\\"tr\\\"> <div class=\\\"td param\\\"> <strong> <span class=\\\"text-muted\\\">entity_info.</span>cryptocurrency <span class=\\\"colon\\\">:</span> </strong> </div><div class=\\\"td\\\"> <strong class=\\\"param-type\\\">boolean</strong> <div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"> <p>FALSE if the business is not involved with crypto</p></div></div></div><div class=\\\"tr\\\"> <div class=\\\"td param\\\"> <strong> <span class=\\\"text-muted\\\">entity_info.</span>msb <span class=\\\"colon\\\">:</span> </strong> </div><div class=\\\"td\\\"> <strong class=\\\"param-type\\\">boolean</strong> <div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"> <p>FALSE if the business is not registered as a Money Servicing Business</p></div></div></div><div class=\\\"tr\\\"> <div class=\\\"td param\\\"> <strong> <span class=\\\"text-muted\\\">entity_info.msb.</span>federal <span class=\\\"colon\\\">:</span> </strong> </div><div class=\\\"td\\\"> <strong class=\\\"param-type\\\">boolean</strong> <div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"> <p>FALSE if the business does not have Money Transmission Licenses (MTL) in any states</p></div></div></div><div class=\\\"tr\\\"> <div class=\\\"td param\\\"> <strong> <span class=\\\"text-muted\\\">entity_info.msb.</span>states <span class=\\\"colon\\\">:</span> </strong> </div><div class=\\\"td\\\"> <strong class=\\\"param-type\\\">string</strong> <div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"> <p>states that business has Money Transmission Licenses (MTL) in</p></div></div></div><div class=\\\"tr\\\"> <div class=\\\"td param\\\"> <strong> <span class=\\\"text-muted\\\">entity_info.</span>public_company <span class=\\\"colon\\\">:</span> </strong> </div><div class=\\\"td\\\"> <strong class=\\\"param-type\\\">boolean</strong> <div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"> <p>FALSE if this not a public company</p></div></div></div><div class=\\\"tr\\\"> <div class=\\\"td param\\\"> <strong> <span class=\\\"text-muted\\\">entity_info.</span>registered_SEC <span class=\\\"colon\\\">:</span> </strong> </div><div class=\\\"td\\\"> <strong class=\\\"param-type\\\">boolean</strong> <div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"> <p>FALSE if business is not registered with U.S. Securities and Exchange Commission (SEC)</p></div></div></div><div class=\\\"tr\\\"> <div class=\\\"td param\\\"> <strong> <span class=\\\"text-muted\\\">entity_info.</span>majority_owned_by_listed <span class=\\\"colon\\\">:</span> </strong> </div><div class=\\\"td\\\"> <strong class=\\\"param-type\\\">boolean</strong> <div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"></div><p> FALSE if business not majority owned (50% or more) by a public company</p></div></div><div class=\\\"tr\\\"> <div class=\\\"td param\\\"> <strong> <span class=\\\"text-muted\\\">owners.</span>document_ID <span class=\\\"colon\\\">:</span> </strong> </div><div class=\\\"td\\\"> <strong class=\\\"param-type\\\">string</strong> <div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"> <p>Document ID of beneficial owner</p></div></div></div><div class=\\\"tr\\\"> <div class=\\\"td param\\\"> <strong> <span class=\\\"text-muted\\\">owners.</span>title <span class=\\\"colon\\\">:</span> </strong> </div><div class=\\\"td\\\"> <strong class=\\\"param-type\\\">string</strong> <div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"> <p>Owner's title in relation to the business</p></div></div></div><div class=\\\"tr\\\"> <div class=\\\"td param\\\"> <strong> <span class=\\\"text-muted\\\">owners.</span>ownership <span class=\\\"colon\\\">:</span> </strong> </div><div class=\\\"td\\\"> <strong class=\\\"param-type\\\">string</strong> <div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"> <p>Percentage of owner's ownership of the business ( only required if higher than 10%)</p></div></div></div></div></div></div>\"\n}\n[/block]\n##EXAMPLE REQUEST\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"PATCH /v3.1/users/5bda4a1314c7fa00a808f6a6/ubo HTTP/1.1\\nHost: uat-api.synapsefi.com\\nX-SP-GATEWAY: client_id_2bb1e412edd311e6bd04e285d6015267|client_secret_2bb1e714edd311e6bd04e285d6015267\\nX-SP-USER-IP: 127.0.0.1\\nX-SP-USER: oauth_1mtgLwhYHDVKop04XOEjyWJSsnQqZbGkfRF5ux9v|e83cf6ddcf778e37bfe3d48fc78a6502062fc\\nContent-Type: application/json\\n\\n{\\n   \\\"entity_info\\\": {\\n      \\\"cryptocurrency\\\": true,\\n      \\\"msb\\\": {\\n         \\\"federal\\\": true,\\n         \\\"states\\\": [\\\"AL\\\"]\\n      },\\n      \\\"public_company\\\": false,\\n      \\\"majority_owned_by_listed\\\": false,\\n      \\\"registered_SEC\\\": false,\\n      \\\"regulated_financial\\\": false,\\n      \\\"gambling\\\": false,\\n      \\\"document_id\\\": \\\"2a4a5957a3a62aaac1a0dd0edcae96ea2cdee688ec6337b20745eed8869e3ac8\\\"\\n   },\\n   \\\"signer\\\": {\\n      \\\"document_id\\\": \\\"dd09124227effbeae576fb18ff7859e508a89e08d6789c275ce027349d51e0c7\\\",\\n      \\\"relationship_to_entity\\\": \\\"CEO\\\"\\n   },\\n   \\\"compliance_contact\\\": {\\n      \\\"document_id\\\": \\\"dd09124227effbeae576fb18ff7859e508a89e08d6789c275ce027349d51e0c7\\\",\\n      \\\"relationship_to_entity\\\": \\\"CEO\\\"\\n   },\\n   \\\"primary_controlling_contact\\\": {\\n      \\\"document_id\\\": \\\"dd09124227effbeae576fb18ff7859e508a89e08d6789c275ce027349d51e0c7\\\",\\n      \\\"relationship_to_entity\\\": \\\"CEO\\\"\\n   },\\n   \\\"owners\\\": [\\n      {\\n         \\\"document_id\\\": \\\"dd09124227effbeae576fb18ff7859e508a89e08d6789c275ce027349d51e0c7\\\",\\n         \\\"title\\\": \\\"CEO\\\",\\n         \\\"ownership\\\": 95\\n      }\\n      ]\\n}\",\n      \"language\": \"http\"\n    }\n  ]\n}\n[/block]\n##Example Response\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"_id\\\": {\\n    \\\"$oid\\\": \\\"5bda4a1314c7fa00a808f6a6\\\"\\n  },\\n  \\\"client\\\": {\\n    \\\"id\\\": \\\"5a4d5a7805f18c00240bb488\\\",\\n    \\\"name\\\": \\\"Platform Name\\\"\\n  },\\n  \\\"doc_status\\\": {\\n    \\\"physical_doc\\\": \\\"MISSING|INVALID\\\",\\n    \\\"virtual_doc\\\": \\\"MISSING|INVALID\\\"\\n  },\\n  \\\"documents\\\": [\\n    {\\n      \\\"entity_scope\\\": \\\"Arts & Entertainment\\\",\\n      \\\"entity_type\\\": \\\"M\\\",\\n      \\\"id\\\": \\\"dd09124227effbeae576fb18ff7859e508a89e08d6789c275ce027349d51e0c7\\\",\\n      \\\"name\\\": \\\"John Smith\\\",\\n      \\\"permission_scope\\\": \\\"UNVERIFIED\\\",\\n      \\\"physical_docs\\\": [\\n        {\\n          \\\"document_type\\\": \\\"GOVT_ID\\\",\\n          \\\"id\\\": \\\"acd8420c558d8fb88062359263213784cf0bc88557895f93bf42d5897f5c4fe0\\\",\\n          \\\"last_updated\\\": {\\n            \\\"$date\\\": 1541033002528\\n          },\\n          \\\"status\\\": \\\"SUBMITTED|REVIEWING\\\"\\n        }\\n      ],\\n      \\\"social_docs\\\": [\\n        {\\n          \\\"document_type\\\": \\\"ADDRESS\\\",\\n          \\\"id\\\": \\\"c615c761d68c578a98fde8e73c490df405ff5d5e34fc11f029660d7e9743df21\\\",\\n          \\\"last_updated\\\": {\\n            \\\"$date\\\": 1541033003566\\n          },\\n          \\\"status\\\": \\\"SUBMITTED|REVIEWING\\\"\\n        },\\n        {\\n          \\\"document_type\\\": \\\"EMAIL\\\",\\n          \\\"id\\\": \\\"ec1bd13f97d4dcfa7ae28a18150e325f867d901f89545e0c0a257a532b106a27\\\",\\n          \\\"last_updated\\\": {\\n            \\\"$date\\\": 1541033003479\\n          },\\n          \\\"status\\\": \\\"SUBMITTED|REVIEWING\\\"\\n        },\\n        {\\n          \\\"document_type\\\": \\\"DATE\\\",\\n          \\\"id\\\": \\\"2b52edae636ca2fbe12ab1b08a344d381dabc3d2b92844cf7a8d8b6052b26d8e\\\",\\n          \\\"last_updated\\\": {\\n            \\\"$date\\\": 1541033003675\\n          },\\n          \\\"status\\\": \\\"SUBMITTED|REVIEWING\\\"\\n        },\\n        {\\n          \\\"document_type\\\": \\\"PHONE_NUMBER\\\",\\n          \\\"id\\\": \\\"b4eee6916fa7bca402af00e6b16e3c8d50737a7189dd81d4fd46ae2c2c0e1b36\\\",\\n          \\\"last_updated\\\": {\\n            \\\"$date\\\": 1541033003533\\n          },\\n          \\\"status\\\": \\\"SUBMITTED|REVIEWING\\\"\\n        }\\n      ],\\n      \\\"virtual_docs\\\": [\\n        {\\n          \\\"document_type\\\": \\\"SSN\\\",\\n          \\\"id\\\": \\\"ee596c2896dddc19b76c07a184fe7d3cf5a04b8e94b9108190cac7890739017f\\\",\\n          \\\"last_updated\\\": {\\n            \\\"$date\\\": 1541033001461\\n          },\\n          \\\"status\\\": \\\"SUBMITTED|REVIEWING\\\"\\n        }\\n      ]\\n    },\\n    {\\n      \\\"entity_scope\\\": \\\"Arts & Entertainment\\\",\\n      \\\"entity_type\\\": \\\"LLC\\\",\\n      \\\"id\\\": \\\"2a4a5957a3a62aaac1a0dd0edcae96ea2cdee688ec6337b20745eed8869e3ac8\\\",\\n      \\\"name\\\": \\\"Fake Business\\\",\\n      \\\"permission_scope\\\": \\\"UNVERIFIED\\\",\\n      \\\"physical_docs\\\": [\\n        {\\n          \\\"document_type\\\": \\\"GOVT_ID\\\",\\n          \\\"id\\\": \\\"7840958571593e69a4727205be0e1a6d0cdb99656a8ed96e6802de46f3b740b5\\\",\\n          \\\"last_updated\\\": {\\n            \\\"$date\\\": 1541032460556\\n          },\\n          \\\"status\\\": \\\"SUBMITTED|REVIEWING\\\"\\n        },\\n        {\\n          \\\"document_type\\\": \\\"EIN_DOC\\\",\\n          \\\"id\\\": \\\"2a8bf6873eda6dc774747ac045f92408210211e388adf23faf38e254b1fa9c8c\\\",\\n          \\\"last_updated\\\": {\\n            \\\"$date\\\": 1541032755544\\n          },\\n          \\\"status\\\": \\\"SUBMITTED|REVIEWING\\\"\\n        },\\n        {\\n          \\\"document_type\\\": \\\"REG_GG\\\",\\n          \\\"id\\\": \\\"63f2650014448a3f81d316b21204bbe6960881be227e5760a6897542e15e4a1e\\\",\\n          \\\"last_updated\\\": {\\n            \\\"$date\\\": 1541033341748\\n          },\\n          \\\"status\\\": \\\"SUBMITTED\\\"\\n        }\\n      ],\\n      \\\"social_docs\\\": [\\n        {\\n          \\\"document_type\\\": \\\"PHONE_NUMBER\\\",\\n          \\\"id\\\": \\\"fda60784d6375bc44edafaaeae149626c4c13dcb92e85a2a7a00eec2cdfd2b6f\\\",\\n          \\\"last_updated\\\": {\\n            \\\"$date\\\": 1541032756436\\n          },\\n          \\\"status\\\": \\\"SUBMITTED|REVIEWING\\\"\\n        },\\n        {\\n          \\\"document_type\\\": \\\"ADDRESS\\\",\\n          \\\"id\\\": \\\"bce9d06d8d58a609c87a9cee2153e2cc1cee79d846121cd86907ba90433634ec\\\",\\n          \\\"last_updated\\\": {\\n            \\\"$date\\\": 1541032756524\\n          },\\n          \\\"status\\\": \\\"SUBMITTED|REVIEWING\\\"\\n        },\\n        {\\n          \\\"document_type\\\": \\\"EMAIL\\\",\\n          \\\"id\\\": \\\"2c45158f6431ca874bbe82f63d5905567854dde4d8b81539944e5779e5eee741\\\",\\n          \\\"last_updated\\\": {\\n            \\\"$date\\\": 1541032756429\\n          },\\n          \\\"status\\\": \\\"SUBMITTED|REVIEWING\\\"\\n        },\\n        {\\n          \\\"document_type\\\": \\\"DATE\\\",\\n          \\\"id\\\": \\\"b8e669e729f2dface01775c91668e35ed5b6340bcec291a6393b4ea8e6b0dfe9\\\",\\n          \\\"last_updated\\\": {\\n            \\\"$date\\\": 1541032756584\\n          },\\n          \\\"status\\\": \\\"SUBMITTED|REVIEWING\\\"\\n        }\\n      ],\\n      \\\"virtual_docs\\\": [\\n        {\\n          \\\"document_type\\\": \\\"SSN\\\",\\n          \\\"id\\\": \\\"7cb85697d26e2c1010266fd64a22afd396167ca630a4bad21a9e8fcff865bb1c\\\",\\n          \\\"last_updated\\\": {\\n            \\\"$date\\\": 1541032459593\\n          },\\n          \\\"status\\\": \\\"SUBMITTED|REVIEWING\\\"\\n        },\\n        {\\n          \\\"document_type\\\": \\\"TIN\\\",\\n          \\\"id\\\": \\\"a55cc12f46e8091f741b978d5fa556b2f8772a75007a82aae10a2fd810f644cb\\\",\\n          \\\"last_updated\\\": {\\n            \\\"$date\\\": 1541032754521\\n          },\\n          \\\"status\\\": \\\"SUBMITTED|REVIEWING\\\"\\n        }\\n      ]\\n    }\\n  ],\\n  \\\"extra\\\": {\\n    \\\"cip_tag\\\": 1,\\n    \\\"date_joined\\\": {\\n      \\\"$date\\\": 1541032445648\\n    },\\n    \\\"extra_security\\\": false,\\n    \\\"is_business\\\": true,\\n    \\\"last_updated\\\": {\\n      \\\"$date\\\": 1541033341412\\n    },\\n    \\\"public_note\\\": null,\\n    \\\"supp_id\\\": \\\"my_user_id\\\"\\n  },\\n  \\\"is_hidden\\\": false,\\n  \\\"legal_names\\\": [\\n    \\\"Fake Business\\\"\\n  ],\\n  \\\"logins\\\": [\\n    {\\n      \\\"email\\\": \\\"test:::at:::synapsepay.com\\\",\\n      \\\"scope\\\": \\\"READ_AND_WRITE\\\"\\n    }\\n  ],\\n  \\\"permission\\\": \\\"UNVERIFIED\\\",\\n  \\\"phone_numbers\\\": [\\n    \\\"901.111.1111\\\"\\n  ],\\n  \\\"photos\\\": []\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\nIf the response is successful, then the UBO/Reg GG form will be automatically uploaded it as a REG__GG as a physical document to the business user.","excerpt":"","slug":"generate-ubo-form","type":"basic","title":"Generate UBO Form"}
This API call allows you to automatically create and upload an Ultimate Beneficial Ownership (UBO) and REG GG form as a physical document under the Business’s base document. This physical document is called `REG_GG`. **What is this form?** To help the government fight financial crime, Federal regulations require that we obtain, verify, and record information about the beneficial owners of businesses opening deposit accounts. Requiring beneficial owner & key individual information helps law enforcement investigate and prosecute crimes, such as terrorist financing, money laundering, tax evasion, corruption, fraud, and other financial crimes. **What information do I need to provide?** When you open a new deposit account `DEPOSIT-US` on behalf of a business, we ask for beneficial owner information. Beneficial owners are: 1. Each individual, if any, who owns, directly or indirectly, 10 percent or more of the equity interests of the legal entity customer (e.g., each natural person that owns 10 percent or more of the shares of a corporation; and 2. An individual with significant responsibility for managing the legal entity customer (e.g., a Chief Executive Officer, Chief Financial Officer, Chief Operating Officer, Managing Member, General Partner, President, Vice President, or Treasurer). The number of individuals that satisfy this definition of “beneficial owner” may vary. Up to ten individuals (but as few as zero) may need to be identified. Regardless of the number of individuals identified, you must provide the identifying information of at least one controlling person. In some cases, the beneficial owner is also the controlling person. ##API ENDPOINT https://uat-api.synapsefi.com/v3.1/users/:user_id/ubo ##PATH PARAMETER [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 retrieve</p></div></div></div></div></div></div>" } [/block] ##BODY PARAMETER [block:html] { "html": "<div class=\"api-manager\"> <div class=\"param-table\"> <div class=\"table\"> <div class=\"tr\"> <div class=\"td param\"> <strong> <span class=\"text-muted\">signer.</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>Document ID of individual completing the form</p></div></div></div><div class=\"tr\"> <div class=\"td param\"> <strong> <span class=\"text-muted\">signer.</span>relationship_to_entity:<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>Signer's title at the business</p></div></div></div><div class=\"tr\"> <div class=\"td param\"> <strong> <span class=\"text-muted\">entity_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>Document ID of business opening DEPOSIT-US Account</p></div></div></div><div class=\"tr\"> <div class=\"td param\"> <strong> <span class=\"text-muted\">entity_info.</span>gamble <span class=\"colon\">:</span> </strong> <div class=\"required\">required</div></div><div class=\"td\"> <strong class=\"param-type\">boolean</strong> <div marked=\"\" class=\"ng-isolate-scope\"> <p>FALSE if business does not engage in the internet gambling business</p></div></div></div><div class=\"tr\"> <div class=\"td param\"> <strong> <span class=\"text-muted\">primary_controlling_contact.</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>Document ID of business’s primary controlling contact. This is typically an executive officer or senior manager (ex: CEO or CFO) OR an individual who regularly performs similar functions</p></div></div></div><div class=\"tr\"> <div class=\"td param\"> <strong> <span class=\"text-muted\">primary_controlling_contact.</span>relationship_to_entity <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>Primary controlling contact's title at the business</p></div></div></div><div class=\"tr\"> <div class=\"td param\"> <strong> <span class=\"text-muted\">compliance_contact.</span>relationship_to_entity <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>Compliance contact's title at the business</p></div></div></div><div class=\"tr\"> <div class=\"td param\"> <strong> <span class=\"text-muted\">compliance_contact.</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>Document ID of business’s compliance contact</p></div></div></div><div class=\"tr\"> <div class=\"td param\"> <strong> <span class=\"text-muted\">entity_info.</span>cryptocurrency <span class=\"colon\">:</span> </strong> </div><div class=\"td\"> <strong class=\"param-type\">boolean</strong> <div marked=\"\" class=\"ng-isolate-scope\"> <p>FALSE if the business is not involved with crypto</p></div></div></div><div class=\"tr\"> <div class=\"td param\"> <strong> <span class=\"text-muted\">entity_info.</span>msb <span class=\"colon\">:</span> </strong> </div><div class=\"td\"> <strong class=\"param-type\">boolean</strong> <div marked=\"\" class=\"ng-isolate-scope\"> <p>FALSE if the business is not registered as a Money Servicing Business</p></div></div></div><div class=\"tr\"> <div class=\"td param\"> <strong> <span class=\"text-muted\">entity_info.msb.</span>federal <span class=\"colon\">:</span> </strong> </div><div class=\"td\"> <strong class=\"param-type\">boolean</strong> <div marked=\"\" class=\"ng-isolate-scope\"> <p>FALSE if the business does not have Money Transmission Licenses (MTL) in any states</p></div></div></div><div class=\"tr\"> <div class=\"td param\"> <strong> <span class=\"text-muted\">entity_info.msb.</span>states <span class=\"colon\">:</span> </strong> </div><div class=\"td\"> <strong class=\"param-type\">string</strong> <div marked=\"\" class=\"ng-isolate-scope\"> <p>states that business has Money Transmission Licenses (MTL) in</p></div></div></div><div class=\"tr\"> <div class=\"td param\"> <strong> <span class=\"text-muted\">entity_info.</span>public_company <span class=\"colon\">:</span> </strong> </div><div class=\"td\"> <strong class=\"param-type\">boolean</strong> <div marked=\"\" class=\"ng-isolate-scope\"> <p>FALSE if this not a public company</p></div></div></div><div class=\"tr\"> <div class=\"td param\"> <strong> <span class=\"text-muted\">entity_info.</span>registered_SEC <span class=\"colon\">:</span> </strong> </div><div class=\"td\"> <strong class=\"param-type\">boolean</strong> <div marked=\"\" class=\"ng-isolate-scope\"> <p>FALSE if business is not registered with U.S. Securities and Exchange Commission (SEC)</p></div></div></div><div class=\"tr\"> <div class=\"td param\"> <strong> <span class=\"text-muted\">entity_info.</span>majority_owned_by_listed <span class=\"colon\">:</span> </strong> </div><div class=\"td\"> <strong class=\"param-type\">boolean</strong> <div marked=\"\" class=\"ng-isolate-scope\"></div><p> FALSE if business not majority owned (50% or more) by a public company</p></div></div><div class=\"tr\"> <div class=\"td param\"> <strong> <span class=\"text-muted\">owners.</span>document_ID <span class=\"colon\">:</span> </strong> </div><div class=\"td\"> <strong class=\"param-type\">string</strong> <div marked=\"\" class=\"ng-isolate-scope\"> <p>Document ID of beneficial owner</p></div></div></div><div class=\"tr\"> <div class=\"td param\"> <strong> <span class=\"text-muted\">owners.</span>title <span class=\"colon\">:</span> </strong> </div><div class=\"td\"> <strong class=\"param-type\">string</strong> <div marked=\"\" class=\"ng-isolate-scope\"> <p>Owner's title in relation to the business</p></div></div></div><div class=\"tr\"> <div class=\"td param\"> <strong> <span class=\"text-muted\">owners.</span>ownership <span class=\"colon\">:</span> </strong> </div><div class=\"td\"> <strong class=\"param-type\">string</strong> <div marked=\"\" class=\"ng-isolate-scope\"> <p>Percentage of owner's ownership of the business ( only required if higher than 10%)</p></div></div></div></div></div></div>" } [/block] ##EXAMPLE REQUEST [block:code] { "codes": [ { "code": "PATCH /v3.1/users/5bda4a1314c7fa00a808f6a6/ubo HTTP/1.1\nHost: uat-api.synapsefi.com\nX-SP-GATEWAY: client_id_2bb1e412edd311e6bd04e285d6015267|client_secret_2bb1e714edd311e6bd04e285d6015267\nX-SP-USER-IP: 127.0.0.1\nX-SP-USER: oauth_1mtgLwhYHDVKop04XOEjyWJSsnQqZbGkfRF5ux9v|e83cf6ddcf778e37bfe3d48fc78a6502062fc\nContent-Type: application/json\n\n{\n \"entity_info\": {\n \"cryptocurrency\": true,\n \"msb\": {\n \"federal\": true,\n \"states\": [\"AL\"]\n },\n \"public_company\": false,\n \"majority_owned_by_listed\": false,\n \"registered_SEC\": false,\n \"regulated_financial\": false,\n \"gambling\": false,\n \"document_id\": \"2a4a5957a3a62aaac1a0dd0edcae96ea2cdee688ec6337b20745eed8869e3ac8\"\n },\n \"signer\": {\n \"document_id\": \"dd09124227effbeae576fb18ff7859e508a89e08d6789c275ce027349d51e0c7\",\n \"relationship_to_entity\": \"CEO\"\n },\n \"compliance_contact\": {\n \"document_id\": \"dd09124227effbeae576fb18ff7859e508a89e08d6789c275ce027349d51e0c7\",\n \"relationship_to_entity\": \"CEO\"\n },\n \"primary_controlling_contact\": {\n \"document_id\": \"dd09124227effbeae576fb18ff7859e508a89e08d6789c275ce027349d51e0c7\",\n \"relationship_to_entity\": \"CEO\"\n },\n \"owners\": [\n {\n \"document_id\": \"dd09124227effbeae576fb18ff7859e508a89e08d6789c275ce027349d51e0c7\",\n \"title\": \"CEO\",\n \"ownership\": 95\n }\n ]\n}", "language": "http" } ] } [/block] ##Example Response [block:code] { "codes": [ { "code": "{\n \"_id\": {\n \"$oid\": \"5bda4a1314c7fa00a808f6a6\"\n },\n \"client\": {\n \"id\": \"5a4d5a7805f18c00240bb488\",\n \"name\": \"Platform Name\"\n },\n \"doc_status\": {\n \"physical_doc\": \"MISSING|INVALID\",\n \"virtual_doc\": \"MISSING|INVALID\"\n },\n \"documents\": [\n {\n \"entity_scope\": \"Arts & Entertainment\",\n \"entity_type\": \"M\",\n \"id\": \"dd09124227effbeae576fb18ff7859e508a89e08d6789c275ce027349d51e0c7\",\n \"name\": \"John Smith\",\n \"permission_scope\": \"UNVERIFIED\",\n \"physical_docs\": [\n {\n \"document_type\": \"GOVT_ID\",\n \"id\": \"acd8420c558d8fb88062359263213784cf0bc88557895f93bf42d5897f5c4fe0\",\n \"last_updated\": {\n \"$date\": 1541033002528\n },\n \"status\": \"SUBMITTED|REVIEWING\"\n }\n ],\n \"social_docs\": [\n {\n \"document_type\": \"ADDRESS\",\n \"id\": \"c615c761d68c578a98fde8e73c490df405ff5d5e34fc11f029660d7e9743df21\",\n \"last_updated\": {\n \"$date\": 1541033003566\n },\n \"status\": \"SUBMITTED|REVIEWING\"\n },\n {\n \"document_type\": \"EMAIL\",\n \"id\": \"ec1bd13f97d4dcfa7ae28a18150e325f867d901f89545e0c0a257a532b106a27\",\n \"last_updated\": {\n \"$date\": 1541033003479\n },\n \"status\": \"SUBMITTED|REVIEWING\"\n },\n {\n \"document_type\": \"DATE\",\n \"id\": \"2b52edae636ca2fbe12ab1b08a344d381dabc3d2b92844cf7a8d8b6052b26d8e\",\n \"last_updated\": {\n \"$date\": 1541033003675\n },\n \"status\": \"SUBMITTED|REVIEWING\"\n },\n {\n \"document_type\": \"PHONE_NUMBER\",\n \"id\": \"b4eee6916fa7bca402af00e6b16e3c8d50737a7189dd81d4fd46ae2c2c0e1b36\",\n \"last_updated\": {\n \"$date\": 1541033003533\n },\n \"status\": \"SUBMITTED|REVIEWING\"\n }\n ],\n \"virtual_docs\": [\n {\n \"document_type\": \"SSN\",\n \"id\": \"ee596c2896dddc19b76c07a184fe7d3cf5a04b8e94b9108190cac7890739017f\",\n \"last_updated\": {\n \"$date\": 1541033001461\n },\n \"status\": \"SUBMITTED|REVIEWING\"\n }\n ]\n },\n {\n \"entity_scope\": \"Arts & Entertainment\",\n \"entity_type\": \"LLC\",\n \"id\": \"2a4a5957a3a62aaac1a0dd0edcae96ea2cdee688ec6337b20745eed8869e3ac8\",\n \"name\": \"Fake Business\",\n \"permission_scope\": \"UNVERIFIED\",\n \"physical_docs\": [\n {\n \"document_type\": \"GOVT_ID\",\n \"id\": \"7840958571593e69a4727205be0e1a6d0cdb99656a8ed96e6802de46f3b740b5\",\n \"last_updated\": {\n \"$date\": 1541032460556\n },\n \"status\": \"SUBMITTED|REVIEWING\"\n },\n {\n \"document_type\": \"EIN_DOC\",\n \"id\": \"2a8bf6873eda6dc774747ac045f92408210211e388adf23faf38e254b1fa9c8c\",\n \"last_updated\": {\n \"$date\": 1541032755544\n },\n \"status\": \"SUBMITTED|REVIEWING\"\n },\n {\n \"document_type\": \"REG_GG\",\n \"id\": \"63f2650014448a3f81d316b21204bbe6960881be227e5760a6897542e15e4a1e\",\n \"last_updated\": {\n \"$date\": 1541033341748\n },\n \"status\": \"SUBMITTED\"\n }\n ],\n \"social_docs\": [\n {\n \"document_type\": \"PHONE_NUMBER\",\n \"id\": \"fda60784d6375bc44edafaaeae149626c4c13dcb92e85a2a7a00eec2cdfd2b6f\",\n \"last_updated\": {\n \"$date\": 1541032756436\n },\n \"status\": \"SUBMITTED|REVIEWING\"\n },\n {\n \"document_type\": \"ADDRESS\",\n \"id\": \"bce9d06d8d58a609c87a9cee2153e2cc1cee79d846121cd86907ba90433634ec\",\n \"last_updated\": {\n \"$date\": 1541032756524\n },\n \"status\": \"SUBMITTED|REVIEWING\"\n },\n {\n \"document_type\": \"EMAIL\",\n \"id\": \"2c45158f6431ca874bbe82f63d5905567854dde4d8b81539944e5779e5eee741\",\n \"last_updated\": {\n \"$date\": 1541032756429\n },\n \"status\": \"SUBMITTED|REVIEWING\"\n },\n {\n \"document_type\": \"DATE\",\n \"id\": \"b8e669e729f2dface01775c91668e35ed5b6340bcec291a6393b4ea8e6b0dfe9\",\n \"last_updated\": {\n \"$date\": 1541032756584\n },\n \"status\": \"SUBMITTED|REVIEWING\"\n }\n ],\n \"virtual_docs\": [\n {\n \"document_type\": \"SSN\",\n \"id\": \"7cb85697d26e2c1010266fd64a22afd396167ca630a4bad21a9e8fcff865bb1c\",\n \"last_updated\": {\n \"$date\": 1541032459593\n },\n \"status\": \"SUBMITTED|REVIEWING\"\n },\n {\n \"document_type\": \"TIN\",\n \"id\": \"a55cc12f46e8091f741b978d5fa556b2f8772a75007a82aae10a2fd810f644cb\",\n \"last_updated\": {\n \"$date\": 1541032754521\n },\n \"status\": \"SUBMITTED|REVIEWING\"\n }\n ]\n }\n ],\n \"extra\": {\n \"cip_tag\": 1,\n \"date_joined\": {\n \"$date\": 1541032445648\n },\n \"extra_security\": false,\n \"is_business\": true,\n \"last_updated\": {\n \"$date\": 1541033341412\n },\n \"public_note\": null,\n \"supp_id\": \"my_user_id\"\n },\n \"is_hidden\": false,\n \"legal_names\": [\n \"Fake Business\"\n ],\n \"logins\": [\n {\n \"email\": \"[email protected]\",\n \"scope\": \"READ_AND_WRITE\"\n }\n ],\n \"permission\": \"UNVERIFIED\",\n \"phone_numbers\": [\n \"901.111.1111\"\n ],\n \"photos\": []\n}", "language": "json" } ] } [/block] If the response is successful, then the UBO/Reg GG form will be automatically uploaded it as a REG__GG as a physical document to the business user.