{"_id":"5bb3d6e35ce6690003007646","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":"5a68eb6970ea610012bfb924","__v":21,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2018-10-02T20:36:51.881Z","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":9,"body":"##API ENDPOINT\nhttps://uat-api.synapsefi.com/v3.1/users\n\n##QUERY 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>query <span class=\\\"colon\\\">:</span> </strong> </div><div class=\\\"td\\\"> <strong class=\\\"param-type\\\">string</strong> <div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"> <p>Name/Email of the user that you wish to search</p></div></div></div><div class=\\\"tr\\\"> <div class=\\\"td param\\\"> <strong>page <span class=\\\"colon\\\">:</span> </strong> </div><div class=\\\"td\\\"> <strong class=\\\"param-type\\\">integer</strong> <div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"> <p>Page number</p></div></div></div><div class=\\\"tr\\\"> <div class=\\\"td param\\\"> <strong>per_page <span class=\\\"colon\\\">:</span> </strong> </div><div class=\\\"td\\\"> <strong class=\\\"param-type\\\">integer</strong> <span class=\\\"param-default text-muted\\\">default: 20</span> <div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"> <p>How many users do you want us to return per page.</p></div></div></div><div class=\\\"tr\\\"> <div class=\\\"td param\\\"> <strong>show_refresh_tokens <span class=\\\"colon\\\">:</span> </strong> </div><div class=\\\"td\\\"> <strong class=\\\"param-type\\\">string</strong> <span class=\\\"param-default text-muted\\\">default: yes</span> <div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"> <p>[yes/no] When dehydrating if the user object should have refresh tokens or not.</p></div></div></div></div></div></div>\"\n}\n[/block]\n\n##EXAMPLE REQUEST\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"GET /v3.1/users 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\",\n      \"language\": \"http\"\n    }\n  ]\n}\n[/block]\n##EXAMPLE RESPONSE\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"error_code\\\": \\\"0\\\",\\n    \\\"http_code\\\": \\\"200\\\",\\n    \\\"limit\\\": 20,\\n    \\\"page\\\": 1,\\n    \\\"page_count\\\": 688,\\n    \\\"success\\\": true,\\n    \\\"users\\\": [\\n        {\\n            \\\"_id\\\": \\\"594dad16838454002da3015f\\\",\\n            \\\"_links\\\": {\\n                \\\"self\\\": {\\n                    \\\"href\\\": \\\"https://uat-api.synapsefi.com/v3.1/users/594dad16838454002da3015f\\\"\\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\\\": \\\"189d2fc37c1ee5694aa62f302bcd7c0efa\\\",\\n                    \\\"name\\\": \\\"Charlie Brown\\\",\\n                    \\\"permission_scope\\\": \\\"SEND|RECEIVE|1000|DAILY\\\",\\n                    \\\"physical_docs\\\": [\\n                        {\\n                            \\\"document_type\\\": \\\"GOVT_ID\\\",\\n                            \\\"id\\\": \\\"e6b44cb52985fd9f46197bec0fb4e9c\\\",\\n                            \\\"last_updated\\\": 1498262807101,\\n                            \\\"status\\\": \\\"SUBMITTED|VALID\\\"\\n                        }\\n                    ],\\n                    \\\"social_docs\\\": [\\n                        {\\n                            \\\"document_type\\\": \\\"PHONE_NUMBER\\\",\\n                            \\\"id\\\": \\\"54522fd5748d2dedeab0034a09f91\\\",\\n                            \\\"last_updated\\\": 1498262807104,\\n                            \\\"status\\\": \\\"SUBMITTED|VALID\\\"\\n                        },\\n                        {\\n                            \\\"document_type\\\": \\\"FACEBOOK\\\",\\n                            \\\"id\\\": \\\"0c32234c59b71311b0f3057635\\\",\\n                            \\\"last_updated\\\": 1498262807104,\\n                            \\\"status\\\": \\\"SUBMITTED|VALID\\\"\\n                        },\\n                        {\\n                            \\\"document_type\\\": \\\"EMAIL\\\",\\n                            \\\"id\\\": \\\"2c45158f6431ca874bbe82\\\",\\n                            \\\"last_updated\\\": 1498262807104,\\n                            \\\"status\\\": \\\"SUBMITTED|VALID\\\"\\n                        },\\n                        {\\n                            \\\"document_type\\\": \\\"IP\\\",\\n                            \\\"id\\\": \\\"28d9177b22c127d9a51d8903\\\",\\n                            \\\"last_updated\\\": 1498262807104,\\n                            \\\"status\\\": \\\"SUBMITTED|VALID\\\"\\n                        }\\n                    ],\\n                    \\\"virtual_docs\\\": [\\n                        {\\n                            \\\"document_type\\\": \\\"SSN\\\",\\n                            \\\"id\\\": \\\"acaff78248e74aac19c2a4531\\\",\\n                            \\\"last_updated\\\": 1498262807099,\\n                            \\\"status\\\": \\\"SUBMITTED|INVALID\\\"\\n                        }\\n                    ]\\n                }\\n            ],\\n            \\\"emails\\\": [],\\n            \\\"extra\\\": {\\n                \\\"cip_tag\\\": 1,\\n                \\\"date_joined\\\": 1498262801436,\\n                \\\"extra_security\\\": true,\\n                \\\"is_business\\\": false,\\n                \\\"last_updated\\\": 1498262807088,\\n                \\\"public_note\\\": null,\\n                \\\"supp_id\\\": \\\"122eddfgbeafrfvbbb\\\"\\n            },\\n            \\\"is_hidden\\\": false,\\n            \\\"legal_names\\\": [\\n                \\\"Charlie Brown\\\"\\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.942.8167\\\"\\n            ],\\n            \\\"photos\\\": [],\\n            \\\"refresh_token\\\": \\\"refresh_xsAb2Pv9Sf8QNBq1yMhlcGoTwVJ0mEUjeF3XnILi\\\"\\n        },\\n        {\\n            ...\\n        },\\n        {\\n            ...\\n        },\\n        {   ...\\n        },\\n        ...\\n    ],\\n    \\\"users_count\\\": 13760\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\nA successful response will show the field `users_count` with the number of on-boarded users as the value.\n\n\n[block:api-header]\n{\n  \"title\": \"Additional Query Features\"\n}\n[/block]\n##SEARCHING FOR USERS\nYou can also **query** for users by email or name. When you query for name, it will filter users by `legal_names`. When you query by email it will filter users by the `logins.email`.\n\n**EXAMPLE**\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"GET /v3.1/users?query=name1 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\",\n      \"language\": \"http\"\n    }\n  ]\n}\n[/block]\n##PAGINATION\nResponses are paginated. To move through pages, add **page** as a GET parameter.\n\n**EXAMPLE**\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"GET /v3.1/users?page=1 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\",\n      \"language\": \"http\"\n    }\n  ]\n}\n[/block]\n##COMBINATION\nA combination of **page** and **query** is also available.\n\n**EXAMPLE**\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"GET /v3.1/users?query=test&amp;page=1 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\",\n      \"language\": \"http\"\n    }\n  ]\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Subscribe to user Webhooks\",\n  \"body\": \"[Subscribe to user webhooks](https://docs.synapsefi.com/v3.2/docs/subscribe-to-user-webhooks) to stay updated on the status of users.\"\n}\n[/block]","excerpt":"GET all users' information","slug":"retrieve-all-platform-users","type":"basic","title":"View All Users"}

View All Users

GET all users' information

##API ENDPOINT https://uat-api.synapsefi.com/v3.1/users ##QUERY PARAMETER [block:html] { "html": "<div class=\"api-manager\"> <div class=\"param-table\"> <div class=\"table\"> <div class=\"tr\"> <div class=\"td param\"> <strong>query <span class=\"colon\">:</span> </strong> </div><div class=\"td\"> <strong class=\"param-type\">string</strong> <div marked=\"\" class=\"ng-isolate-scope\"> <p>Name/Email of the user that you wish to search</p></div></div></div><div class=\"tr\"> <div class=\"td param\"> <strong>page <span class=\"colon\">:</span> </strong> </div><div class=\"td\"> <strong class=\"param-type\">integer</strong> <div marked=\"\" class=\"ng-isolate-scope\"> <p>Page number</p></div></div></div><div class=\"tr\"> <div class=\"td param\"> <strong>per_page <span class=\"colon\">:</span> </strong> </div><div class=\"td\"> <strong class=\"param-type\">integer</strong> <span class=\"param-default text-muted\">default: 20</span> <div marked=\"\" class=\"ng-isolate-scope\"> <p>How many users do you want us to return per page.</p></div></div></div><div class=\"tr\"> <div class=\"td param\"> <strong>show_refresh_tokens <span class=\"colon\">:</span> </strong> </div><div class=\"td\"> <strong class=\"param-type\">string</strong> <span class=\"param-default text-muted\">default: yes</span> <div marked=\"\" class=\"ng-isolate-scope\"> <p>[yes/no] When dehydrating if the user object should have refresh tokens or not.</p></div></div></div></div></div></div>" } [/block] ##EXAMPLE REQUEST [block:code] { "codes": [ { "code": "GET /v3.1/users 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", "language": "http" } ] } [/block] ##EXAMPLE RESPONSE [block:code] { "codes": [ { "code": "{\n \"error_code\": \"0\",\n \"http_code\": \"200\",\n \"limit\": 20,\n \"page\": 1,\n \"page_count\": 688,\n \"success\": true,\n \"users\": [\n {\n \"_id\": \"594dad16838454002da3015f\",\n \"_links\": {\n \"self\": {\n \"href\": \"https://uat-api.synapsefi.com/v3.1/users/594dad16838454002da3015f\"\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\": \"189d2fc37c1ee5694aa62f302bcd7c0efa\",\n \"name\": \"Charlie Brown\",\n \"permission_scope\": \"SEND|RECEIVE|1000|DAILY\",\n \"physical_docs\": [\n {\n \"document_type\": \"GOVT_ID\",\n \"id\": \"e6b44cb52985fd9f46197bec0fb4e9c\",\n \"last_updated\": 1498262807101,\n \"status\": \"SUBMITTED|VALID\"\n }\n ],\n \"social_docs\": [\n {\n \"document_type\": \"PHONE_NUMBER\",\n \"id\": \"54522fd5748d2dedeab0034a09f91\",\n \"last_updated\": 1498262807104,\n \"status\": \"SUBMITTED|VALID\"\n },\n {\n \"document_type\": \"FACEBOOK\",\n \"id\": \"0c32234c59b71311b0f3057635\",\n \"last_updated\": 1498262807104,\n \"status\": \"SUBMITTED|VALID\"\n },\n {\n \"document_type\": \"EMAIL\",\n \"id\": \"2c45158f6431ca874bbe82\",\n \"last_updated\": 1498262807104,\n \"status\": \"SUBMITTED|VALID\"\n },\n {\n \"document_type\": \"IP\",\n \"id\": \"28d9177b22c127d9a51d8903\",\n \"last_updated\": 1498262807104,\n \"status\": \"SUBMITTED|VALID\"\n }\n ],\n \"virtual_docs\": [\n {\n \"document_type\": \"SSN\",\n \"id\": \"acaff78248e74aac19c2a4531\",\n \"last_updated\": 1498262807099,\n \"status\": \"SUBMITTED|INVALID\"\n }\n ]\n }\n ],\n \"emails\": [],\n \"extra\": {\n \"cip_tag\": 1,\n \"date_joined\": 1498262801436,\n \"extra_security\": true,\n \"is_business\": false,\n \"last_updated\": 1498262807088,\n \"public_note\": null,\n \"supp_id\": \"122eddfgbeafrfvbbb\"\n },\n \"is_hidden\": false,\n \"legal_names\": [\n \"Charlie Brown\"\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.942.8167\"\n ],\n \"photos\": [],\n \"refresh_token\": \"refresh_xsAb2Pv9Sf8QNBq1yMhlcGoTwVJ0mEUjeF3XnILi\"\n },\n {\n ...\n },\n {\n ...\n },\n { ...\n },\n ...\n ],\n \"users_count\": 13760\n}", "language": "json" } ] } [/block] A successful response will show the field `users_count` with the number of on-boarded users as the value. [block:api-header] { "title": "Additional Query Features" } [/block] ##SEARCHING FOR USERS You can also **query** for users by email or name. When you query for name, it will filter users by `legal_names`. When you query by email it will filter users by the `logins.email`. **EXAMPLE** [block:code] { "codes": [ { "code": "GET /v3.1/users?query=name1 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", "language": "http" } ] } [/block] ##PAGINATION Responses are paginated. To move through pages, add **page** as a GET parameter. **EXAMPLE** [block:code] { "codes": [ { "code": "GET /v3.1/users?page=1 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", "language": "http" } ] } [/block] ##COMBINATION A combination of **page** and **query** is also available. **EXAMPLE** [block:code] { "codes": [ { "code": "GET /v3.1/users?query=test&amp;page=1 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", "language": "http" } ] } [/block] [block:callout] { "type": "info", "title": "Subscribe to user Webhooks", "body": "[Subscribe to user webhooks](https://docs.synapsefi.com/v3.2/docs/subscribe-to-user-webhooks) to stay updated on the status of users." } [/block]