{"__v":6,"_id":"573928641f4b740e00b06ccb","category":{"__v":17,"_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"],"project":"54e405191e51932d006abc39","version":"55fa37c88065a10d004e5bb6","sync":{"url":"","isSync":false},"reference":true,"createdAt":"2015-06-06T05:42:37.534Z","from_sync":false,"order":1,"slug":"users","title":"Users"},"editedParams":true,"editedParams2":true,"parentDoc":null,"project":"54e405191e51932d006abc39","user":"54e4044e8ef7552300409dcb","version":{"__v":7,"_id":"55fa37c88065a10d004e5bb6","project":"54e405191e51932d006abc39","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"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"REST V3","version_clean":"3.1.0","version":"3.1"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-05-16T01:54:44.932Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"language":"curl","code":"curl -X PATCH -H \"X-SP-GATEWAY: client_id_2bb1e412edd311e6bd04e285d6015267|client_secret_2bb1e714edd311e6bd04e285d6015267\" -H \"X-SP-USER-IP: 127.0.0.1\" -H \"X-SP-USER: oauth_40e63a68ef9a11e6834f0a81c1ab804f|e716990e50b67a1177736960b6357524b22090ccab093d068b3d7a18dbde3f4c\" -H \"Content-Type: application/json\" -d '{\n  \"documents\":[{\n  \t\t  \"id\":\"ef4685f1dcf78b39a85c9d4da97652e114f3af054d43b29195978a1e4918beae\",\n        \"email\":\"test2:::at:::test.com\",\n        \"phone_number\":\"901-942-8167\"\n    }]\n}' \"https://sandbox.synapsepay.com/api/3/users/589dc8817562960020cb00c9\"","name":""}]},"method":"patch","results":{"codes":[{"status":200,"language":"json","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\": \"sankaet@synapsepay.com\",\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}","name":""}]},"settings":"","auth":"required","params":[{"_id":"573928979042980e00ad1aa3","ref":"","in":"body","required":true,"desc":"ID of the CIP document you wish to update","default":"","type":"string","name":"documents[id]"},{"_id":"5573b11e91ce6e190023b76a","ref":"","in":"body","required":false,"desc":"Email of the owner of the document.","default":"","type":"string","name":"documents[email]"},{"_id":"57392621e370590e0012e802","ref":"","in":"body","required":false,"desc":"Phone Number of the owner of the document.","default":"","type":"string","name":"documents[phone_number]"},{"_id":"57392621e370590e0012e801","ref":"","in":"body","required":false,"desc":"IP where the document is being submitted from.","default":"","type":"string","name":"documents[ip]"},{"_id":"57392621e370590e0012e800","ref":"","in":"body","required":false,"desc":"Name of the document owner (this can be the name of the individual or the business)","default":"","type":"string","name":"documents[name]"},{"_id":"57392621e370590e0012e7ff","ref":"","in":"body","required":false,"desc":"Alias of the document owner (this can be the name itself or in case of companies this can be a DBA entry)","default":"","type":"string","name":"documents[alias]"},{"_id":"57392621e370590e0012e7fe","ref":"","in":"body","required":false,"desc":"Entity type of the document owner, this can be gender in case of an individual or corp structure in case of a business.","default":"","type":"string","name":"documents[entity_type]"},{"_id":"57392621e370590e0012e7fd","ref":"","in":"body","required":false,"desc":"Industry in which the document owner operates. I case of a person it can be their field of profession, in case of a corp this can be their line of business.","default":"","type":"string","name":"documents[entity_scope]"},{"_id":"57392621e370590e0012e7fc","ref":"","in":"body","required":false,"desc":"In case of a person this is day of birth. In case of business entity, this is day of organization.","default":"","type":"int","name":"documents[day]"},{"_id":"57392621e370590e0012e7fb","ref":"","in":"body","required":false,"desc":"In case of a person this is month of birth. In case of business entity, this is month of organization.","default":"","type":"int","name":"documents[month]"},{"_id":"57392621e370590e0012e7fa","ref":"","in":"body","required":false,"desc":"In case of a person this is year of birth. In case of business entity, this is year of organization.","default":"","type":"int","name":"documents[year]"},{"_id":"57392621e370590e0012e7f9","ref":"","in":"body","required":false,"desc":"Address associated with the document owner, this can be home address of a person or business address of a corp.","default":"","type":"string","name":"documents[address_street]"},{"_id":"57392621e370590e0012e7f8","ref":"","in":"body","required":false,"desc":"Address associated with the document owner, this can be home address of a person or business address of a corp.","default":"","type":"string","name":"documents[address_city]"},{"_id":"57392621e370590e0012e7f7","ref":"","in":"body","required":false,"desc":"Address associated with the document owner, this can be home address of a person or business address of a corp.","default":"","type":"string","name":"documents[address_subdivision]"},{"_id":"57392621e370590e0012e7f6","ref":"","in":"body","required":false,"desc":"Address associated with the document owner, this can be home address of a person or business address of a corp.","default":"","type":"string","name":"documents[address_postal_code]"},{"_id":"57392621e370590e0012e7f5","ref":"","in":"body","required":false,"desc":"Address associated with the document owner, this can be home address of a person or business address of a corp.","default":"","type":"string","name":"documents[address_country_code]"},{"_id":"573928b64dea9d0e000519cc","ref":"","in":"body","required":false,"desc":"ID of the virtual document you wish to update.","default":"","type":"string","name":"documents.virtual_docs[id]"},{"_id":"57392621e370590e0012e7f4","ref":"","in":"body","required":false,"desc":"Type of virtual document being submitted.","default":"","type":"string","name":"documents.virtual_docs[document_value]"},{"_id":"57392621e370590e0012e7f3","ref":"","in":"body","required":false,"desc":"Value of virtual document being submitted.","default":"","type":"string","name":"documents.virtual_docs[document_type]"},{"_id":"573928b64dea9d0e000519cb","ref":"","in":"body","required":false,"desc":"ID of the physical document you wish to update.","default":"","type":"string","name":"documents.physical_docs[id]"},{"_id":"57392621e370590e0012e7f2","ref":"","in":"body","required":false,"desc":"Type of physical document being submitted.","default":"","type":"string","name":"documents.physical_docs[document_value]"},{"_id":"57392621e370590e0012e7f1","ref":"","in":"body","required":false,"desc":"Value of physical document being submitted.","default":"","type":"string","name":"documents.physical_docs[document_type]"},{"_id":"573928cad5b6db0e00729c6d","ref":"","in":"body","required":false,"desc":"ID of the social document you wish to update.","default":"","type":"string","name":"documents.social_docs[id]"},{"_id":"57392621e370590e0012e7f0","ref":"","in":"body","required":false,"desc":"Type of social document being submitted.","default":"","type":"string","name":"documents.social_docs[document_value]"},{"_id":"57392621e370590e0012e7ef","ref":"","in":"body","required":false,"desc":"Value of social document being submitted.","default":"","type":"string","name":"documents.social_docs[document_type]"}],"url":"/users/:user_id"},"isReference":true,"order":6,"body":"[block:api-header]\n{}\n[/block]\n## Removing a base document\n\nTo be able to remove a base document, you need to make a request like the following:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"curl -X PATCH -H \\\"X-SP-GATEWAY: client_id_2bb1e412edd311e6bd04e285d6015267|client_secret_2bb1e714edd311e6bd04e285d6015267\\\" -H \\\"X-SP-USER-IP: 127.0.0.1\\\" -H \\\"X-SP-USER: oauth_40e63a68ef9a11e6834f0a81c1ab804f|e716990e50b67a1177736960b6357524b22090ccab093d068b3d7a18dbde3f4c\\\" -H \\\"Content-Type: application/json\\\" -d '{\\n  \\\"documents\\\":[{\\n  \\t\\t  \\\"id\\\":\\\"ef4685f1dcf78b39a85c9d4da97652e114f3af054d43b29195978a1e4918beae\\\",\\n        \\\"permission_scope\\\":\\\"DELETE_DOCUMENT\\\"\\n    }]\\n}' \\\"https://sandbox.synapsepay.com/api/3/users/589dc8817562960020cb00c9\\\"\",\n      \"language\": \"curl\"\n    }\n  ]\n}\n[/block]\nThis will remove document with id `ef4685f1dcf78b39a85c9d4da97652e114f3af054d43b29195978a1e4918beae` from user's profile.\n\n> One caveat: This will only work when there are more than 1 document. If only one document is present, it is advised to update info in the document instead of removing it.\n\n\n## Removing a sub document\n\nTo remove a sub document, you need to make a request like the following:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"curl -X PATCH -H \\\"X-SP-GATEWAY: client_id_2bb1e412edd311e6bd04e285d6015267|client_secret_2bb1e714edd311e6bd04e285d6015267\\\" -H \\\"X-SP-USER-IP: 127.0.0.1\\\" -H \\\"X-SP-USER: oauth_40e63a68ef9a11e6834f0a81c1ab804f|e716990e50b67a1177736960b6357524b22090ccab093d068b3d7a18dbde3f4c\\\" -H \\\"Content-Type: application/json\\\" -d '{\\n  \\\"documents\\\":[{\\n  \\t\\t  \\\"id\\\":\\\"ef4685f1dcf78b39a85c9d4da97652e114f3af054d43b29195978a1e4918beae\\\",\\n\\t\\t\\t\\t\\\"virtual_docs\\\": [\\n                {\\n                    \\\"document_type\\\": \\\"DELETE_DOCUMENT\\\",\\n                    \\\"id\\\": \\\"ee596c2896dddc19b76c07a184fe7d3cf5a04b8e94b9108190cac7890739017f\\\"\\n                }\\n            ]\\n    }]\\n}' \\\"https://sandbox.synapsepay.com/api/3/users/589dc8817562960020cb00c9\\\"\",\n      \"language\": \"curl\"\n    }\n  ]\n}\n[/block]\nThis will remove sub document `ee596c2896dddc19b76c07a184fe7d3cf5a04b8e94b9108190cac7890739017f` inside a base document with id `ef4685f1dcf78b39a85c9d4da97652e114f3af054d43b29195978a1e4918beae` from user's profile.","excerpt":"This API call lets you update an existing CIP/KYC document.","slug":"updating-existing-document","type":"endpoint","title":"Update Existing Document"}

