{"_id":"5bd152f8b23767000d4db695","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":"5babd73fa0ab3e0003ead030","project":"59f79e3c584eb200345ceafc","version":"5ba178b00a916500030c6a21","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2018-09-26T19:00:15.801Z","from_sync":false,"order":2,"slug":"userskyc","title":"Users/KYC"},"user":"5557e76e512c300d007730d1","__v":26,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2018-10-25T05:22:00.588Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"settings":"","results":{"codes":[{"status":200,"language":"json","code":"{\n    \"_id\": \"594e0fa2838454002ea317a0\",\n    \"_links\": {\n        \"self\": {\n            \"href\": \"https://uat-api.synapsefi.com/v3.1/users/594e0fa2838454002ea317a0\"\n        }\n    },\n    \"client\": {\n        \"id\": \"589acd9ecb3cd400fa75ac06\",\n        \"name\": \"SynapseFI\"\n    },\n    \"doc_status\": {\n        \"physical_doc\": \"SUBMITTED|VALID\",\n        \"virtual_doc\": \"SUBMITTED|VALID\"\n    },\n    \"documents\": [\n        {\n            \"id\": \"2a4a5957a3a62aaac1a0dd0edcae96ea2cdee688ec6337b20745eed8869e3ac8\",\n            \"name\": \"Test User\",\n            \"permission_scope\": \"SEND|RECEIVE|1000|DAILY\",\n            \"physical_docs\": [\n                {\n                    \"document_type\": \"GOVT_ID\",\n                    \"id\": \"c486c2cb8c1bce695fcfae3197e14aa5b8ddec184c2779d00d581abee5d9a04c\",\n                    \"last_updated\": 1498288034877,\n                    \"status\": \"SUBMITTED|VALID\"\n                }\n            ],\n            \"social_docs\": [\n                {\n                    \"document_type\": \"FACEBOOK\",\n                    \"id\": \"8f314a6a53f36ee569455761e49a2a7fe790d251c5611c65255befdb303602b7\",\n                    \"last_updated\": 1498288034880,\n                    \"status\": \"SUBMITTED|VALID\"\n                },\n                {\n                    \"document_type\": \"PHONE_NUMBER\",\n                    \"id\": \"fda60784d6375bc44edafaaeae149626c4c13dcb92e85a2a7a00eec2cdfd2b6f\",\n                    \"last_updated\": 1498288034880,\n                    \"status\": \"SUBMITTED|VALID\"\n                },\n                {\n                    \"document_type\": \"EMAIL\",\n                    \"id\": \"2c45158f6431ca874bbe82f63d5905567854dde4d8b81539944e5779e5eee741\",\n                    \"last_updated\": 1498288034880,\n                    \"status\": \"SUBMITTED|VALID\"\n                },\n                {\n                    \"document_type\": \"IP\",\n                    \"id\": \"28d9177b22c127d9a51d8903893864accf6e553ac326704a4c0d585eaad2516a\",\n                    \"last_updated\": 1498288034880,\n                    \"status\": \"SUBMITTED|VALID\"\n                }\n            ],\n            \"virtual_docs\": [\n                {\n                    \"document_type\": \"SSN\",\n                    \"id\": \"ee596c2896dddc19b76c07a184fe7d3cf5a04b8e94b9108190cac7890739017f\",\n                    \"last_updated\": 1498288034875,\n                    \"status\": \"SUBMITTED|VALID\"\n                }\n            ]\n        }\n    ],\n    \"emails\": [],\n    \"extra\": {\n        \"cip_tag\": 1,\n        \"date_joined\": 1498288029784,\n        \"extra_security\": false,\n        \"is_business\": false,\n        \"last_updated\": 1498288034864,\n        \"public_note\": null,\n        \"supp_id\": \"122eddfgbeafrfvbbb\"\n    },\n    \"is_hidden\": false,\n    \"legal_names\": [\n        \"Test User\"\n    ],\n    \"logins\": [\n        {\n            \"email\": \"test:::at:::synapsefi.com\",\n            \"scope\": \"READ_AND_WRITE\"\n        }\n    ],\n    \"permission\": \"SEND-AND-RECEIVE\",\n    \"phone_numbers\": [\n        \"[email protected]\",\n        \"901.111.1111\"\n    ],\n    \"photos\": [],\n    \"refresh_token\": \"refresh_ehG7YBS8ZiD0sLa6PQHMUxryovVkJzElC5gWROXq\"\n}","name":"w/o full_dehydrate"},{"code":"{\n    \"_id\": \"594e0fa2838454002ea317a0\",\n    \"_links\": {\n        \"self\": {\n            \"href\": \"https://uat-api.synapsefi.com/v3.1/users/594e0fa2838454002ea317a0\"\n        }\n    },\n    \"_v\": 2,\n    \"client\": {\n        \"id\": \"589acd9ecb3cd400fa75ac06\",\n        \"name\": \"SynapseFI\"\n    },\n    \"doc_status\": {\n        \"physical_doc\": \"SUBMITTED|VALID\",\n        \"virtual_doc\": \"SUBMITTED|VALID\"\n    },\n    \"documents\": [\n        {\n            \"address_city\": \"SF\",\n            \"address_country_code\": \"US\",\n            \"address_postal_code\": \"94114\",\n            \"address_street\": \"1 Market St.\",\n            \"address_subdivision\": \"CA\",\n            \"alias\": \"Test\",\n            \"day\": 2,\n            \"email\": \"[email protected]\",\n            \"entity_scope\": \"Arts & Entertainment\",\n            \"entity_type\": \"M\",\n            \"id\": \"2a4a5957a3a62aaac1a0dd0edcae96ea2cdee688ec6337b20745eed8869e3ac8\",\n            \"ip\": \"::1\",\n            \"month\": 5,\n            \"name\": \"Test User\",\n            \"permission_scope\": \"SEND|RECEIVE|1000|DAILY\",\n            \"phone_number\": \"901.111.1111\",\n            \"physical_docs\": [\n                {\n                    \"document_type\": \"GOVT_ID\",\n                    \"document_value\": \"https://cdn.synapsepay.com/uploads/2017/06/24/DioeVvEbMOfxzpLGZNCPnJKYuHQ7t89s4FBmTk00rRgyc35WXU.gif\",\n                    \"id\": \"c486c2cb8c1bce695fcfae3197e14aa5b8ddec184c2779d00d581abee5d9a04c\",\n                    \"last_updated\": 1498288034877,\n                    \"meta\": {\n                        \"matches\": {\n                            \"address\": \"not_found\",\n                            \"dob\": \"not_found\",\n                            \"identification\": \"not_found\"\n                        }\n                    },\n                    \"status\": \"SUBMITTED|VALID\"\n                }\n            ],\n            \"screening_results\": {\n                \"561\": \"NO_MATCH\",\n                \"aucl\": \"NO_MATCH\",\n                \"concern_location\": \"NO_MATCH\",\n                \"dpl\": \"NO_MATCH\",\n                \"dtc\": \"NO_MATCH\",\n                \"el\": \"NO_MATCH\",\n                \"eucl\": \"NO_MATCH\",\n                \"fatf_non_cooperative_jurisdiction\": \"NO_MATCH\",\n                \"fbi_bank_robbers\": \"NO_MATCH\",\n                \"fbi_counter_intelligence\": \"NO_MATCH\",\n                \"fbi_crimes_against_children\": \"NO_MATCH\",\n                \"fbi_criminal_enterprise_investigations\": \"NO_MATCH\",\n                \"fbi_cyber\": \"NO_MATCH\",\n                \"fbi_domestic_terrorism\": \"NO_MATCH\",\n                \"fbi_human_trafficking\": \"NO_MATCH\",\n                \"fbi_murders\": \"NO_MATCH\",\n                \"fbi_violent_crimes\": \"NO_MATCH\",\n                \"fbi_wanted_terrorists\": \"NO_MATCH\",\n                \"fbi_white_collar\": \"NO_MATCH\",\n                \"fincen_red_list\": \"NO_MATCH\",\n                \"fse\": \"NO_MATCH\",\n                \"fto_sanctions\": \"NO_MATCH\",\n                \"futures_sanctions\": \"NO_MATCH\",\n                \"hkma_sanctions\": \"NO_MATCH\",\n                \"hm_treasury_sanctions\": \"NO_MATCH\",\n                \"isn\": \"NO_MATCH\",\n                \"mas_sanctions\": \"NO_MATCH\",\n                \"monitored_location\": \"NO_MATCH\",\n                \"ns-isa\": \"NO_MATCH\",\n                \"ofac_561_list\": \"NO_MATCH\",\n                \"ofac_eo13645\": \"NO_MATCH\",\n                \"ofac_fse\": \"NO_MATCH\",\n                \"ofac_fse_ir\": \"NO_MATCH\",\n                \"ofac_fse_sy\": \"NO_MATCH\",\n                \"ofac_isa\": \"NO_MATCH\",\n                \"ofac_ns_isa\": \"NO_MATCH\",\n                \"ofac_plc\": \"NO_MATCH\",\n                \"ofac_sdn\": \"NO_MATCH\",\n                \"ofac_ssi\": \"NO_MATCH\",\n                \"ofac_syria\": \"NO_MATCH\",\n                \"ofac_ukraine_eo13662\": \"NO_MATCH\",\n                \"osfi\": \"NO_MATCH\",\n                \"pep\": \"NO_MATCH\",\n                \"plc\": \"NO_MATCH\",\n                \"primary_concern\": \"NO_MATCH\",\n                \"sdn\": \"NO_MATCH\",\n                \"ssi\": \"NO_MATCH\",\n                \"tel_sanctions\": \"NO_MATCH\",\n                \"ukcl\": \"NO_MATCH\",\n                \"uvl\": \"NO_MATCH\"\n            },\n            \"social_docs\": [\n                {\n                    \"document_type\": \"FACEBOOK\",\n                    \"document_value\": \"https://www.facebook.com/valid\",\n                    \"id\": \"8f314a6a53f36ee569455761e49a2a7fe790d251c5611c65255befdb303602b7\",\n                    \"last_updated\": 1498288034880,\n                    \"meta\": {\n                        \"matches\": {\n                            \"address\": \"not_found\",\n                            \"dob\": \"not_found\",\n                            \"identification\": \"not_found\"\n                        }\n                    },\n                    \"status\": \"SUBMITTED|VALID\"\n                },\n                {\n                    \"document_type\": \"PHONE_NUMBER\",\n                    \"document_value\": \"901.111.1111\",\n                    \"id\": \"fda60784d6375bc44edafaaeae149626c4c13dcb92e85a2a7a00eec2cdfd2b6f\",\n                    \"last_updated\": 1498288034880,\n                    \"meta\": {\n                        \"matches\": {\n                            \"address\": \"not_found\",\n                            \"dob\": \"not_found\",\n                            \"identification\": \"not_found\"\n                        }\n                    },\n                    \"status\": \"SUBMITTED|VALID\"\n                },\n                {\n                    \"document_type\": \"EMAIL\",\n                    \"document_value\": \"[email protected]\",\n                    \"id\": \"2c45158f6431ca874bbe82f63d5905567854dde4d8b81539944e5779e5eee741\",\n                    \"last_updated\": 1498288034880,\n                    \"meta\": {\n                        \"matches\": {\n                            \"address\": \"not_found\",\n                            \"dob\": \"not_found\",\n                            \"identification\": \"not_found\"\n                        }\n                    },\n                    \"status\": \"SUBMITTED|VALID\"\n                },\n                {\n                    \"document_type\": \"IP\",\n                    \"document_value\": \"::1\",\n                    \"id\": \"28d9177b22c127d9a51d8903893864accf6e553ac326704a4c0d585eaad2516a\",\n                    \"last_updated\": 1498288034880,\n                    \"meta\": {\n                        \"matches\": {\n                            \"address\": \"not_found\",\n                            \"dob\": \"not_found\",\n                            \"identification\": \"not_found\"\n                        }\n                    },\n                    \"status\": \"SUBMITTED|VALID\"\n                }\n            ],\n            \"virtual_docs\": [\n                {\n                    \"document_type\": \"SSN\",\n                    \"document_value\": \"2222\",\n                    \"id\": \"ee596c2896dddc19b76c07a184fe7d3cf5a04b8e94b9108190cac7890739017f\",\n                    \"last_updated\": 1498288034875,\n                    \"meta\": {\n                        \"matches\": {\n                            \"address\": \"not_found\",\n                            \"dob\": \"not_found\",\n                            \"identification\": \"not_found\"\n                        }\n                    },\n                    \"status\": \"SUBMITTED|VALID\"\n                }\n            ],\n            \"year\": 1989\n        }\n    ],\n    \"emails\": [],\n    \"extra\": {\n        \"cip_tag\": 1,\n        \"date_joined\": 1498288029784,\n        \"extra_security\": false,\n        \"is_business\": false,\n        \"last_updated\": 1498288034864,\n        \"note\": null,\n        \"public_note\": null,\n        \"supp_id\": \"122eddfgbeafrfvbbb\"\n    },\n    \"flag\": \"NOT-FLAGGED\",\n    \"ips\": [\n        \"127.0.0.1\"\n    ],\n    \"is_hidden\": false,\n    \"legal_names\": [\n        \"Test User\"\n    ],\n    \"logins\": [\n        {\n            \"email\": \"[email protected]\",\n            \"scope\": \"READ_AND_WRITE\"\n        }\n    ],\n    \"permission\": \"SEND-AND-RECEIVE\",\n    \"phone_numbers\": [\n        \"[email protected]\",\n        \"901.111.1111\"\n    ],\n    \"photos\": [],\n    \"refresh_token\": \"refresh_ehG7YBS8ZiD0sLa6PQHMUxryovVkJzElC5gWROXq\"\n}","language":"json","name":"with full_dehydrate","status":200}]},"method":"get","examples":{"codes":[{"language":"http","code":"GET /v3.1/users/594e0fa2838454002ea317a0 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: |e83cf6ddcf778e37bfe3d48fc78a6502062fc\nContent-Type: application/json","name":"w/o full_dehydrate"},{"name":"with full_dehydrate","language":"http","code":"GET /v3.1/users/594e0fa2838454002ea317a0?full_dehydrate=yes 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: |e83cf6ddcf778e37bfe3d48fc78a6502062fc\nContent-Type: application/json"}]},"auth":"required","params":[{"_id":"58acf7f3e570c62500512a63","ref":"","in":"query","required":false,"desc":"[yes/no] Full Dehydrate yes will return back user's KYC info.","default":"no","type":"string","name":"full_dehydrate"},{"_id":"590ca984ae0df70f0044026c","ref":"","in":"path","required":true,"desc":"The user ID of the user you wish to retrieve","default":"","type":"string","name":"user_id"}],"url":"/v3.1/users/:user_id"},"isReference":false,"order":5,"body":"*Previous Step: [Create User](https://docs.synapsefi.com/v3.2/docs/create-a-user-1) and [OAuth User](https://docs.synapsefi.com/v3.2/docs/oauth-the-user)*\n\nUse this endpoint to update a user's KYC or permissions.\n\n##API ENDPOINT\nhttps://uat-api.synapsefi.com/v3.1/users/:user_id\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 update documents for</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>documents <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>User KYC documents. See full Base Document or Sub-Document Object below </p></div></div></div></div></div></div>\"\n}\n[/block]\n##BASE DOCUMENT 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>refresh_token <span class=\\\"colon\\\">:</span> </strong> </div><div class=\\\"td\\\"> <strong class=\\\"param-type\\\">string</strong> <div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"> <p>User's refresh_token</p></div></div></div><div class=\\\"tr\\\"> <div class=\\\"td param\\\"> <strong> <span class=\\\"text-muted\\\">update.</span>legal_name <span class=\\\"colon\\\">:</span> </strong> </div><div class=\\\"td\\\"> <strong class=\\\"param-type\\\">string</strong> <div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"> <p>Updated legal name of the user</p></div></div></div><div class=\\\"tr\\\"> <div class=\\\"td param\\\"> <strong> <span class=\\\"text-muted\\\">update.login.</span>email <span class=\\\"colon\\\">:</span> </strong> </div><div class=\\\"td\\\"> <strong class=\\\"param-type\\\">string</strong> <div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"> <p>Updated login email of the user</p></div></div></div><div class=\\\"tr\\\"> <div class=\\\"td param\\\"> <strong> <span class=\\\"text-muted\\\">update.login.</span>password <span class=\\\"colon\\\">:</span> </strong> </div><div class=\\\"td\\\"> <strong class=\\\"param-type\\\">string</strong> <div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"> <p>Updated login password of the user</p></div></div></div><div class=\\\"tr\\\"> <div class=\\\"td param\\\"> <strong> <span class=\\\"text-muted\\\">update.login.</span>read_only <span class=\\\"colon\\\">:</span> </strong> </div><div class=\\\"td\\\"> <strong class=\\\"param-type\\\">boolean</strong> <div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"> <p>If this is a read-only user or an admin user. By default all users added via this API call are admin users</p></div></div></div><div class=\\\"tr\\\"> <div class=\\\"td param\\\"> <strong> <span class=\\\"text-muted\\\">update.</span>phone_number <span class=\\\"colon\\\">:</span> </strong> </div><div class=\\\"td\\\"> <strong class=\\\"param-type\\\">string</strong> <div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"> <p>Updated phone number of the user</p></div></div></div><div class=\\\"tr\\\"> <div class=\\\"td param\\\"> <strong> <span class=\\\"text-muted\\\">update.remove_login.</span>email <span class=\\\"colon\\\">:</span> </strong> </div><div class=\\\"td\\\"> <strong class=\\\"param-type\\\">string</strong> <div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"> <p>Login email that you wish to remove</p></div></div></div><div class=\\\"tr\\\"> <div class=\\\"td param\\\"> <strong> <span class=\\\"text-muted\\\">update.</span>remove_phone_number <span class=\\\"colon\\\">:</span> </strong> </div><div class=\\\"td\\\"> <strong class=\\\"param-type\\\">string</strong> <div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"> <p>Phone number that you wish to remove</p></div></div></div><div class=\\\"tr\\\"> <div class=\\\"td param\\\"> <strong> <span class=\\\"text-muted\\\">update.</span>remove_legal_name <span class=\\\"colon\\\">:</span> </strong> </div><div class=\\\"td\\\"> <strong class=\\\"param-type\\\">string</strong> <div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"> <p>Legal name that you wish to remove</p></div></div></div><div class=\\\"tr\\\"> <div class=\\\"td param\\\"> <strong> <span class=\\\"text-muted\\\">update.</span>cip_tag <span class=\\\"colon\\\">:</span> </strong> </div><div class=\\\"td\\\"> <strong class=\\\"param-type\\\">integer</strong> <div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"> <p>Updated CIP tag of the user</p></div></div></div><div class=\\\"tr\\\"> <div class=\\\"td param\\\"> <strong> <span class=\\\"text-muted\\\">update.</span>is_hidden <span class=\\\"colon\\\">:</span> </strong> </div><div class=\\\"td\\\"> <strong class=\\\"param-type\\\">boolean</strong> <div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"> <p>Value denotes if the user can be searched by email/name on Synapse services</p></div></div></div><div class=\\\"tr\\\"> <div class=\\\"td param\\\"> <strong> <span class=\\\"text-muted\\\">update.</span>public_note <span class=\\\"colon\\\">:</span> </strong> </div><div class=\\\"td\\\"> <strong class=\\\"param-type\\\">string</strong> <div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"> <p>Any note that you wish to attach to the user (returned with user object)</p></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>This field only accepts <code>LOCKED</code> and <code>MAKE-IT-GO-AWAY</code>. Any other value will be ignored. <code>LOCKED</code> locks a user account, <code>MAKE-IT-GO-AWAY</code> will unindex it.</p></div></div></div></div></div></div>\"\n}\n[/block]\n##SUB-DOCUMENT 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>document_type <span class=\\\"colon\\\">:</span> </strong> <div class=\\\"required\\\">required</div></div><div class=\\\"td\\\"> <strong class=\\\"param-type\\\">string</strong> <div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"> <p>Type of Document (<a href=\\\"https://docs.synapsefi.com/v3.2/docs/know-your-customer-kyc#section-physical-documents\\\">physical</a>, <a href=\\\"https://docs.synapsefi.com/v3.2/docs/know-your-customer-kyc#section-virtual-documents\\\">virtual</a>, or <a href=\\\"https://docs.synapsefi.com/v3.2/docs/know-your-customer-kyc#section-social-documents\\\">social</a>) </p></div></div></div><div class=\\\"tr\\\"> <div class=\\\"td param\\\"> <strong>document_value <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>Value of the document (if physical document, submit the padded base64 value of the file you wish to upload)</p></div></div></div></div></div></div>\"\n}\n[/block]\n##Example #1: Update User Documents\n\n##UPDATE USER REQUEST\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"PATCH /v3.1/users/594e0fa2838454002ea317a0 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  \\\"documents\\\":[{\\n    \\\"id\\\":\\\"2a4a5957a3a62aaac1a0dd0edcae96ea2cdee688ec6337b20745eed8869e3ac8\\\",\\n    \\\"email\\\":\\\"[email protected]\\\"\\n  }]\\n}\",\n      \"language\": \"http\",\n      \"name\": \"Update Base Document\"\n    },\n    {\n      \"code\": \"PATCH /v3.1/users/594e0fa2838454002ea317a0 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  \\\"documents\\\":[{\\n    \\\"id\\\":\\\"d02f580c1335a625ab2da2d7e53472d4e7fd664e633387654ebebe15ea696c91\\\",\\n    \\\"virtual_docs\\\":[{\\n      \\\"id\\\":\\\"ee596c2896dddc19b76c07a184fe7d3cf5a04b8e94b9108190cac7890739017f\\\",\\n      \\\"document_value\\\":\\\"111-11-2222\\\",\\n      \\\"document_type\\\":\\\"SSN\\\"\\n    }]\\n  }]\\n}\",\n      \"language\": \"http\",\n      \"name\": \"Update Sub-Document\"\n    },\n    {\n      \"code\": \"PATCH /v3.1/users/594e0fa2838454002ea317a0 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  \\\"documents\\\":[{\\n    \\\"id\\\":\\\"d02f580c1335a625ab2da2d7e53472d4e7fd664e633387654ebebe15ea696c91\\\",\\n    \\\"social_docs\\\":[{\\n      \\\"id\\\":\\\"ee596c2896dddc19b76c07a184fe7d3cf5a04b8e94b9108190cac7890739017f\\\",\\n      \\\"document_value\\\":\\\"901.111.1111\\\",\\n      \\\"document_type\\\":\\\"PHONE_NUMBER_2FA\\\",\\n      \\\"mfa_answer\\\":\\\"123456\\\"\\n    }]\\n  }]\\n}\",\n      \"language\": \"http\",\n      \"name\": \"Verify MFA\"\n    }\n  ]\n}\n[/block]\n##UPDATE USER RESPONSE\nA successful response will include the full user object with the updated fields.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"_id\\\": \\\"589dc8817562960020cb00c9\\\",\\n    \\\"_links\\\": {\\n        \\\"self\\\": {\\n            \\\"href\\\": \\\"https://uat-api.synapsefi.com/v3.1/users/589dc8817562960020cb00c9\\\"\\n        }\\n    },\\n    \\\"client\\\": {\\n        \\\"id\\\": \\\"589acd9ecb3cd400fa75ac06\\\",\\n        \\\"name\\\": \\\"SynapseFI\\\"\\n    },\\n    \\\"doc_status\\\": {\\n        \\\"physical_doc\\\": \\\"SUBMITTED|VALID\\\",\\n        \\\"virtual_doc\\\": \\\"SUBMITTED|VALID\\\"\\n    },\\n    \\\"documents\\\": [\\n        {\\n            \\\"id\\\": \\\"bd8d12dc29d2730c6d7b6156d022990b0d20d89bc89da9fb76df82955f587d8f\\\",\\n            \\\"name\\\": \\\"Charlie Brown\\\",\\n            \\\"permission_scope\\\": \\\"SEND|RECEIVE|1000|DAILY\\\",\\n            \\\"physical_docs\\\": [\\n                {\\n                    \\\"document_type\\\": \\\"GOVT_ID\\\",\\n                    \\\"id\\\": \\\"4b3b10ab8990e43900d626ad23dbf7457c1d19671ffc07bbf74364d7171a7e65\\\",\\n                    \\\"last_updated\\\": 1486735666802,\\n                    \\\"status\\\": \\\"SUBMITTED|VALID\\\"\\n                },\\n                {\\n                    \\\"document_type\\\": \\\"GOVT_ID\\\",\\n                    \\\"id\\\": \\\"d40fa68bf1963d3368bd5e805e5ec3dfbe99c26f6968c837fb8484ba9564e164\\\",\\n                    \\\"last_updated\\\": 1486735662589,\\n                    \\\"status\\\": \\\"SUBMITTED|VALID\\\"\\n                }\\n            ],\\n            \\\"social_docs\\\": [\\n                {\\n                    \\\"document_type\\\": \\\"PHONE_NUMBER\\\",\\n                    \\\"id\\\": \\\"9dd593112385cfed22721355d279e79d33acd2c48cffe9c007b6c4acbfde826c\\\",\\n                    \\\"last_updated\\\": 1486735666804,\\n                    \\\"status\\\": \\\"SUBMITTED|VALID\\\"\\n                },\\n                {\\n                    \\\"document_type\\\": \\\"EMAIL\\\",\\n                    \\\"id\\\": \\\"fcabe34058c1abee46eb2d2bb29cc91aa2ac422e6bc0c2f934d191c9226cc7f2\\\",\\n                    \\\"last_updated\\\": 1486735666804,\\n                    \\\"status\\\": \\\"SUBMITTED|VALID\\\"\\n                },\\n                {\\n                    \\\"document_type\\\": \\\"FACEBOOK\\\",\\n                    \\\"id\\\": \\\"0c32234c59b71311b0f3057635c206e6a0d39ecef0bc336fe2bb375c92968117\\\",\\n                    \\\"last_updated\\\": 1486735666804,\\n                    \\\"status\\\": \\\"SUBMITTED|VALID\\\"\\n                }\\n            ],\\n            \\\"virtual_docs\\\": [\\n                {\\n                    \\\"document_type\\\": \\\"SSN\\\",\\n                    \\\"id\\\": \\\"ee596c2896dddc19b76c07a184fe7d3cf5a04b8e94b9108190cac7890739017f\\\",\\n                    \\\"last_updated\\\": 1486735666800,\\n                    \\\"status\\\": \\\"SUBMITTED|VALID\\\"\\n                }\\n            ]\\n        },\\n        {\\n            \\\"id\\\": \\\"bd8d12dc29d2730c6d7b6156d022990b0d20d89bc89da9fb76df82955f587d8f\\\",\\n            \\\"name\\\": \\\"Charlie Brown\\\",\\n            \\\"permission_scope\\\": \\\"SEND|RECEIVE|1000|DAILY\\\",\\n            \\\"physical_docs\\\": [\\n                {\\n                    \\\"document_type\\\": \\\"GOVT_ID\\\",\\n                    \\\"id\\\": \\\"1449fd8d4caf0c232b73dde6f3572f45b47414be9bf87f02b5bdbacf662ae0ae\\\",\\n                    \\\"last_updated\\\": 1486735666153,\\n                    \\\"status\\\": \\\"SUBMITTED|VALID\\\"\\n                }\\n            ],\\n            \\\"social_docs\\\": [\\n                {\\n                    \\\"document_type\\\": \\\"EMAIL\\\",\\n                    \\\"id\\\": \\\"fcabe34058c1abee46eb2d2bb29cc91aa2ac422e6bc0c2f934d191c9226cc7f2\\\",\\n                    \\\"last_updated\\\": 1486735747561,\\n                    \\\"status\\\": \\\"SUBMITTED|VALID\\\"\\n                },\\n                {\\n                    \\\"document_type\\\": \\\"FACEBOOK\\\",\\n                    \\\"id\\\": \\\"0c32234c59b71311b0f3057635c206e6a0d39ecef0bc336fe2bb375c92968117\\\",\\n                    \\\"last_updated\\\": 1486735666155,\\n                    \\\"status\\\": \\\"SUBMITTED|VALID\\\"\\n                },\\n                {\\n                    \\\"document_type\\\": \\\"PHONE_NUMBER\\\",\\n                    \\\"id\\\": \\\"9dd593112385cfed22721355d279e79d33acd2c48cffe9c007b6c4acbfde826c\\\",\\n                    \\\"last_updated\\\": 1486735748216,\\n                    \\\"status\\\": \\\"SUBMITTED|VALID\\\"\\n                }\\n            ],\\n            \\\"virtual_docs\\\": [\\n                {\\n                    \\\"document_type\\\": \\\"SSN\\\",\\n                    \\\"id\\\": \\\"ee596c2896dddc19b76c07a184fe7d3cf5a04b8e94b9108190cac7890739017f\\\",\\n                    \\\"last_updated\\\": 1486735666151,\\n                    \\\"status\\\": \\\"SUBMITTED|VALID\\\"\\n                }\\n            ]\\n        }\\n    ],\\n    \\\"emails\\\": [],\\n    \\\"extra\\\": {\\n        \\\"cip_tag\\\": 1,\\n        \\\"date_joined\\\": 1486735484343,\\n        \\\"extra_security\\\": false,\\n        \\\"is_business\\\": false,\\n        \\\"last_updated\\\": 1486735747555,\\n        \\\"supp_id\\\": \\\"122eddfgbeafrfvbbb\\\"\\n    },\\n    \\\"is_hidden\\\": false,\\n    \\\"legal_names\\\": [\\n        \\\"Test User\\\"\\n    ],\\n    \\\"logins\\\": [\\n        {\\n            \\\"email\\\": \\\"[email protected]\\\",\\n            \\\"scope\\\": \\\"READ_AND_WRITE\\\"\\n        }\\n    ],\\n    \\\"permission\\\": \\\"SEND-AND-RECEIVE\\\",\\n    \\\"phone_numbers\\\": [\\n        \\\"901.942.8167\\\"\\n    ],\\n    \\\"photos\\\": [],\\n    \\\"refresh_token\\\": \\\"refresh_e36f207aef9911e6aac58a1ffc37511f\\\"\\n}\",\n      \"language\": \"json\",\n      \"name\": \"200 Okay\"\n    }\n  ]\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"warning\",\n  \"title\": \"Base Document & Sub-Document IDs\",\n  \"body\": \"Base document or sub-document IDs will change if the document is updated.\"\n}\n[/block]\n##Example #2: Lock/Remove User\n\n\n**Lock the User:** To lock a user from performing further actions with the API, PATCH User permission to “LOCKED” status. Once locked, you cannot unlock the user. If a user was locked mistakenly, please contact Synapse for steps to unlock. Refund user’s funds before locking.\n\n**Remove the User:** To remove a user and prevent the user from performing further API actions. Patch the permission to “MAKE-IT-GO-AWAY” which will unindex the user. Refund user’s funds before you remove the user.\n\nPlease note, we still retain user data after a user is removed (for compliance purposes).\n\n##REMOVE USER REQUEST\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"PATCH /v3.1/users/5bb155ddaadcf02b6d902620 HTTP/1.1\\nHost: uat-api.synapsefi.com\\nX-SP-GATEWAY: client_id_25BpgCAt3ymEJdkF8iwrKVlOqLZ071IehGTUaz6n|client_secret_bomP73QBiEHwJvO6tMCGXy8NUlgLj14xakzf50RK\\nX-SP-USER-IP: 127.0.0.1\\nX-SP-USER: oauth_GXAMgwobNa0J9ziqW2hnfBycU0m7RTFS5sEeP1l8|\\nContent-Type: application/json\\n\\n{\\n  \\\"permission\\\":\\\"MAKE-IT-GO-AWAY\\\"\\n}\",\n      \"language\": \"http\"\n    }\n  ]\n}\n[/block]\n##REMOVE USER RESPONSE\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"_id\\\": \\\"5bb155ddaadcf02b6d902620\\\",\\n    \\\"_links\\\": {\\n        \\\"self\\\": {\\n            \\\"href\\\": \\\"https://uat-api.synapsefi.com/v3.1/users/5bb155ddaadcf02b6d902620\\\"\\n        }\\n    },\\n    \\\"client\\\": {\\n        \\\"id\\\": \\\"5ade26b4567a900029e2afd2\\\",\\n        \\\"name\\\": \\\"YY Test Account\\\"\\n    },\\n    \\\"doc_status\\\": {\\n        \\\"physical_doc\\\": \\\"SUBMITTED|VALID\\\",\\n        \\\"virtual_doc\\\": \\\"SUBMITTED|VALID\\\"\\n    },\\n    \\\"documents\\\": [\\n        {\\n            \\\"entity_scope\\\": \\\"Arts & Entertainment\\\",\\n            \\\"entity_type\\\": \\\"M\\\",\\n            \\\"id\\\": \\\"2a4a5957a3a62aaac1a0dd0edcae96ea2cdee688ec6337b20745eed8869e3ac8\\\",\\n            \\\"name\\\": \\\"Test User\\\",\\n            \\\"permission_scope\\\": \\\"SEND|RECEIVE\\\",\\n            \\\"physical_docs\\\": [\\n                {\\n                    \\\"document_type\\\": \\\"GOVT_ID\\\",\\n                    \\\"id\\\": \\\"67ebd5ba7ca3c6b4857710d51a9399794c5958bb9c27bd54a3212179a48f7e84\\\",\\n                    \\\"last_updated\\\": 1538348584971,\\n                    \\\"status\\\": \\\"SUBMITTED|VALID\\\"\\n                }\\n            ],\\n            \\\"social_docs\\\": [\\n                {\\n                    \\\"document_type\\\": \\\"EMAIL\\\",\\n                    \\\"id\\\": \\\"2c45158f6431ca874bbe82f63d5905567854dde4d8b81539944e5779e5eee741\\\",\\n                    \\\"last_updated\\\": 1538348584986,\\n                    \\\"status\\\": \\\"SUBMITTED|VALID\\\"\\n                },\\n                {\\n                    \\\"document_type\\\": \\\"DATE\\\",\\n                    \\\"id\\\": \\\"2b52edae636ca2fbe12ab1b08a344d381dabc3d2b92844cf7a8d8b6052b26d8e\\\",\\n                    \\\"last_updated\\\": 1538348584986,\\n                    \\\"status\\\": \\\"SUBMITTED\\\"\\n                },\\n                {\\n                    \\\"document_type\\\": \\\"IP\\\",\\n                    \\\"id\\\": \\\"28d9177b22c127d9a51d8903893864accf6e553ac326704a4c0d585eaad2516a\\\",\\n                    \\\"last_updated\\\": 1538348584986,\\n                    \\\"status\\\": \\\"SUBMITTED|VALID\\\"\\n                },\\n                {\\n                    \\\"document_type\\\": \\\"PHONE_NUMBER\\\",\\n                    \\\"id\\\": \\\"fda60784d6375bc44edafaaeae149626c4c13dcb92e85a2a7a00eec2cdfd2b6f\\\",\\n                    \\\"last_updated\\\": 1538348584987,\\n                    \\\"status\\\": \\\"SUBMITTED|VALID\\\"\\n                },\\n                {\\n                    \\\"document_type\\\": \\\"FACEBOOK\\\",\\n                    \\\"id\\\": \\\"8f314a6a53f36ee569455761e49a2a7fe790d251c5611c65255befdb303602b7\\\",\\n                    \\\"last_updated\\\": 1538348584987,\\n                    \\\"status\\\": \\\"SUBMITTED|VALID\\\"\\n                },\\n                {\\n                    \\\"document_type\\\": \\\"ADDRESS\\\",\\n                    \\\"id\\\": \\\"90913d23fbdf3603e5747036e03c5998874b465aa78e7dc7dfc87a901f50891c\\\",\\n                    \\\"last_updated\\\": 1538348584987,\\n                    \\\"status\\\": \\\"SUBMITTED\\\"\\n                }\\n            ],\\n            \\\"virtual_docs\\\": [\\n                {\\n                    \\\"document_type\\\": \\\"SSN\\\",\\n                    \\\"id\\\": \\\"7cb85697d26e2c1010266fd64a22afd396167ca630a4bad21a9e8fcff865bb1c\\\",\\n                    \\\"last_updated\\\": 1538348584948,\\n                    \\\"status\\\": \\\"SUBMITTED|VALID\\\"\\n                }\\n            ]\\n        }\\n    ],\\n    \\\"emails\\\": [],\\n    \\\"extra\\\": {\\n        \\\"cip_tag\\\": 1,\\n        \\\"date_joined\\\": 1538348500635,\\n        \\\"extra_security\\\": false,\\n        \\\"is_business\\\": false,\\n        \\\"last_updated\\\": 1538367080540,\\n        \\\"public_note\\\": null,\\n        \\\"supp_id\\\": \\\"my_user_id\\\"\\n    },\\n    \\\"is_hidden\\\": false,\\n    \\\"legal_names\\\": [\\n        \\\"Test User\\\"\\n    ],\\n    \\\"logins\\\": [\\n        {\\n            \\\"email\\\": \\\"[email protected]\\\",\\n            \\\"scope\\\": \\\"READ_AND_WRITE\\\"\\n        }\\n    ],\\n    \\\"permission\\\": \\\"MAKE-IT-GO-AWAY\\\",\\n    \\\"phone_numbers\\\": [\\n        \\\"901.111.1111\\\"\\n    ],\\n    \\\"photos\\\": [],\\n    \\\"refresh_token\\\": \\\"refresh_hqbzjWQnuo1dMJA2a0O0Nx6Em7tIGSXk9Z8vfFyi\\\"\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\nA successful response will include the full user object with the `permission` field updated with the new status.","excerpt":"PATCH User to update existing user's documents or permissions","slug":"update-documents","type":"basic","title":"Update User"}

