{"_id":"55fa37cb8065a10d004e5bc5","category":{"_id":"55fa37ca8065a10d004e5bb8","pages":["55fa37cb8065a10d004e5bc5","55fa37cb8065a10d004e5bc6","55fa37cb8065a10d004e5bc7","55fa37cb8065a10d004e5bc8","55fa37cb8065a10d004e5bc9","55fa37cb8065a10d004e5bca","55fa37cb8065a10d004e5bcb","55fa37cb8065a10d004e5bcc","55fa37cb8065a10d004e5bcd","55fa3dd4a663c00d00773dd1","55fa409d8065a10d004e5bda","55fa463317b9d00d00969ead","55fa4822764f5021009506c0","55fa4bfeaba81f0d00a115e7","55fa4dcd17b9d00d00969eb7","55fca6ccf95c5b0d0068fdfa","55fe6735748eb30d008a1e61","55ff4d91cc468e0d008dce5f","55ff558a9e7ccf0d000a1d49","55ff5695cc468e0d008dce67","55ff6e986932a00d00ba7a37","55ff702f9e7ccf0d000a1d83","560221271ba3720d00a6b99d","560221418a6c97170066cf48","563e18aad6db8d17008389ac"],"version":"55fa37c88065a10d004e5bb6","project":"54e405191e51932d006abc39","__v":17,"sync":{"url":"","isSync":false},"reference":true,"createdAt":"2015-06-06T05:42:37.534Z","from_sync":false,"order":3,"slug":"users","title":"Users"},"parentDoc":null,"user":"54e4044e8ef7552300409dcb","version":{"_id":"55fa37c88065a10d004e5bb6","project":"54e405191e51932d006abc39","__v":11,"createdAt":"2015-09-17T03:47:20.956Z","releaseDate":"2015-09-17T03:47:20.956Z","categories":["55fa37ca8065a10d004e5bb7","55fa37ca8065a10d004e5bb8","55fa37ca8065a10d004e5bb9","55fa37ca8065a10d004e5bba","55fca6bf34ae7c0d00ab8ea0","55ff80fd9e7ccf0d000a1d93","560220af7435de0d00fabd0d","56107f21bb9d920d00303e70","563e184077681a0d00d96a02","56fafc6596ec7e0e002ac85f","5915e54f7c2c552d008b8549","59499fcd64b5f5002690bbc1","59c451b7772699001c0f1df1","59c9b42dec84880010c1f348"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"REST V3","version_clean":"3.1.0","version":"3.1"},"project":"54e405191e51932d006abc39","__v":93,"updates":["557714eee6063e0d0048131c","56072583bc4e580d0033a950","562dc4ff54a5be0d00070b7e","564fd0bf149f9e35004d4006","56aba3a3d4432d1900eed1da","57a2be7ddba9ea0e0012c90d","57a2bf176a40d30e0047f5a9"],"next":{"pages":[],"description":""},"createdAt":"2015-06-06T05:43:09.047Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":true,"order":0,"body":"User resources are generic user classes that store all KYC information, log in credentials, permissions, etc. on an individual or business.\n\n## User Object\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 a user object</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 user object</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 where the user was created</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 user</p>\\n</div></div></div><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong><span class=\\\"text-muted\\\">doc_status.</span>physical_doc<span class=\\\"colon\\\">:</span></strong></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">string</strong><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>[DEPRECATED] Status of physical document verification</p>\\n</div></div></div><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong><span class=\\\"text-muted\\\">doc_status.</span>virtual_doc<span class=\\\"colon\\\">:</span></strong></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">string</strong><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>[DEPRECATED] Status of virtual document verification</p>\\n</div></div></div><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong><span class=\\\"text-muted\\\">documents[</span>id<span class=\\\"text-muted\\\">]</span><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 document</p>\\n</div></div></div><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong><span class=\\\"text-muted\\\">documents[</span>name<span class=\\\"text-muted\\\">]</span><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 document owner</p>\\n</div></div></div><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong><span class=\\\"text-muted\\\">documents[</span>permission_scope<span class=\\\"text-muted\\\">]</span><span class=\\\"colon\\\">:</span></strong></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">string</strong><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>Permission scope of the document. More details can be <a href=\\\"#section-document-permission-scope\\\">found here</a>.</p>\\n</div></div></div><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong><span class=\\\"text-muted\\\">documents.physical_docs.[</span>id<span class=\\\"text-muted\\\">]</span><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 physical document</p>\\n</div></div></div><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong><span class=\\\"text-muted\\\">documents.physical_docs.[</span>document_type<span class=\\\"text-muted\\\">]</span><span class=\\\"colon\\\">:</span></strong></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">string</strong><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>Type of the physical document</p>\\n</div></div></div><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong><span class=\\\"text-muted\\\">documents.physical_docs.[</span>last_updated<span class=\\\"text-muted\\\">]</span><span class=\\\"colon\\\">:</span></strong></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">integer</strong><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>Date when the document was last updated. The value is a unix timestamp in milliseconds.</p>\\n</div></div></div><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong><span class=\\\"text-muted\\\">documents.physical_docs.[</span>status<span class=\\\"text-muted\\\">]</span><span class=\\\"colon\\\">:</span></strong></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">string</strong><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>Status of the physical document.</p>\\n</div></div></div><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong><span class=\\\"text-muted\\\">documents.social_docs.[</span>id<span class=\\\"text-muted\\\">]</span><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 social document</p>\\n</div></div></div><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong><span class=\\\"text-muted\\\">documents.social_docs.[</span>document_type<span class=\\\"text-muted\\\">]</span><span class=\\\"colon\\\">:</span></strong></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">string</strong><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>Type of the social document</p>\\n</div></div></div><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong><span class=\\\"text-muted\\\">documents.social_docs.[</span>last_updated<span class=\\\"text-muted\\\">]</span><span class=\\\"colon\\\">:</span></strong></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">integer</strong><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>Date when the document was last updated. The value is a unix timestamp in milliseconds.</p>\\n</div></div></div><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong><span class=\\\"text-muted\\\">documents.social_docs.[</span>status<span class=\\\"text-muted\\\">]</span><span class=\\\"colon\\\">:</span></strong></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">string</strong><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>Status of the social document.</p>\\n</div></div></div><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong><span class=\\\"text-muted\\\">documents.virtual_docs.[</span>id<span class=\\\"text-muted\\\">]</span><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 virtual document</p>\\n</div></div></div><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong><span class=\\\"text-muted\\\">documents.virtual_docs.[</span>document_type<span class=\\\"text-muted\\\">]</span><span class=\\\"colon\\\">:</span></strong></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">string</strong><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>Type of the virtual document</p>\\n</div></div></div><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong><span class=\\\"text-muted\\\">documents.virtual_docs.[</span>last_updated<span class=\\\"text-muted\\\">]</span><span class=\\\"colon\\\">:</span></strong></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">integer</strong><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>Date when the document was last updated. The value is a unix timestamp in milliseconds</p>\\n</div></div></div><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong><span class=\\\"text-muted\\\">documents.virtual_docs.[</span>status<span class=\\\"text-muted\\\">]</span><span class=\\\"colon\\\">:</span></strong></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">string</strong><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>Status of the virtual document</p>\\n</div></div></div><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong><span class=\\\"text-muted\\\">extra.</span>date_joined<span class=\\\"colon\\\">:</span></strong></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">string</strong><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>Date when the user was created. The value is a unix timestamp in milliseconds</p>\\n</div></div></div><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong><span class=\\\"text-muted\\\">extra.</span>is_business<span class=\\\"colon\\\">:</span></strong></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">boolean</strong><span class=\\\"param-default text-muted\\\">false</span><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>Boolean that denotes if the user object is a business account or personal</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 user</p>\\n</div></div></div><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong><span class=\\\"text-muted\\\">extra.</span>cip_tag<span class=\\\"colon\\\">:</span></strong></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">integer</strong><span class=\\\"param-default text-muted\\\">1</span><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>CIP tag assigned to the user profile</p>\\n</div></div></div><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong>is_hidden<span class=\\\"colon\\\">:</span></strong></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">boolean</strong><span class=\\\"param-default text-muted\\\">false</span><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>Value denotes if the user can be searched by email/name on Synapse services</p>\\n</div></div></div><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong>legal_names<span class=\\\"colon\\\">:</span></strong></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">array of strings</strong><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>Legal names/Full names associated with the user object</p>\\n</div></div></div><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong><span class=\\\"text-muted\\\">logins[</span>email<span class=\\\"text-muted\\\">]</span><span class=\\\"colon\\\">:</span></strong></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">string</strong><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>Email associated with the login</p>\\n</div></div></div><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong><span class=\\\"text-muted\\\">logins[</span>scope<span class=\\\"text-muted\\\">]</span><span class=\\\"colon\\\">:</span></strong></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">string</strong><span class=\\\"param-default text-muted\\\">READ_AND_WRITE</span><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>Value denotes what permissions the login credentials has. Currently only two scopes are supported: <code>READ_AND_WRITE</code> &amp; <code>READ</code></p>\\n</div></div></div><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong>permission<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 user permissions section below to learn more</p>\\n</div></div></div><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong>phone_numbers<span class=\\\"colon\\\">:</span></strong></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">array of strings</strong><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>Phone numbers/2FA devices associated with the user</p>\\n</div></div></div><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong>photos<span class=\\\"colon\\\">:</span></strong></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">array of strings</strong><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>Public avatars associated with the account</p>\\n</div></div></div><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong>refresh_token<span class=\\\"colon\\\">:</span></strong></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">string</strong><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>The refresh token associated with the user and your platform</p>\\n</div></div></div></div></div></div>\"\n}\n[/block]\n## User Types\n\nUser resources can be used to register two account types:\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Account Type\",\n    \"h-1\": \"Comment\",\n    \"0-0\": \"Individual\",\n    \"1-0\": \"Business\",\n    \"0-1\": \"Used to register a personal account.\",\n    \"1-1\": \"Used to register a business entity account.\"\n  },\n  \"cols\": 2,\n  \"rows\": 2\n}\n[/block]\n## Customer Identification Program (CIP) & Know Your Customer (KYC)\n\nCIP & KYC are important components of running a successful FinTech business. You can utilize Synapse's CIP tools to validate customer information and stay compliant.\n\nDepending upon the CIP program you wish to put in place, Synapse recognizes three types of documents:\n\n**1. Physical Documents:** These are images of documents being uploaded to Synapse for verification. Eg. Image of a Driver's License, Proof of Address, etc. A complete list of documents that we are capable of verifying as physical documents can be found [here](#section-physical-document-types).\n**2. Virtual Documents:** Documents uploaded in meta data form are called virtual documents. Eg. SSN Number, TIN, etc. A complete list of documents that we are capable of verifying as virtual documents can be found [here](#section-virtual-document-types).\n**3. Social Documents:** If you use Facebook, Twitter or Linkedin for singing up customers, you can supply those URLs as a form of identity as well. A complete list of documents that we are capable of verifying as social documents can be found [here](#section-social-document-types).\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Some Considerations\",\n  \"body\": \"* Please make sure that the user is submitting their full legal name as the document name. Using initials of names or non-legal names will result in KYC fails.\\n* Users below 18 years of age are auto rejected as well.\"\n}\n[/block]\n## Authentication (OAuth + Fingerprint)\n\n[Guide to user fingerprints](doc:oauth-resources) \n\n## User Permissions\n\nEvery user in Synapse has a set of permissions. The permissions dictate what the user can and cannot do within the network. You can find the user permission associated with each user under the permissions key on the user JSON response.\n\nFollowing are the user permissions and what they mean.\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Permission\",\n    \"h-1\": \"Comment\",\n    \"0-0\": \"UNVERIFIED\",\n    \"1-0\": \"RECEIVE\",\n    \"2-0\": \"SEND-AND-RECEIVE\",\n    \"3-0\": \"LOCKED\",\n    \"0-1\": \"User has been created in the system, but has not been verified yet. This means the user instance has been created, but no KYC information has been supplied on the user.\",\n    \"1-1\": \"The user may only receive funds given the user has been created.\",\n    \"2-1\": \"The user may send or receive funds.\",\n    \"3-1\": \"User account has been locked by Synapse. This can happen because of multiple reasons but mostly fraud related.\"\n  },\n  \"cols\": 2,\n  \"rows\": 4\n}\n[/block]\n## Document Status\n\nAlong with the user permissions, you can also view the status of a user's documents.\nSame document status conversations are followed for all 3 document types ([Physical](#section-physical-document-types), [Virtual](#section-virtual-document-types) & [Social](#section-social-document-types)).\n\nFollowing are different document statues and what they mean.\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Status\",\n    \"h-1\": \"Comment\",\n    \"0-0\": \"SUBMITTED\",\n    \"1-0\": \"SUBMITTED|REVIEWING\",\n    \"4-0\": \"\",\n    \"0-1\": \"Document was submitted but not validated, resubmission not needed.\",\n    \"1-1\": \"Document uploaded and is being reviewed.\",\n    \"4-1\": \"\",\n    \"3-0\": \"SUBMITTED|VALID\",\n    \"3-1\": \"Document is valid.\",\n    \"2-0\": \"SUBMITTED|INVALID\",\n    \"2-1\": \"Document invalid, unable to verify (resubmission dependent upon platform CIP).\"\n  },\n  \"cols\": 2,\n  \"rows\": 4\n}\n[/block]\n## Document Permission Scope\n\nEach document is given permissions based on the CIP program put in place for your gateway. This helps decide over all permissions associated with the user account. \n\nPermission scope helps determine if the user is allowed to send funds, receive funds and up to what amount (daily, weekly or monthly).\n\nIf multiple documents are submitted on the profile, the worst permission scope ends up being the permissions associated with the user account. This makes sure that your CIP program is never invalidated, thus keeping you compliant.\n\nFollowing are the examples of different kinds of permission scopes\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Permission Scope\",\n    \"h-1\": \"Comment\",\n    \"0-0\": \"RECEIVE|5000|DAILY\",\n    \"0-1\": \"The user has receive-only permissions up to 5,000 units (any currency) per day.\",\n    \"1-0\": \"RECEIVE|5000|MONTHLY\",\n    \"1-1\": \"The user has receive-only permissions up to 5,000 units (any currency) every month.\",\n    \"2-0\": \"SEND|RECEIVE|5000|DAILY\",\n    \"2-1\": \"The user can send or receive funds up to 5,000 units (any currency) every day.\",\n    \"3-0\": \"SEND|RECEIVE|TIER|1\",\n    \"3-1\": \"The user can send or receive funds and limits are governed by the tier 1 of your CIP.\",\n    \"4-0\": \"SEND|RECEIVE\",\n    \"4-1\": \"The user can send or receive funds.\"\n  },\n  \"cols\": 2,\n  \"rows\": 5\n}\n[/block]\n## Supported Entity Types\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Entity Types\",\n    \"h-1\": \"Comment\",\n    \"0-0\": \"M\",\n    \"1-0\": \"F\",\n    \"2-0\": \"O\",\n    \"4-0\": \"LLC\",\n    \"5-0\": \"CORP\",\n    \"6-0\": \"PARTNERSHIP\",\n    \"7-0\": \"SOLE-PROPRIETORSHIP\",\n    \"0-1\": \"Male\",\n    \"1-1\": \"Female\",\n    \"2-1\": \"Other\",\n    \"4-1\": \"Limited Liability Company\",\n    \"5-1\": \"Corporation\",\n    \"6-1\": \"Any type of partnership\",\n    \"7-1\": \"Sole proprietorship\",\n    \"3-0\": \"NOT_KNOWN\",\n    \"3-1\": \"Do not wish to specify (acceptable in case of Individuals only)\",\n    \"8-0\": \"TRUST\",\n    \"8-1\": \"Trust\",\n    \"9-0\": \"ESTATE\",\n    \"9-1\": \"Estate\",\n    \"10-0\": \"IRA\",\n    \"10-1\": \"Individual Retirement Account\"\n  },\n  \"cols\": 2,\n  \"rows\": 11\n}\n[/block]\n## Supported Entity Scope\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"Not Known\",\n    \"h-0\": \"Entity Scopes\",\n    \"1-0\": \"Airport\",\n    \"2-0\": \"Arts & Entertainment\",\n    \"3-0\": \"Automotive\",\n    \"4-0\": \"Bank & Financial Services\",\n    \"5-0\": \"Bar\",\n    \"6-0\": \"Book Store\",\n    \"7-0\": \"Business Services\",\n    \"8-0\": \"Religious Organization\",\n    \"9-0\": \"Club\",\n    \"10-0\": \"Community/Government\",\n    \"11-0\": \"Concert Venue\",\n    \"12-0\": \"Doctor\",\n    \"13-0\": \"Event Planning/Event Services\",\n    \"14-0\": \"Food/Grocery\",\n    \"15-0\": \"Health/Medical/Pharmacy\",\n    \"16-0\": \"Home Improvement\",\n    \"17-0\": \"Hospital/Clinic\",\n    \"18-0\": \"Hotel\",\n    \"19-0\": \"Landmark\",\n    \"20-0\": \"Lawyer\",\n    \"21-0\": \"Library\",\n    \"22-0\": \"Licensed Financial Representative\",\n    \"23-0\": \"Local Business\",\n    \"24-0\": \"Middle School\",\n    \"25-0\": \"Movie Theater\",\n    \"26-0\": \"Museum/Art Gallery\",\n    \"27-0\": \"Outdoor Gear/Sporting Goods\",\n    \"28-0\": \"Pet Services\",\n    \"29-0\": \"Professional Services\",\n    \"30-0\": \"Public Places\",\n    \"31-0\": \"Real Estate\",\n    \"32-0\": \"Restaurant/Cafe\",\n    \"33-0\": \"School\",\n    \"34-0\": \"Shopping/Retail\",\n    \"35-0\": \"Spas/Beauty/Personal Care\",\n    \"36-0\": \"Sports Venue\",\n    \"37-0\": \"Sports/Recreation/Activities\",\n    \"38-0\": \"Tours/Sightseeing\",\n    \"39-0\": \"Train Station\",\n    \"40-0\": \"Transportation\",\n    \"41-0\": \"University\",\n    \"42-0\": \"Aerospace/Defense\",\n    \"43-0\": \"Automobiles and Parts\",\n    \"44-0\": \"Bank/Financial Institution\",\n    \"45-0\": \"Biotechnology\",\n    \"46-0\": \"Cause\",\n    \"47-0\": \"Chemicals\",\n    \"48-0\": \"Community Organization\",\n    \"49-0\": \"Company\",\n    \"50-0\": \"Computers/Technology\",\n    \"51-0\": \"Consulting/Business Services\",\n    \"52-0\": \"Education\",\n    \"53-0\": \"Elementary School\",\n    \"54-0\": \"Energy/Utility\",\n    \"55-0\": \"Engineering/Construction\",\n    \"56-0\": \"Farming/Agriculture\",\n    \"57-0\": \"Food/Beverages\",\n    \"58-0\": \"Government Organization\",\n    \"59-0\": \"Health/Beauty\",\n    \"60-0\": \"Health/Medical/Pharmaceuticals\",\n    \"61-0\": \"Industrials\",\n    \"62-0\": \"Insurance Company\",\n    \"63-0\": \"Internet/Software\",\n    \"64-0\": \"Legal/Law\",\n    \"65-0\": \"Media/News/Publishing\",\n    \"66-0\": \"Mining/Materials\",\n    \"67-0\": \"Non-Governmental Organization (NGO)\",\n    \"68-0\": \"Non-Profit Organization\",\n    \"69-0\": \"Organization\",\n    \"70-0\": \"Political Organization\",\n    \"71-0\": \"Political Party\",\n    \"72-0\": \"Preschool\",\n    \"73-0\": \"Retail and Consumer Merchandise\",\n    \"74-0\": \"Small Business\",\n    \"75-0\": \"Telecommunication\",\n    \"76-0\": \"Transport/Freight\",\n    \"77-0\": \"Travel/Leisure\"\n  },\n  \"cols\": 1,\n  \"rows\": 78\n}\n[/block]\n## Physical Document Types\n\nFollowing is the complete list of physical documents that we are capable of verifying:\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"document_type\",\n    \"h-1\": \"Allowed File Types\",\n    \"0-0\": \"GOVT_ID\",\n    \"2-0\": \"SELFIE\",\n    \"3-0\": \"PROOF_OF_ADDRESS\",\n    \"0-1\": \".png / .jpg / .jpeg\",\n    \"2-1\": \".png / .jpg / .jpeg\",\n    \"3-1\": \".png / .jpg / .jpeg / .pdf\",\n    \"7-0\": \"SSN_CARD\",\n    \"7-1\": \".png / .jpg / .jpeg / .pdf\",\n    \"6-0\": \"AUTHORIZATION\",\n    \"6-1\": \".png / .jpg / .jpeg\",\n    \"8-0\": \"EIN_DOC\",\n    \"13-0\": \"AOI\",\n    \"15-0\": \"LOE\",\n    \"17-0\": \"SUBSCRIPTION_AGREEMENT\",\n    \"18-0\": \"PROMISSORY_NOTE\",\n    \"19-0\": \"LEGAL_AGREEMENT\",\n    \"20-0\": \"OTHER\",\n    \"8-1\": \".png / .jpg / .jpeg / .pdf\",\n    \"13-1\": \".png / .jpg / .jpeg / .pdf\",\n    \"15-1\": \".png / .jpg / .jpeg / .pdf\",\n    \"17-1\": \".png / .jpg / .jpeg / .pdf\",\n    \"18-1\": \".png / .jpg / .jpeg / .pdf\",\n    \"19-1\": \".png / .jpg / .jpeg / .pdf\",\n    \"20-1\": \".png / .jpg / .jpeg / .pdf\",\n    \"9-0\": \"W9_DOC\",\n    \"12-0\": \"VOIDED_CHECK\",\n    \"9-1\": \".png / .jpg / .jpeg / .pdf\",\n    \"12-1\": \".png / .jpg / .jpeg\",\n    \"4-0\": \"PROOF_OF_INCOME\",\n    \"4-1\": \".png / .jpg / .jpeg / .pdf\",\n    \"5-0\": \"PROOF_OF_ACCOUNT\",\n    \"5-1\": \".png / .jpg / .jpeg / .pdf\",\n    \"10-0\": \"W2_DOC\",\n    \"10-1\": \".png / .jpg / .jpeg / .pdf\",\n    \"14-0\": \"BYLAWS_DOC\",\n    \"14-1\": \".png / .jpg / .jpeg / .pdf\",\n    \"16-0\": \"CIP_DOC\",\n    \"16-1\": \".png / .jpg / .jpeg / .pdf\",\n    \"1-0\": \"VIDEO_AUTHORIZATION\",\n    \"1-1\": \".mov / .mp4 / .webm\",\n    \"h-2\": \"Comments\",\n    \"0-2\": \"User's government issued photo ID (driver's license, state ID, or passport).\",\n    \"1-2\": \"5 second authorization video of the user. Read more [here](https://blog.synapsepay.com/updates/video-auth).\",\n    \"2-2\": \"Picture of user's face. We are deprecating `SELFIE` for `VIDEO_AUTHORIZATION`.\",\n    \"3-2\": \"User's proof of address (i.e. Utility Bill).\",\n    \"4-2\": \"User's proof of income (i.e. Pay Stub).\",\n    \"5-2\": \"User's proof of account ownership (i.e. Bank statement).\",\n    \"6-2\": \"ACH authorization signed by the user.\",\n    \"7-2\": \"SSN Card of the user.\",\n    \"8-2\": \"Form 147C issued to the business.\",\n    \"9-2\": \"W-9 with EIN Number.\",\n    \"10-2\": \"W-2 Document\",\n    \"12-2\": \"Voided Check of the Individual/business.\",\n    \"13-2\": \"Articles of Incorporation.\",\n    \"14-2\": \"Bylaw document.\",\n    \"15-2\": \"Letter of Engagement.\",\n    \"16-2\": \"CIP & Business description document.\",\n    \"17-2\": \"Subscription agreement.\",\n    \"18-2\": \"Promissory Note.\",\n    \"19-2\": \"Any other legal agreement.\",\n    \"20-2\": \"If you don't need us to validate a physical document but still want to submit for the record, you can use OTHER as the type as well.\",\n    \"11-0\": \"W8_DOC\",\n    \"11-1\": \".png / .jpg / .jpeg / .pdf\",\n    \"11-2\": \"W-8 Document\"\n  },\n  \"cols\": 3,\n  \"rows\": 21\n}\n[/block]\n### Photo ID Requirements\n\nFollowing is a list of suggestions to improve accuracy for Photo ID uploads\n\n* Steady image\n* ID occupies most of image\n* ID and text are aligned properly \n* Plain black background\n* Min resolution ~1200 pixels, minor axis\n* Good natural lighting (avg pixel intensity ~150)\n* No flash\n* Name, address & DOB matches those supplied to us in base doc.\n* Should be in full color (no black and white images accepted)\n* We recommend maximum file size of 2 MB (most high quality JPG are around 1 MB). \n\nFollowing is a good example of what qualify Photo ID should be submitted to improve the odds of instant ID verification.\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/81ae82a-vetdes.jpg\",\n        \"vetdes.jpg\",\n        526,\n        344,\n        \"#e2dddb\"\n      ]\n    }\n  ]\n}\n[/block]\n## Virtual Document Types\n\nFollowing is the complete list of virtual documents that we are capable of verifying:\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"document_type\",\n    \"h-1\": \"Comments\",\n    \"0-0\": \"SSN\",\n    \"4-0\": \"TIN\",\n    \"0-1\": \"SSN Number of the user.\",\n    \"4-1\": \"TIN/EIN Number of the business.\",\n    \"5-1\": \"DUNS Number of the business.\",\n    \"5-0\": \"DUNS\",\n    \"6-0\": \"OTHER\",\n    \"6-1\": \"If you don't need us to validate the virtual document but still want to submit for the record, you can use OTHER as the type as well.\",\n    \"1-0\": \"PASSPORT\",\n    \"1-1\": \"Passport number of the user.\",\n    \"2-0\": \"DRIVERS_LICENSE\",\n    \"2-1\": \"Driver's license number of the user.\",\n    \"3-0\": \"PERSONAL_IDENTIFICATION\",\n    \"3-1\": \"Personal Identification number of the user.\"\n  },\n  \"cols\": 2,\n  \"rows\": 7\n}\n[/block]\n## Social Document Types\n\nFollowing is the complete list of social documents that we are capable of verifying:\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"document_type\",\n    \"0-0\": \"FACEBOOK\",\n    \"1-0\": \"LINKEDIN\",\n    \"2-0\": \"TWITTER\",\n    \"3-0\": \"OTHER\",\n    \"h-1\": \"Comments\",\n    \"0-1\": \"Facebook [user access token](https://developers.facebook.com/docs/facebook-login/access-tokens#usertokens) (preferred) or URL of the user's profile.\",\n    \"1-1\": \"LinkedIn [user access token](https://developer.linkedin.com/docs/oauth2#) (preferred) or URL of the user's profile.\",\n    \"2-1\": \"Twitter URL of the user's profile.\",\n    \"3-1\": \"If you don't need us to validate the social document but still want to submit for the record, you can use OTHER as the type as well.\"\n  },\n  \"cols\": 2,\n  \"rows\": 4\n}\n[/block]","excerpt":"","slug":"user-resources","type":"basic","title":"Users"}
User resources are generic user classes that store all KYC information, log in credentials, permissions, etc. on an individual or business. ## User Object [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 a user object</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 user object</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 where the user was created</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 user</p>\n</div></div></div><div class=\"tr\"><div class=\"td param\"><strong><span class=\"text-muted\">doc_status.</span>physical_doc<span class=\"colon\">:</span></strong></div><div class=\"td\"><strong class=\"param-type\">string</strong><div marked=\"\" class=\"ng-isolate-scope\"><p>[DEPRECATED] Status of physical document verification</p>\n</div></div></div><div class=\"tr\"><div class=\"td param\"><strong><span class=\"text-muted\">doc_status.</span>virtual_doc<span class=\"colon\">:</span></strong></div><div class=\"td\"><strong class=\"param-type\">string</strong><div marked=\"\" class=\"ng-isolate-scope\"><p>[DEPRECATED] Status of virtual document verification</p>\n</div></div></div><div class=\"tr\"><div class=\"td param\"><strong><span class=\"text-muted\">documents[</span>id<span class=\"text-muted\">]</span><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 document</p>\n</div></div></div><div class=\"tr\"><div class=\"td param\"><strong><span class=\"text-muted\">documents[</span>name<span class=\"text-muted\">]</span><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 document owner</p>\n</div></div></div><div class=\"tr\"><div class=\"td param\"><strong><span class=\"text-muted\">documents[</span>permission_scope<span class=\"text-muted\">]</span><span class=\"colon\">:</span></strong></div><div class=\"td\"><strong class=\"param-type\">string</strong><div marked=\"\" class=\"ng-isolate-scope\"><p>Permission scope of the document. More details can be <a href=\"#section-document-permission-scope\">found here</a>.</p>\n</div></div></div><div class=\"tr\"><div class=\"td param\"><strong><span class=\"text-muted\">documents.physical_docs.[</span>id<span class=\"text-muted\">]</span><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 physical document</p>\n</div></div></div><div class=\"tr\"><div class=\"td param\"><strong><span class=\"text-muted\">documents.physical_docs.[</span>document_type<span class=\"text-muted\">]</span><span class=\"colon\">:</span></strong></div><div class=\"td\"><strong class=\"param-type\">string</strong><div marked=\"\" class=\"ng-isolate-scope\"><p>Type of the physical document</p>\n</div></div></div><div class=\"tr\"><div class=\"td param\"><strong><span class=\"text-muted\">documents.physical_docs.[</span>last_updated<span class=\"text-muted\">]</span><span class=\"colon\">:</span></strong></div><div class=\"td\"><strong class=\"param-type\">integer</strong><div marked=\"\" class=\"ng-isolate-scope\"><p>Date when the document was last updated. The value is a unix timestamp in milliseconds.</p>\n</div></div></div><div class=\"tr\"><div class=\"td param\"><strong><span class=\"text-muted\">documents.physical_docs.[</span>status<span class=\"text-muted\">]</span><span class=\"colon\">:</span></strong></div><div class=\"td\"><strong class=\"param-type\">string</strong><div marked=\"\" class=\"ng-isolate-scope\"><p>Status of the physical document.</p>\n</div></div></div><div class=\"tr\"><div class=\"td param\"><strong><span class=\"text-muted\">documents.social_docs.[</span>id<span class=\"text-muted\">]</span><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 social document</p>\n</div></div></div><div class=\"tr\"><div class=\"td param\"><strong><span class=\"text-muted\">documents.social_docs.[</span>document_type<span class=\"text-muted\">]</span><span class=\"colon\">:</span></strong></div><div class=\"td\"><strong class=\"param-type\">string</strong><div marked=\"\" class=\"ng-isolate-scope\"><p>Type of the social document</p>\n</div></div></div><div class=\"tr\"><div class=\"td param\"><strong><span class=\"text-muted\">documents.social_docs.[</span>last_updated<span class=\"text-muted\">]</span><span class=\"colon\">:</span></strong></div><div class=\"td\"><strong class=\"param-type\">integer</strong><div marked=\"\" class=\"ng-isolate-scope\"><p>Date when the document was last updated. The value is a unix timestamp in milliseconds.</p>\n</div></div></div><div class=\"tr\"><div class=\"td param\"><strong><span class=\"text-muted\">documents.social_docs.[</span>status<span class=\"text-muted\">]</span><span class=\"colon\">:</span></strong></div><div class=\"td\"><strong class=\"param-type\">string</strong><div marked=\"\" class=\"ng-isolate-scope\"><p>Status of the social document.</p>\n</div></div></div><div class=\"tr\"><div class=\"td param\"><strong><span class=\"text-muted\">documents.virtual_docs.[</span>id<span class=\"text-muted\">]</span><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 virtual document</p>\n</div></div></div><div class=\"tr\"><div class=\"td param\"><strong><span class=\"text-muted\">documents.virtual_docs.[</span>document_type<span class=\"text-muted\">]</span><span class=\"colon\">:</span></strong></div><div class=\"td\"><strong class=\"param-type\">string</strong><div marked=\"\" class=\"ng-isolate-scope\"><p>Type of the virtual document</p>\n</div></div></div><div class=\"tr\"><div class=\"td param\"><strong><span class=\"text-muted\">documents.virtual_docs.[</span>last_updated<span class=\"text-muted\">]</span><span class=\"colon\">:</span></strong></div><div class=\"td\"><strong class=\"param-type\">integer</strong><div marked=\"\" class=\"ng-isolate-scope\"><p>Date when the document was last updated. The value is a unix timestamp in milliseconds</p>\n</div></div></div><div class=\"tr\"><div class=\"td param\"><strong><span class=\"text-muted\">documents.virtual_docs.[</span>status<span class=\"text-muted\">]</span><span class=\"colon\">:</span></strong></div><div class=\"td\"><strong class=\"param-type\">string</strong><div marked=\"\" class=\"ng-isolate-scope\"><p>Status of the virtual document</p>\n</div></div></div><div class=\"tr\"><div class=\"td param\"><strong><span class=\"text-muted\">extra.</span>date_joined<span class=\"colon\">:</span></strong></div><div class=\"td\"><strong class=\"param-type\">string</strong><div marked=\"\" class=\"ng-isolate-scope\"><p>Date when the user was created. The value is a unix timestamp in milliseconds</p>\n</div></div></div><div class=\"tr\"><div class=\"td param\"><strong><span class=\"text-muted\">extra.</span>is_business<span class=\"colon\">:</span></strong></div><div class=\"td\"><strong class=\"param-type\">boolean</strong><span class=\"param-default text-muted\">false</span><div marked=\"\" class=\"ng-isolate-scope\"><p>Boolean that denotes if the user object is a business account or personal</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 user</p>\n</div></div></div><div class=\"tr\"><div class=\"td param\"><strong><span class=\"text-muted\">extra.</span>cip_tag<span class=\"colon\">:</span></strong></div><div class=\"td\"><strong class=\"param-type\">integer</strong><span class=\"param-default text-muted\">1</span><div marked=\"\" class=\"ng-isolate-scope\"><p>CIP tag assigned to the user profile</p>\n</div></div></div><div class=\"tr\"><div class=\"td param\"><strong>is_hidden<span class=\"colon\">:</span></strong></div><div class=\"td\"><strong class=\"param-type\">boolean</strong><span class=\"param-default text-muted\">false</span><div marked=\"\" class=\"ng-isolate-scope\"><p>Value denotes if the user can be searched by email/name on Synapse services</p>\n</div></div></div><div class=\"tr\"><div class=\"td param\"><strong>legal_names<span class=\"colon\">:</span></strong></div><div class=\"td\"><strong class=\"param-type\">array of strings</strong><div marked=\"\" class=\"ng-isolate-scope\"><p>Legal names/Full names associated with the user object</p>\n</div></div></div><div class=\"tr\"><div class=\"td param\"><strong><span class=\"text-muted\">logins[</span>email<span class=\"text-muted\">]</span><span class=\"colon\">:</span></strong></div><div class=\"td\"><strong class=\"param-type\">string</strong><div marked=\"\" class=\"ng-isolate-scope\"><p>Email associated with the login</p>\n</div></div></div><div class=\"tr\"><div class=\"td param\"><strong><span class=\"text-muted\">logins[</span>scope<span class=\"text-muted\">]</span><span class=\"colon\">:</span></strong></div><div class=\"td\"><strong class=\"param-type\">string</strong><span class=\"param-default text-muted\">READ_AND_WRITE</span><div marked=\"\" class=\"ng-isolate-scope\"><p>Value denotes what permissions the login credentials has. Currently only two scopes are supported: <code>READ_AND_WRITE</code> &amp; <code>READ</code></p>\n</div></div></div><div class=\"tr\"><div class=\"td param\"><strong>permission<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 user permissions section below to learn more</p>\n</div></div></div><div class=\"tr\"><div class=\"td param\"><strong>phone_numbers<span class=\"colon\">:</span></strong></div><div class=\"td\"><strong class=\"param-type\">array of strings</strong><div marked=\"\" class=\"ng-isolate-scope\"><p>Phone numbers/2FA devices associated with the user</p>\n</div></div></div><div class=\"tr\"><div class=\"td param\"><strong>photos<span class=\"colon\">:</span></strong></div><div class=\"td\"><strong class=\"param-type\">array of strings</strong><div marked=\"\" class=\"ng-isolate-scope\"><p>Public avatars associated with the account</p>\n</div></div></div><div class=\"tr\"><div class=\"td param\"><strong>refresh_token<span class=\"colon\">:</span></strong></div><div class=\"td\"><strong class=\"param-type\">string</strong><div marked=\"\" class=\"ng-isolate-scope\"><p>The refresh token associated with the user and your platform</p>\n</div></div></div></div></div></div>" } [/block] ## User Types User resources can be used to register two account types: [block:parameters] { "data": { "h-0": "Account Type", "h-1": "Comment", "0-0": "Individual", "1-0": "Business", "0-1": "Used to register a personal account.", "1-1": "Used to register a business entity account." }, "cols": 2, "rows": 2 } [/block] ## Customer Identification Program (CIP) & Know Your Customer (KYC) CIP & KYC are important components of running a successful FinTech business. You can utilize Synapse's CIP tools to validate customer information and stay compliant. Depending upon the CIP program you wish to put in place, Synapse recognizes three types of documents: **1. Physical Documents:** These are images of documents being uploaded to Synapse for verification. Eg. Image of a Driver's License, Proof of Address, etc. A complete list of documents that we are capable of verifying as physical documents can be found [here](#section-physical-document-types). **2. Virtual Documents:** Documents uploaded in meta data form are called virtual documents. Eg. SSN Number, TIN, etc. A complete list of documents that we are capable of verifying as virtual documents can be found [here](#section-virtual-document-types). **3. Social Documents:** If you use Facebook, Twitter or Linkedin for singing up customers, you can supply those URLs as a form of identity as well. A complete list of documents that we are capable of verifying as social documents can be found [here](#section-social-document-types). [block:callout] { "type": "info", "title": "Some Considerations", "body": "* Please make sure that the user is submitting their full legal name as the document name. Using initials of names or non-legal names will result in KYC fails.\n* Users below 18 years of age are auto rejected as well." } [/block] ## Authentication (OAuth + Fingerprint) [Guide to user fingerprints](doc:oauth-resources) ## User Permissions Every user in Synapse has a set of permissions. The permissions dictate what the user can and cannot do within the network. You can find the user permission associated with each user under the permissions key on the user JSON response. Following are the user permissions and what they mean. [block:parameters] { "data": { "h-0": "Permission", "h-1": "Comment", "0-0": "UNVERIFIED", "1-0": "RECEIVE", "2-0": "SEND-AND-RECEIVE", "3-0": "LOCKED", "0-1": "User has been created in the system, but has not been verified yet. This means the user instance has been created, but no KYC information has been supplied on the user.", "1-1": "The user may only receive funds given the user has been created.", "2-1": "The user may send or receive funds.", "3-1": "User account has been locked by Synapse. This can happen because of multiple reasons but mostly fraud related." }, "cols": 2, "rows": 4 } [/block] ## Document Status Along with the user permissions, you can also view the status of a user's documents. Same document status conversations are followed for all 3 document types ([Physical](#section-physical-document-types), [Virtual](#section-virtual-document-types) & [Social](#section-social-document-types)). Following are different document statues and what they mean. [block:parameters] { "data": { "h-0": "Status", "h-1": "Comment", "0-0": "SUBMITTED", "1-0": "SUBMITTED|REVIEWING", "4-0": "", "0-1": "Document was submitted but not validated, resubmission not needed.", "1-1": "Document uploaded and is being reviewed.", "4-1": "", "3-0": "SUBMITTED|VALID", "3-1": "Document is valid.", "2-0": "SUBMITTED|INVALID", "2-1": "Document invalid, unable to verify (resubmission dependent upon platform CIP)." }, "cols": 2, "rows": 4 } [/block] ## Document Permission Scope Each document is given permissions based on the CIP program put in place for your gateway. This helps decide over all permissions associated with the user account. Permission scope helps determine if the user is allowed to send funds, receive funds and up to what amount (daily, weekly or monthly). If multiple documents are submitted on the profile, the worst permission scope ends up being the permissions associated with the user account. This makes sure that your CIP program is never invalidated, thus keeping you compliant. Following are the examples of different kinds of permission scopes [block:parameters] { "data": { "h-0": "Permission Scope", "h-1": "Comment", "0-0": "RECEIVE|5000|DAILY", "0-1": "The user has receive-only permissions up to 5,000 units (any currency) per day.", "1-0": "RECEIVE|5000|MONTHLY", "1-1": "The user has receive-only permissions up to 5,000 units (any currency) every month.", "2-0": "SEND|RECEIVE|5000|DAILY", "2-1": "The user can send or receive funds up to 5,000 units (any currency) every day.", "3-0": "SEND|RECEIVE|TIER|1", "3-1": "The user can send or receive funds and limits are governed by the tier 1 of your CIP.", "4-0": "SEND|RECEIVE", "4-1": "The user can send or receive funds." }, "cols": 2, "rows": 5 } [/block] ## Supported Entity Types [block:parameters] { "data": { "h-0": "Entity Types", "h-1": "Comment", "0-0": "M", "1-0": "F", "2-0": "O", "4-0": "LLC", "5-0": "CORP", "6-0": "PARTNERSHIP", "7-0": "SOLE-PROPRIETORSHIP", "0-1": "Male", "1-1": "Female", "2-1": "Other", "4-1": "Limited Liability Company", "5-1": "Corporation", "6-1": "Any type of partnership", "7-1": "Sole proprietorship", "3-0": "NOT_KNOWN", "3-1": "Do not wish to specify (acceptable in case of Individuals only)", "8-0": "TRUST", "8-1": "Trust", "9-0": "ESTATE", "9-1": "Estate", "10-0": "IRA", "10-1": "Individual Retirement Account" }, "cols": 2, "rows": 11 } [/block] ## Supported Entity Scope [block:parameters] { "data": { "0-0": "Not Known", "h-0": "Entity Scopes", "1-0": "Airport", "2-0": "Arts & Entertainment", "3-0": "Automotive", "4-0": "Bank & Financial Services", "5-0": "Bar", "6-0": "Book Store", "7-0": "Business Services", "8-0": "Religious Organization", "9-0": "Club", "10-0": "Community/Government", "11-0": "Concert Venue", "12-0": "Doctor", "13-0": "Event Planning/Event Services", "14-0": "Food/Grocery", "15-0": "Health/Medical/Pharmacy", "16-0": "Home Improvement", "17-0": "Hospital/Clinic", "18-0": "Hotel", "19-0": "Landmark", "20-0": "Lawyer", "21-0": "Library", "22-0": "Licensed Financial Representative", "23-0": "Local Business", "24-0": "Middle School", "25-0": "Movie Theater", "26-0": "Museum/Art Gallery", "27-0": "Outdoor Gear/Sporting Goods", "28-0": "Pet Services", "29-0": "Professional Services", "30-0": "Public Places", "31-0": "Real Estate", "32-0": "Restaurant/Cafe", "33-0": "School", "34-0": "Shopping/Retail", "35-0": "Spas/Beauty/Personal Care", "36-0": "Sports Venue", "37-0": "Sports/Recreation/Activities", "38-0": "Tours/Sightseeing", "39-0": "Train Station", "40-0": "Transportation", "41-0": "University", "42-0": "Aerospace/Defense", "43-0": "Automobiles and Parts", "44-0": "Bank/Financial Institution", "45-0": "Biotechnology", "46-0": "Cause", "47-0": "Chemicals", "48-0": "Community Organization", "49-0": "Company", "50-0": "Computers/Technology", "51-0": "Consulting/Business Services", "52-0": "Education", "53-0": "Elementary School", "54-0": "Energy/Utility", "55-0": "Engineering/Construction", "56-0": "Farming/Agriculture", "57-0": "Food/Beverages", "58-0": "Government Organization", "59-0": "Health/Beauty", "60-0": "Health/Medical/Pharmaceuticals", "61-0": "Industrials", "62-0": "Insurance Company", "63-0": "Internet/Software", "64-0": "Legal/Law", "65-0": "Media/News/Publishing", "66-0": "Mining/Materials", "67-0": "Non-Governmental Organization (NGO)", "68-0": "Non-Profit Organization", "69-0": "Organization", "70-0": "Political Organization", "71-0": "Political Party", "72-0": "Preschool", "73-0": "Retail and Consumer Merchandise", "74-0": "Small Business", "75-0": "Telecommunication", "76-0": "Transport/Freight", "77-0": "Travel/Leisure" }, "cols": 1, "rows": 78 } [/block] ## Physical Document Types Following is the complete list of physical documents that we are capable of verifying: [block:parameters] { "data": { "h-0": "document_type", "h-1": "Allowed File Types", "0-0": "GOVT_ID", "2-0": "SELFIE", "3-0": "PROOF_OF_ADDRESS", "0-1": ".png / .jpg / .jpeg", "2-1": ".png / .jpg / .jpeg", "3-1": ".png / .jpg / .jpeg / .pdf", "7-0": "SSN_CARD", "7-1": ".png / .jpg / .jpeg / .pdf", "6-0": "AUTHORIZATION", "6-1": ".png / .jpg / .jpeg", "8-0": "EIN_DOC", "13-0": "AOI", "15-0": "LOE", "17-0": "SUBSCRIPTION_AGREEMENT", "18-0": "PROMISSORY_NOTE", "19-0": "LEGAL_AGREEMENT", "20-0": "OTHER", "8-1": ".png / .jpg / .jpeg / .pdf", "13-1": ".png / .jpg / .jpeg / .pdf", "15-1": ".png / .jpg / .jpeg / .pdf", "17-1": ".png / .jpg / .jpeg / .pdf", "18-1": ".png / .jpg / .jpeg / .pdf", "19-1": ".png / .jpg / .jpeg / .pdf", "20-1": ".png / .jpg / .jpeg / .pdf", "9-0": "W9_DOC", "12-0": "VOIDED_CHECK", "9-1": ".png / .jpg / .jpeg / .pdf", "12-1": ".png / .jpg / .jpeg", "4-0": "PROOF_OF_INCOME", "4-1": ".png / .jpg / .jpeg / .pdf", "5-0": "PROOF_OF_ACCOUNT", "5-1": ".png / .jpg / .jpeg / .pdf", "10-0": "W2_DOC", "10-1": ".png / .jpg / .jpeg / .pdf", "14-0": "BYLAWS_DOC", "14-1": ".png / .jpg / .jpeg / .pdf", "16-0": "CIP_DOC", "16-1": ".png / .jpg / .jpeg / .pdf", "1-0": "VIDEO_AUTHORIZATION", "1-1": ".mov / .mp4 / .webm", "h-2": "Comments", "0-2": "User's government issued photo ID (driver's license, state ID, or passport).", "1-2": "5 second authorization video of the user. Read more [here](https://blog.synapsepay.com/updates/video-auth).", "2-2": "Picture of user's face. We are deprecating `SELFIE` for `VIDEO_AUTHORIZATION`.", "3-2": "User's proof of address (i.e. Utility Bill).", "4-2": "User's proof of income (i.e. Pay Stub).", "5-2": "User's proof of account ownership (i.e. Bank statement).", "6-2": "ACH authorization signed by the user.", "7-2": "SSN Card of the user.", "8-2": "Form 147C issued to the business.", "9-2": "W-9 with EIN Number.", "10-2": "W-2 Document", "12-2": "Voided Check of the Individual/business.", "13-2": "Articles of Incorporation.", "14-2": "Bylaw document.", "15-2": "Letter of Engagement.", "16-2": "CIP & Business description document.", "17-2": "Subscription agreement.", "18-2": "Promissory Note.", "19-2": "Any other legal agreement.", "20-2": "If you don't need us to validate a physical document but still want to submit for the record, you can use OTHER as the type as well.", "11-0": "W8_DOC", "11-1": ".png / .jpg / .jpeg / .pdf", "11-2": "W-8 Document" }, "cols": 3, "rows": 21 } [/block] ### Photo ID Requirements Following is a list of suggestions to improve accuracy for Photo ID uploads * Steady image * ID occupies most of image * ID and text are aligned properly * Plain black background * Min resolution ~1200 pixels, minor axis * Good natural lighting (avg pixel intensity ~150) * No flash * Name, address & DOB matches those supplied to us in base doc. * Should be in full color (no black and white images accepted) * We recommend maximum file size of 2 MB (most high quality JPG are around 1 MB). Following is a good example of what qualify Photo ID should be submitted to improve the odds of instant ID verification. [block:image] { "images": [ { "image": [ "https://files.readme.io/81ae82a-vetdes.jpg", "vetdes.jpg", 526, 344, "#e2dddb" ] } ] } [/block] ## Virtual Document Types Following is the complete list of virtual documents that we are capable of verifying: [block:parameters] { "data": { "h-0": "document_type", "h-1": "Comments", "0-0": "SSN", "4-0": "TIN", "0-1": "SSN Number of the user.", "4-1": "TIN/EIN Number of the business.", "5-1": "DUNS Number of the business.", "5-0": "DUNS", "6-0": "OTHER", "6-1": "If you don't need us to validate the virtual document but still want to submit for the record, you can use OTHER as the type as well.", "1-0": "PASSPORT", "1-1": "Passport number of the user.", "2-0": "DRIVERS_LICENSE", "2-1": "Driver's license number of the user.", "3-0": "PERSONAL_IDENTIFICATION", "3-1": "Personal Identification number of the user." }, "cols": 2, "rows": 7 } [/block] ## Social Document Types Following is the complete list of social documents that we are capable of verifying: [block:parameters] { "data": { "h-0": "document_type", "0-0": "FACEBOOK", "1-0": "LINKEDIN", "2-0": "TWITTER", "3-0": "OTHER", "h-1": "Comments", "0-1": "Facebook [user access token](https://developers.facebook.com/docs/facebook-login/access-tokens#usertokens) (preferred) or URL of the user's profile.", "1-1": "LinkedIn [user access token](https://developer.linkedin.com/docs/oauth2#) (preferred) or URL of the user's profile.", "2-1": "Twitter URL of the user's profile.", "3-1": "If you don't need us to validate the social document but still want to submit for the record, you can use OTHER as the type as well." }, "cols": 2, "rows": 4 } [/block]