patchUpdate Existing Document

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

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Body Params

documents[id]:
required
string
ID of the CIP document you wish to update
documents[email]:
string
Email of the owner of the document.
documents[phone_number]:
string
Phone Number of the owner of the document.
documents[ip]:
string
IP where the document is being submitted from.
documents[name]:
string
Name of the document owner (this can be the name of the individual or the business)
documents[alias]:
string
Alias of the document owner (this can be the name itself or in case of companies this can be a DBA entry)
documents[entity_type]:
string
Entity type of the document owner, this can be gender in case of an individual or corp structure in case of a business.
documents[entity_scope]:
string
Industry in which the document owner operates. I case of a person it can be their field of profession, in case of a corp this can be their line of business.
documents[day]:
integer
In case of a person this is day of birth. In case of business entity, this is day of organization.
documents[month]:
integer
In case of a person this is month of birth. In case of business entity, this is month of organization.
documents[year]:
integer
In case of a person this is year of birth. In case of business entity, this is year of organization.
documents[address_street]:
string
Address associated with the document owner, this can be home address of a person or business address of a corp.
documents[address_city]:
string
Address associated with the document owner, this can be home address of a person or business address of a corp.
documents[address_subdivision]:
string
Address associated with the document owner, this can be home address of a person or business address of a corp.
documents[address_postal_code]:
string
Address associated with the document owner, this can be home address of a person or business address of a corp.
documents[address_country_code]:
string
Address associated with the document owner, this can be home address of a person or business address of a corp.
documents.virtual_docs[id]:
string
ID of the virtual document you wish to update.
documents.virtual_docs[document_value]:
string
Type of virtual document being submitted.
documents.virtual_docs[document_type]:
string
Value of virtual document being submitted.
documents.physical_docs[id]:
string
ID of the physical document you wish to update.
documents.physical_docs[document_value]:
string
Type of physical document being submitted.
documents.physical_docs[document_type]:
string
Value of physical document being submitted.
documents.social_docs[id]:
string
ID of the social document you wish to update.
documents.social_docs[document_value]:
string
Type of social document being submitted.
documents.social_docs[document_type]:
string
Value of social document being submitted.