Update User

PATCH User to update existing user's documents or permissions

*Previous Step: [Create User](https://docs.synapsefi.com/v3.2/docs/create-a-user-1) and [OAuth User](https://docs.synapsefi.com/v3.2/docs/oauth-the-user)* Use this endpoint to update a user's KYC or permissions. ##API ENDPOINT https://uat-api.synapsefi.com/v3.1/users/:user_id ##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 update documents for</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>documents <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>User KYC documents. See full Base Document or Sub-Document Object below </p></div></div></div></div></div></div>" } [/block] ##BASE DOCUMENT OBJECT [block:html] { "html": "<div class=\"api-manager\"> <div class=\"param-table\"> <div class=\"table\"> <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>User's refresh_token</p></div></div></div><div class=\"tr\"> <div class=\"td param\"> <strong> <span class=\"text-muted\">update.</span>legal_name <span class=\"colon\">:</span> </strong> </div><div class=\"td\"> <strong class=\"param-type\">string</strong> <div marked=\"\" class=\"ng-isolate-scope\"> <p>Updated legal name of the user</p></div></div></div><div class=\"tr\"> <div class=\"td param\"> <strong> <span class=\"text-muted\">update.login.</span>email <span class=\"colon\">:</span> </strong> </div><div class=\"td\"> <strong class=\"param-type\">string</strong> <div marked=\"\" class=\"ng-isolate-scope\"> <p>Updated login email of the user</p></div></div></div><div class=\"tr\"> <div class=\"td param\"> <strong> <span class=\"text-muted\">update.login.</span>password <span class=\"colon\">:</span> </strong> </div><div class=\"td\"> <strong class=\"param-type\">string</strong> <div marked=\"\" class=\"ng-isolate-scope\"> <p>Updated login password of the user</p></div></div></div><div class=\"tr\"> <div class=\"td param\"> <strong> <span class=\"text-muted\">update.login.</span>read_only <span class=\"colon\">:</span> </strong> </div><div class=\"td\"> <strong class=\"param-type\">boolean</strong> <div marked=\"\" class=\"ng-isolate-scope\"> <p>If this is a read-only user or an admin user. By default all users added via this API call are admin users</p></div></div></div><div class=\"tr\"> <div class=\"td param\"> <strong> <span class=\"text-muted\">update.</span>phone_number <span class=\"colon\">:</span> </strong> </div><div class=\"td\"> <strong class=\"param-type\">string</strong> <div marked=\"\" class=\"ng-isolate-scope\"> <p>Updated phone number of the user</p></div></div></div><div class=\"tr\"> <div class=\"td param\"> <strong> <span class=\"text-muted\">update.remove_login.</span>email <span class=\"colon\">:</span> </strong> </div><div class=\"td\"> <strong class=\"param-type\">string</strong> <div marked=\"\" class=\"ng-isolate-scope\"> <p>Login email that you wish to remove</p></div></div></div><div class=\"tr\"> <div class=\"td param\"> <strong> <span class=\"text-muted\">update.</span>remove_phone_number <span class=\"colon\">:</span> </strong> </div><div class=\"td\"> <strong class=\"param-type\">string</strong> <div marked=\"\" class=\"ng-isolate-scope\"> <p>Phone number that you wish to remove</p></div></div></div><div class=\"tr\"> <div class=\"td param\"> <strong> <span class=\"text-muted\">update.</span>remove_legal_name <span class=\"colon\">:</span> </strong> </div><div class=\"td\"> <strong class=\"param-type\">string</strong> <div marked=\"\" class=\"ng-isolate-scope\"> <p>Legal name that you wish to remove</p></div></div></div><div class=\"tr\"> <div class=\"td param\"> <strong> <span class=\"text-muted\">update.</span>cip_tag <span class=\"colon\">:</span> </strong> </div><div class=\"td\"> <strong class=\"param-type\">integer</strong> <div marked=\"\" class=\"ng-isolate-scope\"> <p>Updated CIP tag of the user</p></div></div></div><div class=\"tr\"> <div class=\"td param\"> <strong> <span class=\"text-muted\">update.</span>is_hidden <span class=\"colon\">:</span> </strong> </div><div class=\"td\"> <strong class=\"param-type\">boolean</strong> <div marked=\"\" class=\"ng-isolate-scope\"> <p>Value denotes if the user can be searched by email/name on Synapse services</p></div></div></div><div class=\"tr\"> <div class=\"td param\"> <strong> <span class=\"text-muted\">update.</span>public_note <span class=\"colon\">:</span> </strong> </div><div class=\"td\"> <strong class=\"param-type\">string</strong> <div marked=\"\" class=\"ng-isolate-scope\"> <p>Any note that you wish to attach to the user (returned with user object)</p></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>This field only accepts <code>LOCKED</code> and <code>MAKE-IT-GO-AWAY</code>. Any other value will be ignored. <code>LOCKED</code> locks a user account, <code>MAKE-IT-GO-AWAY</code> will unindex it.</p></div></div></div></div></div></div>" } [/block] ##SUB-DOCUMENT OBJECT [block:html] { "html": "<div class=\"api-manager\"> <div class=\"param-table\"> <div class=\"table\"> <div class=\"tr\"> <div class=\"td param\"> <strong>document_type <span class=\"colon\">:</span> </strong> <div class=\"required\">required</div></div><div class=\"td\"> <strong class=\"param-type\">string</strong> <div marked=\"\" class=\"ng-isolate-scope\"> <p>Type of Document (<a href=\"https://docs.synapsefi.com/v3.2/docs/know-your-customer-kyc#section-physical-documents\">physical</a>, <a href=\"https://docs.synapsefi.com/v3.2/docs/know-your-customer-kyc#section-virtual-documents\">virtual</a>, or <a href=\"https://docs.synapsefi.com/v3.2/docs/know-your-customer-kyc#section-social-documents\">social</a>) </p></div></div></div><div class=\"tr\"> <div class=\"td param\"> <strong>document_value <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>Value of the document (if physical document, submit the padded base64 value of the file you wish to upload)</p></div></div></div></div></div></div>" } [/block] ##Example #1: Update User Documents ##UPDATE USER REQUEST [block:code] { "codes": [ { "code": "PATCH /v3.1/users/594e0fa2838454002ea317a0 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 \"documents\":[{\n \"id\":\"2a4a5957a3a62aaac1a0dd0edcae96ea2cdee688ec6337b20745eed8869e3ac8\",\n \"email\":\"[email protected]\"\n }]\n}", "language": "http", "name": "Update Base Document" }, { "code": "PATCH /v3.1/users/594e0fa2838454002ea317a0 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 \"documents\":[{\n \"id\":\"d02f580c1335a625ab2da2d7e53472d4e7fd664e633387654ebebe15ea696c91\",\n \"virtual_docs\":[{\n \"id\":\"ee596c2896dddc19b76c07a184fe7d3cf5a04b8e94b9108190cac7890739017f\",\n \"document_value\":\"111-11-2222\",\n \"document_type\":\"SSN\"\n }]\n }]\n}", "language": "http", "name": "Update Sub-Document" }, { "code": "PATCH /v3.1/users/594e0fa2838454002ea317a0 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 \"documents\":[{\n \"id\":\"d02f580c1335a625ab2da2d7e53472d4e7fd664e633387654ebebe15ea696c91\",\n \"social_docs\":[{\n \"id\":\"ee596c2896dddc19b76c07a184fe7d3cf5a04b8e94b9108190cac7890739017f\",\n \"document_value\":\"901.111.1111\",\n \"document_type\":\"PHONE_NUMBER_2FA\",\n \"mfa_answer\":\"123456\"\n }]\n }]\n}", "language": "http", "name": "Verify MFA" } ] } [/block] ##UPDATE USER RESPONSE A successful response will include the full user object with the updated fields. [block:code] { "codes": [ { "code": "{\n \"_id\": \"589dc8817562960020cb00c9\",\n \"_links\": {\n \"self\": {\n \"href\": \"https://uat-api.synapsefi.com/v3.1/users/589dc8817562960020cb00c9\"\n }\n },\n \"client\": {\n \"id\": \"589acd9ecb3cd400fa75ac06\",\n \"name\": \"SynapseFI\"\n },\n \"doc_status\": {\n \"physical_doc\": \"SUBMITTED|VALID\",\n \"virtual_doc\": \"SUBMITTED|VALID\"\n },\n \"documents\": [\n {\n \"id\": \"bd8d12dc29d2730c6d7b6156d022990b0d20d89bc89da9fb76df82955f587d8f\",\n \"name\": \"Charlie Brown\",\n \"permission_scope\": \"SEND|RECEIVE|1000|DAILY\",\n \"physical_docs\": [\n {\n \"document_type\": \"GOVT_ID\",\n \"id\": \"4b3b10ab8990e43900d626ad23dbf7457c1d19671ffc07bbf74364d7171a7e65\",\n \"last_updated\": 1486735666802,\n \"status\": \"SUBMITTED|VALID\"\n },\n {\n \"document_type\": \"GOVT_ID\",\n \"id\": \"d40fa68bf1963d3368bd5e805e5ec3dfbe99c26f6968c837fb8484ba9564e164\",\n \"last_updated\": 1486735662589,\n \"status\": \"SUBMITTED|VALID\"\n }\n ],\n \"social_docs\": [\n {\n \"document_type\": \"PHONE_NUMBER\",\n \"id\": \"9dd593112385cfed22721355d279e79d33acd2c48cffe9c007b6c4acbfde826c\",\n \"last_updated\": 1486735666804,\n \"status\": \"SUBMITTED|VALID\"\n },\n {\n \"document_type\": \"EMAIL\",\n \"id\": \"fcabe34058c1abee46eb2d2bb29cc91aa2ac422e6bc0c2f934d191c9226cc7f2\",\n \"last_updated\": 1486735666804,\n \"status\": \"SUBMITTED|VALID\"\n },\n {\n \"document_type\": \"FACEBOOK\",\n \"id\": \"0c32234c59b71311b0f3057635c206e6a0d39ecef0bc336fe2bb375c92968117\",\n \"last_updated\": 1486735666804,\n \"status\": \"SUBMITTED|VALID\"\n }\n ],\n \"virtual_docs\": [\n {\n \"document_type\": \"SSN\",\n \"id\": \"ee596c2896dddc19b76c07a184fe7d3cf5a04b8e94b9108190cac7890739017f\",\n \"last_updated\": 1486735666800,\n \"status\": \"SUBMITTED|VALID\"\n }\n ]\n },\n {\n \"id\": \"bd8d12dc29d2730c6d7b6156d022990b0d20d89bc89da9fb76df82955f587d8f\",\n \"name\": \"Charlie Brown\",\n \"permission_scope\": \"SEND|RECEIVE|1000|DAILY\",\n \"physical_docs\": [\n {\n \"document_type\": \"GOVT_ID\",\n \"id\": \"1449fd8d4caf0c232b73dde6f3572f45b47414be9bf87f02b5bdbacf662ae0ae\",\n \"last_updated\": 1486735666153,\n \"status\": \"SUBMITTED|VALID\"\n }\n ],\n \"social_docs\": [\n {\n \"document_type\": \"EMAIL\",\n \"id\": \"fcabe34058c1abee46eb2d2bb29cc91aa2ac422e6bc0c2f934d191c9226cc7f2\",\n \"last_updated\": 1486735747561,\n \"status\": \"SUBMITTED|VALID\"\n },\n {\n \"document_type\": \"FACEBOOK\",\n \"id\": \"0c32234c59b71311b0f3057635c206e6a0d39ecef0bc336fe2bb375c92968117\",\n \"last_updated\": 1486735666155,\n \"status\": \"SUBMITTED|VALID\"\n },\n {\n \"document_type\": \"PHONE_NUMBER\",\n \"id\": \"9dd593112385cfed22721355d279e79d33acd2c48cffe9c007b6c4acbfde826c\",\n \"last_updated\": 1486735748216,\n \"status\": \"SUBMITTED|VALID\"\n }\n ],\n \"virtual_docs\": [\n {\n \"document_type\": \"SSN\",\n \"id\": \"ee596c2896dddc19b76c07a184fe7d3cf5a04b8e94b9108190cac7890739017f\",\n \"last_updated\": 1486735666151,\n \"status\": \"SUBMITTED|VALID\"\n }\n ]\n }\n ],\n \"emails\": [],\n \"extra\": {\n \"cip_tag\": 1,\n \"date_joined\": 1486735484343,\n \"extra_security\": false,\n \"is_business\": false,\n \"last_updated\": 1486735747555,\n \"supp_id\": \"122eddfgbeafrfvbbb\"\n },\n \"is_hidden\": false,\n \"legal_names\": [\n \"Test User\"\n ],\n \"logins\": [\n {\n \"email\": \"[email protected]\",\n \"scope\": \"READ_AND_WRITE\"\n }\n ],\n \"permission\": \"SEND-AND-RECEIVE\",\n \"phone_numbers\": [\n \"901.942.8167\"\n ],\n \"photos\": [],\n \"refresh_token\": \"refresh_e36f207aef9911e6aac58a1ffc37511f\"\n}", "language": "json", "name": "200 Okay" } ] } [/block] [block:callout] { "type": "warning", "title": "Base Document & Sub-Document IDs", "body": "Base document or sub-document IDs will change if the document is updated." } [/block] ##Example #2: Lock/Remove User **Lock the User:** To lock a user from performing further actions with the API, PATCH User permission to “LOCKED” status. Once locked, you cannot unlock the user. If a user was locked mistakenly, please contact Synapse for steps to unlock. Refund user’s funds before locking. **Remove the User:** To remove a user and prevent the user from performing further API actions. Patch the permission to “MAKE-IT-GO-AWAY” which will unindex the user. Refund user’s funds before you remove the user. Please note, we still retain user data after a user is removed (for compliance purposes). ##REMOVE USER REQUEST [block:code] { "codes": [ { "code": "PATCH /v3.1/users/5bb155ddaadcf02b6d902620 HTTP/1.1\nHost: uat-api.synapsefi.com\nX-SP-GATEWAY: client_id_25BpgCAt3ymEJdkF8iwrKVlOqLZ071IehGTUaz6n|client_secret_bomP73QBiEHwJvO6tMCGXy8NUlgLj14xakzf50RK\nX-SP-USER-IP: 127.0.0.1\nX-SP-USER: oauth_GXAMgwobNa0J9ziqW2hnfBycU0m7RTFS5sEeP1l8|\nContent-Type: application/json\n\n{\n \"permission\":\"MAKE-IT-GO-AWAY\"\n}", "language": "http" } ] } [/block] ##REMOVE USER RESPONSE [block:code] { "codes": [ { "code": "{\n \"_id\": \"5bb155ddaadcf02b6d902620\",\n \"_links\": {\n \"self\": {\n \"href\": \"https://uat-api.synapsefi.com/v3.1/users/5bb155ddaadcf02b6d902620\"\n }\n },\n \"client\": {\n \"id\": \"5ade26b4567a900029e2afd2\",\n \"name\": \"YY Test Account\"\n },\n \"doc_status\": {\n \"physical_doc\": \"SUBMITTED|VALID\",\n \"virtual_doc\": \"SUBMITTED|VALID\"\n },\n \"documents\": [\n {\n \"entity_scope\": \"Arts & Entertainment\",\n \"entity_type\": \"M\",\n \"id\": \"2a4a5957a3a62aaac1a0dd0edcae96ea2cdee688ec6337b20745eed8869e3ac8\",\n \"name\": \"Test User\",\n \"permission_scope\": \"SEND|RECEIVE\",\n \"physical_docs\": [\n {\n \"document_type\": \"GOVT_ID\",\n \"id\": \"67ebd5ba7ca3c6b4857710d51a9399794c5958bb9c27bd54a3212179a48f7e84\",\n \"last_updated\": 1538348584971,\n \"status\": \"SUBMITTED|VALID\"\n }\n ],\n \"social_docs\": [\n {\n \"document_type\": \"EMAIL\",\n \"id\": \"2c45158f6431ca874bbe82f63d5905567854dde4d8b81539944e5779e5eee741\",\n \"last_updated\": 1538348584986,\n \"status\": \"SUBMITTED|VALID\"\n },\n {\n \"document_type\": \"DATE\",\n \"id\": \"2b52edae636ca2fbe12ab1b08a344d381dabc3d2b92844cf7a8d8b6052b26d8e\",\n \"last_updated\": 1538348584986,\n \"status\": \"SUBMITTED\"\n },\n {\n \"document_type\": \"IP\",\n \"id\": \"28d9177b22c127d9a51d8903893864accf6e553ac326704a4c0d585eaad2516a\",\n \"last_updated\": 1538348584986,\n \"status\": \"SUBMITTED|VALID\"\n },\n {\n \"document_type\": \"PHONE_NUMBER\",\n \"id\": \"fda60784d6375bc44edafaaeae149626c4c13dcb92e85a2a7a00eec2cdfd2b6f\",\n \"last_updated\": 1538348584987,\n \"status\": \"SUBMITTED|VALID\"\n },\n {\n \"document_type\": \"FACEBOOK\",\n \"id\": \"8f314a6a53f36ee569455761e49a2a7fe790d251c5611c65255befdb303602b7\",\n \"last_updated\": 1538348584987,\n \"status\": \"SUBMITTED|VALID\"\n },\n {\n \"document_type\": \"ADDRESS\",\n \"id\": \"90913d23fbdf3603e5747036e03c5998874b465aa78e7dc7dfc87a901f50891c\",\n \"last_updated\": 1538348584987,\n \"status\": \"SUBMITTED\"\n }\n ],\n \"virtual_docs\": [\n {\n \"document_type\": \"SSN\",\n \"id\": \"7cb85697d26e2c1010266fd64a22afd396167ca630a4bad21a9e8fcff865bb1c\",\n \"last_updated\": 1538348584948,\n \"status\": \"SUBMITTED|VALID\"\n }\n ]\n }\n ],\n \"emails\": [],\n \"extra\": {\n \"cip_tag\": 1,\n \"date_joined\": 1538348500635,\n \"extra_security\": false,\n \"is_business\": false,\n \"last_updated\": 1538367080540,\n \"public_note\": null,\n \"supp_id\": \"my_user_id\"\n },\n \"is_hidden\": false,\n \"legal_names\": [\n \"Test User\"\n ],\n \"logins\": [\n {\n \"email\": \"[email protected]\",\n \"scope\": \"READ_AND_WRITE\"\n }\n ],\n \"permission\": \"MAKE-IT-GO-AWAY\",\n \"phone_numbers\": [\n \"901.111.1111\"\n ],\n \"photos\": [],\n \"refresh_token\": \"refresh_hqbzjWQnuo1dMJA2a0O0Nx6Em7tIGSXk9Z8vfFyi\"", "language": "json" } ] } [/block] A successful response will include the full user object with the `permission` field updated with the new status.