{"_id":"59f79e3c584eb200345cebbe","user":"5820c42f6256350f00fc6e31","version":{"_id":"59f79e3c584eb200345ceaff","project":"59f79e3c584eb200345ceafc","__v":1,"createdAt":"2015-09-17T03:47:20.956Z","releaseDate":"2015-09-17T03:47:20.956Z","categories":["59f79e3c584eb200345ceb3a","59f79e3c584eb200345ceb3b","59f79e3c584eb200345ceb3c","59f79e3c584eb200345ceb3d","59f79e3c584eb200345ceb3e","59f79e3c584eb200345ceb3f","59f79e3c584eb200345ceb45","59f79e3c584eb200345ceb46","59f79e3c584eb200345ceb48","59f79e3c584eb200345ceb49","5aa21b60c0bda0002d1568b6"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"3.1.0","version":"3.1"},"project":"59f79e3c584eb200345ceafc","__v":1,"parentDoc":null,"category":{"_id":"59f79e3c584eb200345ceb3b","version":"59f79e3c584eb200345ceaff","project":"59f79e3c584eb200345ceafc","__v":0,"sync":{"url":"","isSync":false},"reference":true,"createdAt":"2015-06-06T05:42:37.534Z","from_sync":false,"order":3,"slug":"users","title":"Users"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-03-16T06:09:59.483Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"settings":"","examples":{"codes":[{"name":"Delete Base Doc","language":"http","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    \"permission_scope\":\"DELETE_DOCUMENT\"\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    \"physical_docs\":[{\n    \t\"id\":\"c486c2cb8c1bce695fcfae3197e14aa5b8ddec184c2779d00d581abee5d9a04c\",\n    \t\"document_type\":\"DELETE_DOCUMENT\",\n    \t\"document_value\":\"data:image/gif;base64,SUQs==\"\n    }]\n  }]\n}","language":"http","name":"Delete Sub-Document"}]},"method":"patch","results":{"codes":[{"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\": \"d02f580c1335a625ab2da2d7e53472d4e7fd664e633387654ebebe15ea696c91\",\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\": 1498288964176,\n                    \"status\": \"SUBMITTED|VALID\"\n                },\n                {\n                    \"document_type\": \"GOVT_ID\",\n                    \"id\": \"70e3f32d8feba746347b5c0d820e8d7a218b955afbb612291a0a9922c93e8277\",\n                    \"last_updated\": 1498288964176,\n                    \"status\": \"SUBMITTED|VALID\"\n                }\n            ],\n            \"social_docs\": [\n                {\n                    \"document_type\": \"FACEBOOK\",\n                    \"id\": \"8f314a6a53f36ee569455761e49a2a7fe790d251c5611c65255befdb303602b7\",\n                    \"last_updated\": 1498288964179,\n                    \"status\": \"SUBMITTED|VALID\"\n                },\n                {\n                    \"document_type\": \"PHONE_NUMBER\",\n                    \"id\": \"fda60784d6375bc44edafaaeae149626c4c13dcb92e85a2a7a00eec2cdfd2b6f\",\n                    \"last_updated\": 1498288964179,\n                    \"status\": \"SUBMITTED|VALID\"\n                },\n                {\n                    \"document_type\": \"EMAIL\",\n                    \"id\": \"2c45158f6431ca874bbe82f63d5905567854dde4d8b81539944e5779e5eee741\",\n                    \"last_updated\": 1498288964179,\n                    \"status\": \"SUBMITTED|VALID\"\n                },\n                {\n                    \"document_type\": \"IP\",\n                    \"id\": \"28d9177b22c127d9a51d8903893864accf6e553ac326704a4c0d585eaad2516a\",\n                    \"last_updated\": 1498288964179,\n                    \"status\": \"SUBMITTED|VALID\"\n                }\n            ],\n            \"virtual_docs\": [\n                {\n                    \"document_type\": \"SSN\",\n                    \"id\": \"ee596c2896dddc19b76c07a184fe7d3cf5a04b8e94b9108190cac7890739017f\",\n                    \"last_updated\": 1498288964174,\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\": 1498289026881,\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        \"901.111.1111\",\n        \"[email protected]\"\n    ],\n    \"photos\": [],\n    \"refresh_token\": \"refresh_ehG7YBS8ZiD0sLa6PQHMUxryovVkJzElC5gWROXq\"\n}","name":"Delete Base Doc","status":200},{"status":200,"name":"Delete Sub-Document","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\": \"d02f580c1335a625ab2da2d7e53472d4e7fd664e633387654ebebe15ea696c91\",\n            \"name\": \"Test User\",\n            \"permission_scope\": \"SEND|RECEIVE|1000|DAILY\",\n            \"physical_docs\": [\n                {\n                    \"document_type\": \"GOVT_ID\",\n                    \"id\": \"70e3f32d8feba746347b5c0d820e8d7a218b955afbb612291a0a9922c93e8277\",\n                    \"last_updated\": 1498289027916,\n                    \"status\": \"SUBMITTED|VALID\"\n                }\n            ],\n            \"social_docs\": [\n                {\n                    \"document_type\": \"EMAIL\",\n                    \"id\": \"2c45158f6431ca874bbe82f63d5905567854dde4d8b81539944e5779e5eee741\",\n                    \"last_updated\": 1498289027918,\n                    \"status\": \"SUBMITTED|VALID\"\n                },\n                {\n                    \"document_type\": \"FACEBOOK\",\n                    \"id\": \"8f314a6a53f36ee569455761e49a2a7fe790d251c5611c65255befdb303602b7\",\n                    \"last_updated\": 1498289027918,\n                    \"status\": \"SUBMITTED|VALID\"\n                },\n                {\n                    \"document_type\": \"PHONE_NUMBER\",\n                    \"id\": \"fda60784d6375bc44edafaaeae149626c4c13dcb92e85a2a7a00eec2cdfd2b6f\",\n                    \"last_updated\": 1498289027918,\n                    \"status\": \"SUBMITTED|VALID\"\n                },\n                {\n                    \"document_type\": \"IP\",\n                    \"id\": \"28d9177b22c127d9a51d8903893864accf6e553ac326704a4c0d585eaad2516a\",\n                    \"last_updated\": 1498289027918,\n                    \"status\": \"SUBMITTED|VALID\"\n                }\n            ],\n            \"virtual_docs\": [\n                {\n                    \"document_type\": \"SSN\",\n                    \"id\": \"ee596c2896dddc19b76c07a184fe7d3cf5a04b8e94b9108190cac7890739017f\",\n                    \"last_updated\": 1498289027913,\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\": 1498289172373,\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\": \"[email protected]\",\n            \"scope\": \"READ_AND_WRITE\"\n        }\n    ],\n    \"permission\": \"SEND-AND-RECEIVE\",\n    \"phone_numbers\": [\n        \"901.111.1111\",\n        \"[email protected]\"\n    ],\n    \"photos\": [],\n    \"refresh_token\": \"refresh_ehG7YBS8ZiD0sLa6PQHMUxryovVkJzElC5gWROXq\"\n}"}]},"auth":"required","params":[{"_id":"58ca2e23726a2a19002c099d","ref":"","in":"body","required":true,"desc":"ID of the CIP document you wish to delete","default":"","type":"string","name":"documents[id]"},{"_id":"58ca2e23726a2a19002c099c","ref":"","in":"body","required":true,"desc":"Action to delete document. To be able to delete the value, scope needs to be `DELETE_DOCUMENT`","default":"","type":"string","name":"documents[permission_scope]"},{"_id":"594e09112af9f70029b63306","ref":"","in":"path","required":true,"desc":"The user ID of the user you wish to add documents to","default":"","type":"string","name":"user_id"}],"url":"/v3.1/users/:user_id"},"isReference":true,"order":9,"body":"[block:callout]\n{\n  \"type\": \"warning\",\n  \"title\": \"Deleting a Base Document\",\n  \"body\": \"More than 1 base document object needs to be present or else the delete document request will be unsuccessful.\"\n}\n[/block]","excerpt":"This API call lets you delete an existing CIP/KYC document.","slug":"delete-existing-document","type":"endpoint","title":"Delete Existing Document"}

patchDelete Existing Document

This API call lets you delete an existing CIP/KYC document.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

user_id:
required
string
The user ID of the user you wish to add documents to

Body Params

documents[id]:
required
string
ID of the CIP document you wish to delete
documents[permission_scope]:
required
string
Action to delete document. To be able to delete the value, scope needs to be `DELETE_DOCUMENT`

Examples


Result Format


Documentation

[block:callout] { "type": "warning", "title": "Deleting a Base Document", "body": "More than 1 base document object needs to be present or else the delete document request will be unsuccessful." } [/block]