Examples


Result Format


Documentation

[block:api-header] {} [/block] ## Removing a base document To be able to remove a base document, you need to make a request like the following: [block:code] { "codes": [ { "code": "curl -X PATCH -H \"X-SP-GATEWAY: client_id_2bb1e412edd311e6bd04e285d6015267|client_secret_2bb1e714edd311e6bd04e285d6015267\" -H \"X-SP-USER-IP: 127.0.0.1\" -H \"X-SP-USER: oauth_40e63a68ef9a11e6834f0a81c1ab804f|e716990e50b67a1177736960b6357524b22090ccab093d068b3d7a18dbde3f4c\" -H \"Content-Type: application/json\" -d '{\n \"documents\":[{\n \t\t \"id\":\"ef4685f1dcf78b39a85c9d4da97652e114f3af054d43b29195978a1e4918beae\",\n \"permission_scope\":\"DELETE_DOCUMENT\"\n }]\n}' \"https://sandbox.synapsepay.com/api/3/users/589dc8817562960020cb00c9\"", "language": "curl" } ] } [/block] This will remove document with id `ef4685f1dcf78b39a85c9d4da97652e114f3af054d43b29195978a1e4918beae` from user's profile. > One caveat: This will only work when there are more than 1 document. If only one document is present, it is advised to update info in the document instead of removing it. ## Removing a sub document To remove a sub document, you need to make a request like the following: [block:code] { "codes": [ { "code": "curl -X PATCH -H \"X-SP-GATEWAY: client_id_2bb1e412edd311e6bd04e285d6015267|client_secret_2bb1e714edd311e6bd04e285d6015267\" -H \"X-SP-USER-IP: 127.0.0.1\" -H \"X-SP-USER: oauth_40e63a68ef9a11e6834f0a81c1ab804f|e716990e50b67a1177736960b6357524b22090ccab093d068b3d7a18dbde3f4c\" -H \"Content-Type: application/json\" -d '{\n \"documents\":[{\n \t\t \"id\":\"ef4685f1dcf78b39a85c9d4da97652e114f3af054d43b29195978a1e4918beae\",\n\t\t\t\t\"virtual_docs\": [\n {\n \"document_type\": \"DELETE_DOCUMENT\",\n \"id\": \"ee596c2896dddc19b76c07a184fe7d3cf5a04b8e94b9108190cac7890739017f\"\n }\n ]\n }]\n}' \"https://sandbox.synapsepay.com/api/3/users/589dc8817562960020cb00c9\"", "language": "curl" } ] } [/block] This will remove sub document `ee596c2896dddc19b76c07a184fe7d3cf5a04b8e94b9108190cac7890739017f` inside a base document with id `ef4685f1dcf78b39a85c9d4da97652e114f3af054d43b29195978a1e4918beae` from user's profile.