{"_id":"55fa409d8065a10d004e5bda","project":"54e405191e51932d006abc39","version":{"_id":"55fa37c88065a10d004e5bb6","project":"54e405191e51932d006abc39","__v":9,"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"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"REST V3","version_clean":"3.1.0","version":"3.1"},"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","__v":28,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-09-17T04:25:01.798Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"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"}]},"method":"get","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:::synapsepay.com\",\n            \"scope\": \"READ_AND_WRITE\"\n        }\n    ],\n    \"permission\": \"SEND-AND-RECEIVE\",\n    \"phone_numbers\": [\n        \"test@synapsepay.com\",\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\": \"test@test.com\",\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\": \"test@test.com\",\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\": \"test@synapsepay.com\",\n            \"scope\": \"READ_AND_WRITE\"\n        }\n    ],\n    \"permission\": \"SEND-AND-RECEIVE\",\n    \"phone_numbers\": [\n        \"test@synapsepay.com\",\n        \"901.111.1111\"\n    ],\n    \"photos\": [],\n    \"refresh_token\": \"refresh_ehG7YBS8ZiD0sLa6PQHMUxryovVkJzElC5gWROXq\"\n}","language":"json","name":"with full_dehydrate","status":200}]},"settings":"","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":true,"order":4,"body":"","excerpt":"GET user information","slug":"get-user","type":"endpoint","title":"Get User"}