{"_id":"5bd1625baabec20062a3334a","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":0,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2018-10-25T06:27:39.921Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":6,"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\nTo verify your email, phone or other document with two-factor authentication (2FA), pass the 6 digit validation code sent to the two-factor authentication device in the `mfa_answer` field.\n\n##EXAMPLE 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\\\":\\\"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    }\n  ]\n}\n[/block]\n##EXAMPLE RESPONSE\nOnce you submit the 2FA code, the document will have a status `submitted|reviewing`. To stay updated on the status of the document, [View User](https://docs.synapsefi.com/v3.2/docs/retrieve-individual-user-information) or [subscribe to User Webhooks](https://docs.synapsefi.com/v3.2/docs/subscribe-to-user-webhooks).\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\\\": 1538348513791,\\n                    \\\"status\\\": \\\"SUBMITTED|VALID\\\"\\n                }\\n            ],\\n            \\\"social_docs\\\": [\\n                {\\n                    \\\"document_type\\\": \\\"EMAIL\\\",\\n                    \\\"id\\\": \\\"2c45158f6431ca874bbe82f63d5905567854dde4d8b81539944e5779e5eee741\\\",\\n                    \\\"last_updated\\\": 1538348513792,\\n                    \\\"status\\\": \\\"SUBMITTED|VALID\\\"\\n                },\\n                {\\n                    \\\"document_type\\\": \\\"DATE\\\",\\n                    \\\"id\\\": \\\"2b52edae636ca2fbe12ab1b08a344d381dabc3d2b92844cf7a8d8b6052b26d8e\\\",\\n                    \\\"last_updated\\\": 1538348513792,\\n                    \\\"status\\\": \\\"SUBMITTED\\\"\\n                },\\n                {\\n                    \\\"document_type\\\": \\\"IP\\\",\\n                    \\\"id\\\": \\\"28d9177b22c127d9a51d8903893864accf6e553ac326704a4c0d585eaad2516a\\\",\\n                    \\\"last_updated\\\": 1538348513793,\\n                    \\\"status\\\": \\\"SUBMITTED|VALID\\\"\\n                },\\n                {\\n                    \\\"document_type\\\": \\\"PHONE_NUMBER\\\",\\n                    \\\"id\\\": \\\"fda60784d6375bc44edafaaeae149626c4c13dcb92e85a2a7a00eec2cdfd2b6f\\\",\\n                    \\\"last_updated\\\": 1538348513793,\\n                    \\\"status\\\": \\\"SUBMITTED|VALID\\\"\\n                },\\n                {\\n                    \\\"document_type\\\": \\\"FACEBOOK\\\",\\n                    \\\"id\\\": \\\"8f314a6a53f36ee569455761e49a2a7fe790d251c5611c65255befdb303602b7\\\",\\n                    \\\"last_updated\\\": 1538348513793,\\n                    \\\"status\\\": \\\"SUBMITTED|VALID\\\"\\n                },\\n                {\\n                    \\\"document_type\\\": \\\"ADDRESS\\\",\\n                    \\\"id\\\": \\\"90913d23fbdf3603e5747036e03c5998874b465aa78e7dc7dfc87a901f50891c\\\",\\n                    \\\"last_updated\\\": 1538348513793,\\n                    \\\"status\\\": \\\"SUBMITTED\\\"\\n                }\\n            ],\\n            \\\"virtual_docs\\\": [\\n                {\\n                    \\\"document_type\\\": \\\"SSN\\\",\\n                    \\\"id\\\": \\\"7cb85697d26e2c1010266fd64a22afd396167ca630a4bad21a9e8fcff865bb1c\\\",\\n                    \\\"last_updated\\\": 1538348579414,\\n                    \\\"status\\\": \\\"SUBMITTED|REVIEWING\\\"\\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\\\": 1538348579259,\\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\\\": \\\"test:::at:::synapsepay.com\\\",\\n            \\\"scope\\\": \\\"READ_AND_WRITE\\\"\\n        }\\n    ],\\n    \\\"permission\\\": \\\"SEND-AND-RECEIVE\\\",\\n    \\\"phone_numbers\\\": [\\n        \\\"901.111.1111\\\"\\n    ],\\n    \\\"photos\\\": [],\\n    \\\"refresh_token\\\": \\\"refresh_hqbzjWQnuo1dMJA2a0O0Nx6Em7tIGSXk9Z8vfFyi\\\"\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]","excerpt":"PATCH User to Verify Two Factor Authentication","slug":"verify-2fa","type":"basic","title":"Verify 2FA"}

Verify 2FA

PATCH User to Verify Two Factor Authentication

*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)* To verify your email, phone or other document with two-factor authentication (2FA), pass the 6 digit validation code sent to the two-factor authentication device in the `mfa_answer` field. ##EXAMPLE 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\":\"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" } ] } [/block] ##EXAMPLE RESPONSE Once you submit the 2FA code, the document will have a status `submitted|reviewing`. To stay updated on the status of the document, [View User](https://docs.synapsefi.com/v3.2/docs/retrieve-individual-user-information) or [subscribe to User Webhooks](https://docs.synapsefi.com/v3.2/docs/subscribe-to-user-webhooks). [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\": 1538348513791,\n \"status\": \"SUBMITTED|VALID\"\n }\n ],\n \"social_docs\": [\n {\n \"document_type\": \"EMAIL\",\n \"id\": \"2c45158f6431ca874bbe82f63d5905567854dde4d8b81539944e5779e5eee741\",\n \"last_updated\": 1538348513792,\n \"status\": \"SUBMITTED|VALID\"\n },\n {\n \"document_type\": \"DATE\",\n \"id\": \"2b52edae636ca2fbe12ab1b08a344d381dabc3d2b92844cf7a8d8b6052b26d8e\",\n \"last_updated\": 1538348513792,\n \"status\": \"SUBMITTED\"\n },\n {\n \"document_type\": \"IP\",\n \"id\": \"28d9177b22c127d9a51d8903893864accf6e553ac326704a4c0d585eaad2516a\",\n \"last_updated\": 1538348513793,\n \"status\": \"SUBMITTED|VALID\"\n },\n {\n \"document_type\": \"PHONE_NUMBER\",\n \"id\": \"fda60784d6375bc44edafaaeae149626c4c13dcb92e85a2a7a00eec2cdfd2b6f\",\n \"last_updated\": 1538348513793,\n \"status\": \"SUBMITTED|VALID\"\n },\n {\n \"document_type\": \"FACEBOOK\",\n \"id\": \"8f314a6a53f36ee569455761e49a2a7fe790d251c5611c65255befdb303602b7\",\n \"last_updated\": 1538348513793,\n \"status\": \"SUBMITTED|VALID\"\n },\n {\n \"document_type\": \"ADDRESS\",\n \"id\": \"90913d23fbdf3603e5747036e03c5998874b465aa78e7dc7dfc87a901f50891c\",\n \"last_updated\": 1538348513793,\n \"status\": \"SUBMITTED\"\n }\n ],\n \"virtual_docs\": [\n {\n \"document_type\": \"SSN\",\n \"id\": \"7cb85697d26e2c1010266fd64a22afd396167ca630a4bad21a9e8fcff865bb1c\",\n \"last_updated\": 1538348579414,\n \"status\": \"SUBMITTED|REVIEWING\"\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\": 1538348579259,\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\": \"SEND-AND-RECEIVE\",\n \"phone_numbers\": [\n \"901.111.1111\"\n ],\n \"photos\": [],\n \"refresh_token\": \"refresh_hqbzjWQnuo1dMJA2a0O0Nx6Em7tIGSXk9Z8vfFyi\"\n}", "language": "json" } ] } [/block]