{"_id":"55fa4822764f5021009506c0","user":"54e4044e8ef7552300409dcb","parentDoc":null,"editedParams":true,"editedParams2":true,"project":"54e405191e51932d006abc39","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"},"version":{"_id":"55fa37c88065a10d004e5bb6","project":"54e405191e51932d006abc39","__v":11,"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","59c451b7772699001c0f1df1","59c9b42dec84880010c1f348"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"REST V3","version_clean":"3.1.0","version":"3.1"},"__v":4,"updates":["560848edcf38bc170003462f"],"next":{"pages":[],"description":""},"createdAt":"2015-09-17T04:57:06.641Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"name":"","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\": \"1449fd8d4caf0c232b73dde6f3572f45b47414be9bf87f02b5bdbacf662ae0ae\",\n                    \"last_updated\": 1486735750446,\n                    \"status\": \"SUBMITTED|VALID\"\n                }\n            ],\n            \"social_docs\": [\n                {\n                    \"document_type\": \"PHONE_NUMBER\",\n                    \"id\": \"9dd593112385cfed22721355d279e79d33acd2c48cffe9c007b6c4acbfde826c\",\n                    \"last_updated\": 1486735750449,\n                    \"status\": \"SUBMITTED|VALID\"\n                },\n                {\n                    \"document_type\": \"EMAIL\",\n                    \"id\": \"fcabe34058c1abee46eb2d2bb29cc91aa2ac422e6bc0c2f934d191c9226cc7f2\",\n                    \"last_updated\": 1486735750449,\n                    \"status\": \"SUBMITTED|VALID\"\n                },\n                {\n                    \"document_type\": \"FACEBOOK\",\n                    \"id\": \"0c32234c59b71311b0f3057635c206e6a0d39ecef0bc336fe2bb375c92968117\",\n                    \"last_updated\": 1486735750449,\n                    \"status\": \"SUBMITTED|VALID\"\n                }\n            ],\n            \"virtual_docs\": [\n                {\n                    \"document_type\": \"SSN\",\n                    \"id\": \"ee596c2896dddc19b76c07a184fe7d3cf5a04b8e94b9108190cac7890739017f\",\n                    \"last_updated\": 1486735750444,\n                    \"status\": \"SUBMITTED|VALID\"\n                }\n            ]\n        },\n        {\n            \"id\": \"bd8d12dc29d2730c6d7b6156d022990b0d20d89bc89da9fb76df82955f587d8f\",\n            \"name\": \"John doe\",\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\": 1486735749754,\n                    \"status\": \"SUBMITTED|VALID\"\n                }\n            ],\n            \"social_docs\": [\n                {\n                    \"document_type\": \"EMAIL\",\n                    \"id\": \"fcabe34058c1abee46eb2d2bb29cc91aa2ac422e6bc0c2f934d191c9226cc7f2\",\n                    \"last_updated\": 1486735749755,\n                    \"status\": \"SUBMITTED|VALID\"\n                },\n                {\n                    \"document_type\": \"FACEBOOK\",\n                    \"id\": \"0c32234c59b71311b0f3057635c206e6a0d39ecef0bc336fe2bb375c92968117\",\n                    \"last_updated\": 1486735749755,\n                    \"status\": \"SUBMITTED|VALID\"\n                },\n                {\n                    \"document_type\": \"PHONE_NUMBER\",\n                    \"id\": \"9dd593112385cfed22721355d279e79d33acd2c48cffe9c007b6c4acbfde826c\",\n                    \"last_updated\": 1486735749755,\n                    \"status\": \"SUBMITTED|VALID\"\n                }\n            ],\n            \"virtual_docs\": [\n                {\n                    \"document_type\": \"SSN\",\n                    \"id\": \"ee596c2896dddc19b76c07a184fe7d3cf5a04b8e94b9108190cac7890739017f\",\n                    \"last_updated\": 1486735844459,\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\": 1486735844453,\n        \"supp_id\": \"122eddfgbeafrfvbbb\"\n    },\n    \"is_hidden\": false,\n    \"legal_names\": [\n        \"Test User\",\n        \"Some new name\"\n    ],\n    \"logins\": [\n        {\n            \"email\": \"sankaet:::at:::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}","language":"json"},{"status":202,"language":"json","code":"{\n  \"error_code\": \"10\",\n  \"http_code\": \"202\",\n  \"message\": {\n    \"en\": \"SSN information submitted. Please ask user to answer the attached questions and post them to user/doc/verify\"\n  },\n  \"question_set\": {\n    \"created_at\": 1442466388,\n    \"expired\": false,\n    \"id\": \"55fa4a546631650003000619\",\n    \"livemode\": false,\n    \"object\": \"question_set\",\n    \"person_id\": \"55fa4a546533310003000613\",\n    \"questions\": [\n      {\n        \"answers\": [\n          {\n            \"answer\": \"Julian\",\n            \"id\": 1\n          },\n          {\n            \"answer\": \"Nathan\",\n            \"id\": 2\n          },\n          {\n            \"answer\": \"Jason\",\n            \"id\": 3\n          },\n          {\n            \"answer\": \"Evan\",\n            \"id\": 4\n          },\n          {\n            \"answer\": \"None Of The Above\",\n            \"id\": 5\n          }\n        ],\n        \"id\": 1,\n        \"question\": \"Which one of the following adult individuals is most closely associated with you?\"\n      },\n      {\n        \"answers\": [\n          {\n            \"answer\": \"904\",\n            \"id\": 1\n          },\n          {\n            \"answer\": \"812\",\n            \"id\": 2\n          },\n          {\n            \"answer\": \"336\",\n            \"id\": 3\n          },\n          {\n            \"answer\": \"832\",\n            \"id\": 4\n          },\n          {\n            \"answer\": \"None Of The Above\",\n            \"id\": 5\n          }\n        ],\n        \"id\": 2,\n        \"question\": \"Which one of the following area codes is associated with you?\"\n      },\n      {\n        \"answers\": [\n          {\n            \"answer\": \"Boone\",\n            \"id\": 1\n          },\n          {\n            \"answer\": \"Jasper\",\n            \"id\": 2\n          },\n          {\n            \"answer\": \"Schoharie\",\n            \"id\": 3\n          },\n          {\n            \"answer\": \"Sangamon\",\n            \"id\": 4\n          },\n          {\n            \"answer\": \"None Of The Above\",\n            \"id\": 5\n          }\n        ],\n        \"id\": 3,\n        \"question\": \"Which one of the following counties is associated with you?\"\n      },\n      {\n        \"answers\": [\n          {\n            \"answer\": \"49230\",\n            \"id\": 1\n          },\n          {\n            \"answer\": \"49209\",\n            \"id\": 2\n          },\n          {\n            \"answer\": \"49268\",\n            \"id\": 3\n          },\n          {\n            \"answer\": \"49532\",\n            \"id\": 4\n          },\n          {\n            \"answer\": \"None Of The Above\",\n            \"id\": 5\n          }\n        ],\n        \"id\": 4,\n        \"question\": \"Which one of the following zip codes is associated with you?\"\n      },\n      {\n        \"answers\": [\n          {\n            \"answer\": \"123 Main St\",\n            \"id\": 1\n          },\n          {\n            \"answer\": \"52 Canandaigua Rd\",\n            \"id\": 2\n          },\n          {\n            \"answer\": \"309 Colver Rd\",\n            \"id\": 3\n          },\n          {\n            \"answer\": \"467 Meridian Rd\",\n            \"id\": 4\n          },\n          {\n            \"answer\": \"None Of The Above\",\n            \"id\": 5\n          }\n        ],\n        \"id\": 5,\n        \"question\": \"Which one of the following addresses is associated with you?\"\n      }\n    ],\n    \"score\": null,\n    \"time_limit\": 0,\n    \"updated_at\": 1442466388\n  },\n  \"success\": true\n}"}]},"settings":"","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    \"doc\":{\n      \"birth_day\":4,\n      \"birth_month\":2,\n      \"birth_year\":1940,\n      \"name_first\":\"John\",\n      \"name_last\":\"doe\",\n      \"address_street1\":\"1 Infinate Loop\",\n      \"address_postal_code\":\"95014\",\n      \"address_country_code\":\"US\",\n      \"document_value\":\"2222\",\n      \"document_type\":\"SSN\"\n    }\n}' \"https://uat-api.synapsefi.com/v3.1/users/589dc8817562960020cb00c9\"","name":""}]},"method":"patch","auth":"required","params":[{"_id":"5573b11e91ce6e190023b76a","ref":"","in":"body","required":true,"desc":"The integer associated with the day of birth.","default":"","type":"int","name":"doc.birth_day"},{"_id":"55fa463317b9d00d00969eb1","ref":"","in":"body","required":true,"desc":"The integer associated with the month of birth.","default":"","type":"int","name":"doc.birth_month"},{"_id":"55728c20e42c040d00d68a9f","ref":"","in":"body","required":true,"desc":"The full 4-digit year of birth.","default":"","type":"int","name":"doc.birth_year"},{"_id":"55fa3f2a17b9d00d00969ea5","ref":"","in":"body","required":true,"desc":"The legal first name of the customer.","default":"","type":"string","name":"doc.name_first"},{"_id":"55fa3f2a17b9d00d00969ea4","ref":"","in":"body","required":true,"desc":"The legal last name of the customer.","default":"","type":"string","name":"doc.name_last"},{"_id":"55fa463317b9d00d00969eb0","ref":"","in":"body","required":true,"desc":"The primary street address of the customer. This is automatically normalized.","default":"","type":"string","name":"doc.address_street1"},{"_id":"55fa463317b9d00d00969eaf","ref":"","in":"body","required":true,"desc":"The postal code of the person. Also known as a ZIP code.","default":"","type":"string","name":"doc.address_postal_code"},{"_id":"55fa463317b9d00d00969eae","ref":"","in":"body","required":true,"desc":"The country of the customer. Should be of the ISO code form.","default":"","type":"string","name":"doc.address_country_code"},{"_id":"55fa48b7aba81f0d00a115e2","ref":"","in":"body","required":true,"desc":"The number associated with the form of documentation used.","default":"","type":"string","name":"doc.document_value"},{"_id":"55fa48b7aba81f0d00a115e1","ref":"","in":"body","required":true,"desc":"Must be one of the document types described in the Documents section below.","default":"","type":"string","name":"doc.document_type"},{"_id":"57042df6211f330e0084a53b","ref":"","in":"body","required":false,"desc":"Set this to True if you wish to force KBA questions","default":"","type":"boolean","name":"doc.force_kba"}],"url":"/v3.1/users/:user_id"},"isReference":true,"order":11,"body":"[block:callout]\n{\n  \"type\": \"danger\",\n  \"title\": \"Deprecated\",\n  \"body\": \"This API call is being deprecated for a more awesome [API call](doc:adding-documents).\"\n}\n[/block]","excerpt":"This API call lets you add/update virtual document on the user","slug":"add-virtual-doc","type":"endpoint","title":"[Deprecated] Virtual Document"}

patch[Deprecated] Virtual Document

This API call lets you add/update virtual document on the user

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Body Params

doc.birth_day:
required
integer
The integer associated with the day of birth.
doc.birth_month:
required
integer
The integer associated with the month of birth.
doc.birth_year:
required
integer
The full 4-digit year of birth.
doc.name_first:
required
string
The legal first name of the customer.
doc.name_last:
required
string
The legal last name of the customer.
doc.address_street1:
required
string
The primary street address of the customer. This is automatically normalized.
doc.address_postal_code:
required
string
The postal code of the person. Also known as a ZIP code.
doc.address_country_code:
required
string
The country of the customer. Should be of the ISO code form.
doc.document_value:
required
string
The number associated with the form of documentation used.
doc.document_type:
required
string
Must be one of the document types described in the Documents section below.
doc.force_kba:
boolean
Set this to True if you wish to force KBA questions

Examples


Result Format


Documentation

[block:callout] { "type": "danger", "title": "Deprecated", "body": "This API call is being deprecated for a more awesome [API call](doc:adding-documents)." } [/block]