{"__v":7,"_id":"55fa3dd4a663c00d00773dd1","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":["5609b257a7cc2f0d00d977e9"],"next":{"pages":[],"description":""},"createdAt":"2015-09-17T04:13:08.632Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"language":"curl","code":"curl -X POST -H \"X-SP-GATEWAY: client_id_2bb1e412edd311e6bd04e285d6015267|client_secret_2bb1e714edd311e6bd04e285d6015267\" -H \"X-SP-USER-IP: 127.0.0.1\" -H \"X-SP-USER: |e716990e50b67a1177736960b6357524b22090ccab093d068b3d7a18dbde3f4c\" -d '{\n  \"logins\": [\n    {\n      \"email\": \"sankaet:::at:::synapsepay.com\",\n      \"password\":\"test1234\",\n      \"scope\":\"READ_AND_WRITE\"\n    }\n  ],\n  \"phone_numbers\": [\n    \"901.942.8167\"\n  ],\n  \"legal_names\": [\n    \"Test User\"\n  ],\n  \"documents\":[{\n        \"email\":\"test@test.com\",\n        \"phone_number\":\"901-942-8167\",\n        \"ip\":\"12134323\",\n        \"name\":\"Charlie Brown\",\n        \"alias\":\"Woof Woof\",\n        \"entity_type\":\"M\",\n        \"entity_scope\":\"Arts & Entertainment\",\n        \"day\":2,\n        \"month\":5,\n        \"year\":1989,\n        \"address_street\":\"170 St Germain Ave\",\n        \"address_city\":\"SF\",\n        \"address_subdivision\":\"CA\",\n        \"address_postal_code\":\"94114\",\n        \"address_country_code\":\"US\",\n        \"virtual_docs\":[{\n            \"document_value\":\"2222\",\n            \"document_type\":\"SSN\"\n        }],\n        \"physical_docs\":[{\n            \"document_value\": \"data:image/gif;base64,R0lGODlhMAAwAPf/AKmoaJyUUoR7QqKZVXZsOnpuPNrZlHV1Q3xxPODauejkqExEJVZTObu7u1RKKqmkXL24c7uzasPDw/rymoyMjMG6iZ2ZVLKrZNbUy6KUUtPRioyESNjVuaurq5ODS/Piiunljvr3uNLS0rOiXJSUlJmWhaWgWvTpplpTLLy5baudWf7+1///6NTUkczLfY2CRWRcMvz7yJubm8rKhPfyp7OwZaSko2pqaOPdkUU/IdbOg3JlOdPSg8PBdKmaVd3ajMbEe5qQT+fOfLWsecvEdfbpk+Lfi9LMfZ6OUVlXTb2sZIF2QG1rXmleNaGdV//vm5eSUbOzsYR2Qbezon91PridXYOBes3NzfHjlrqxgmxiOZGPUYp+Rqqic4WDTXJnR0ZPHda9cjYzJevai8G9curjs8W2a5yNTpKJTBoYC62pXre0b6OPUqmVVHVza5J/SHBkN2lgM8nJyczAcm1mNe3imnt1UMW1X1ZQKqKcZjs1H9K5a9TDb2FUMcnHfb+8b+HeoZmJTZmMT8StZd3MgW5iNdnWk3JoN0ZDO9fOmrynYGtgNZOISszMxfbmnNnXje3rn/rtlsbDrJCESIBzQGJgVYh9Q9LOuox8RWFYMKGgn5aMTZmFTZiJSuzmkMO+fIh5QoZ2RCokCZaITqCRTtbYk9jVhNTEeVVbKpGNTszNiYl6RNzahaWgWNLQf9vcl/PvmI5+SOrcmuTXjZqNSZ+JT5aJS2tyNOTRgdLDd11XLoZ0RMi4Z7e1Z72wWmtkTNDQz62gUYBvP9zXnNDRjYV+VJmYjtbQp5SIR66spb67tTowCbOkX6WjjvLgg7Kvnb+6mmdiNZ6hXG1dN83Gl97DddjEe+HNdoeAYJGOaZKIc3x7cezVhO7bgpGIU5GLXYB9YYNzRPHvsoN3Q5yOS5mWWM65cDAqFHZnO5GQWNHNjWpjNMa4ZMmwZdzJesuza5SPTJuUYeHXkdjPj+Xel+bjluXkoJ+jYuzqlcTHhcbIh8jFgcjCiI6JXLWmV9TU1CH5BAEAAP8ALAAAAAAwADAAAAj/AP8JHEiwoMGDCBMqXMiwocOHECNCLOFGgsSLB4FlStMBo8eByZalafDxozZRN0p+/DJSJcYrOZK4xKhMlIyZFzWds4gzYgkxInouxMDhWKJEBrzlmMevAjRJjYQKJDrsxw8Dr17Zs6PrlSlXRCIw6/LsykwMCXAYyfqqhSogQKJp4eHCBZA1F0zAK1YCWEkMssasfVVqRg1pTh7gIdAjBRkgPSBAEEvOThSPCbB4woGDMDEA5bakcoLngGQyOujNImTNnKIzTYxdTBDJk5EfjwyUynfPywEv5VAcqLCGSJ0TdVibU9Im1ALZEDk8KQLitu5SqgAcQAXDCx47Q9TM/3J0YvWp5SrewMhh46GIE5Go3370qAUxffdugUGVg4EXPrjMIo8OR8xhxgUZYFJIf3I4VMYTkcBSHSum8KBBC6W0MMMa0qSTTgouaKDBEZClcMEDZ0hRyAJ6WNEQBhBOIKERrPDgiis8EEMMhro9QowqM0BGRi9qOBHEC1Q04UAOuvCkUAJPPCEjPjR+5UpdLvgxgx9cCplCLzUUCc8GAhSgBR4L6NIMQwpEKSMkkNTzw1cuENHDnX/k+ceXYbZiwZiWCEDAOijgAUM2DJ0g5QQ00BCCOArQ88gRROTZC59hqvGAEwGksskkAiwxqC6ZFNIPQ44s6mgMK8Qgjj2P7P9Dxh+99HKBpia00koAUGyBBiNcLFEAHTCsQ4A3DBURybKOsuDsCiEo0AIQZKxRw4kmONGKChnwisYkXFBRwDpxELBEEAxhUcS6J4SwwgrOxlCGIfusEcGJD2RrgQ8ZILHJBlysQgkBdNBBxQZ5MCTLB858gAUkIbDqKiDqfIKXGiY80IoTFmTARiCjACyFFAQcQoAlUADAUCLOdMPNGHVAAqk9gBDzCQQXKJGXCYhZEAASnHjwQqjCEECAAIxYMARD0DgjhBC4/IADPTho4IfFF1zAzAP5OjFAx2dwEgsmAoxTAAHjvBCECVkwdMk111TjzhFH6KCDHxDgZQIzI3z/zXEAAQQhiNirjINAAUh3sq8kDGGQCx9hhJHLHJSnEEGYJqgwgg8WdB74JoG8gUk4BRQwDiNBBOHECH4xRM0ee7xjxuxK4LqtD7gDDgUU38YSihQFIGCJB0gEkIEPFTh0CS/tDDKIEoqMkPkA1HtMCq+pbACuFJQEL8AkggzgRAb+XPLQJ4MoUgXfKvAbwCaCIBGIB2igsUGgwhKA+Au2BDCADypY2kOmoIQqVMEHbWDDzwSBhlh4wANciCDRCAAHAlCBC5MIQgba4ANfTCEiXRhBAtlQC0E8cAOrwAQoVgEKSgyMgodAgAD4dwZS+EARAoRIFFRAQk68wQO+CwUl/3ZBCWEUrWRwgEMBlsAFNAjiDORjx2UkUoIMAHEXuwhF6baIjh3AgQ6LoAMBECCFFzCiE0jwATtKIIKgQAQYEsCGB0iHjgKgQws72EEhFtGEJsAgDjFcAihe8IJOkMIXeWiAHNz4EDh2wA7CgMM0pqEFGEzDj5lAgS50AcgCSMESmJgEOfwRD0004AqMdAgw5NAAGfxiGn2IZSwziQIH4EEXTTiEJy3BBVoE4xsk6IAEWgcREVxBAh0gQSUcwMxmOmABDkBBJgBJxhfQghTgoIANFJlK97CyAzK4ASL0kIMcLKCc0ZymuZCBjGJsgwSaiIIEUImRVTagA5qggDjFQEzOBeBBnQighB3cQAES2ECe9PQIMK7QgCjYQAYksMINKpGEilaCCW6wQkE10YEGzLObEmnjMRuKTxlAlAQoJYFJbdBRCcgBGCA1SEAAADs=\",\n            \"document_type\": \"GOVT_ID\"\n        }],\n        \"social_docs\":[{\n            \"document_value\":\"https://www.facebook.com/sankaet\",\n            \"document_type\":\"FACEBOOK\"\n        }]\n    }],\n  \"extra\": {\n    \"note\": \"Interesting user\",\n    \"supp_id\": \"122eddfgbeafrfvbbb\",\n    \"cip_tag\":1,\n    \"is_business\": false,\n    \"extra_security\": false\n  }\n}' \"https://sandbox.synapsepay.com/api/3/users\"","name":""}]},"method":"post","results":{"codes":[{"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\": \"MISSING|INVALID\",\n    \"virtual_doc\": \"MISSING|INVALID\"\n  },\n  \"documents\": [\n    {\n      \"id\": \"ef4685f1dcf78b39a85c9d4da97652e114f3af054d43b29195978a1e4918beae\",\n      \"name\": \"Charlie Brown\",\n      \"permission_scope\": \"UNVERIFIED\",\n      \"physical_docs\": [\n        {\n          \"document_type\": \"GOVT_ID\",\n          \"id\": \"1449fd8d4caf0c232b73dde6f3572f45b47414be9bf87f02b5bdbacf662ae0ae\",\n          \"last_updated\": 1486735486404,\n          \"status\": \"SUBMITTED|VALID\"\n        }\n      ],\n      \"social_docs\": [\n        {\n          \"document_type\": \"EMAIL\",\n          \"id\": \"2c45158f6431ca874bbe82f63d5905567854dde4d8b81539944e5779e5eee741\",\n          \"last_updated\": 1486735487750,\n          \"status\": \"SUBMITTED|VALID\"\n        },\n        {\n          \"document_type\": \"FACEBOOK\",\n          \"id\": \"0c32234c59b71311b0f3057635c206e6a0d39ecef0bc336fe2bb375c92968117\",\n          \"last_updated\": 1486735487103,\n          \"status\": \"SUBMITTED|VALID\"\n        },\n        {\n          \"document_type\": \"PHONE_NUMBER\",\n          \"id\": \"9dd593112385cfed22721355d279e79d33acd2c48cffe9c007b6c4acbfde826c\",\n          \"last_updated\": 1486735488372,\n          \"status\": \"SUBMITTED|VALID\"\n        }\n      ],\n      \"virtual_docs\": [\n        {\n          \"document_type\": \"SSN\",\n          \"id\": \"ee596c2896dddc19b76c07a184fe7d3cf5a04b8e94b9108190cac7890739017f\",\n          \"last_updated\": 1486735485717,\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\": 1486735484343,\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\": \"UNVERIFIED\",\n  \"phone_numbers\": [\n    \"901.942.8167\"\n  ],\n  \"photos\": [],\n  \"refresh_token\": \"refresh_e36f207aef9911e6aac58a1ffc37511f\"\n}","language":"json","status":200}]},"settings":"","auth":"required","params":[{"_id":"5573b11e91ce6e190023b76a","ref":"","in":"body","required":true,"desc":"Email associated with the user login","default":"","type":"string","name":"logins[email]"},{"_id":"55fa4d6f764f5021009506c9","ref":"","in":"body","required":false,"desc":"Password associated with the user login","default":"","type":"string","name":"logins[password]"},{"_id":"55fa4d6f764f5021009506c8","ref":"","in":"body","required":false,"desc":"If the login credentials are for admin privileges or ready only. By default read_only is false","default":"","type":"boolean","name":"logins[read_only]"},{"_id":"55728c20e42c040d00d68a9f","ref":"","in":"body","required":true,"desc":"All the phone numbers you wish to register with this account","default":"","type":"array_string","name":"phone_numbers"},{"_id":"55fa3f2a17b9d00d00969ea5","ref":"","in":"body","required":true,"desc":"All the legal names you wish to register with this account","default":"","type":"array_string","name":"legal_names"},{"_id":"589b5e4d6d051e0f00f42ff9","ref":"","in":"body","required":false,"desc":"Email of the owner of the document.","default":"","type":"string","name":"documents[email]"},{"_id":"589b5e4d6d051e0f00f42ff8","ref":"","in":"body","required":false,"desc":"Phone Number of the owner of the document.","default":"","type":"string","name":"documents[phone_number]"},{"_id":"589b5e4d6d051e0f00f42ff7","ref":"","in":"body","required":false,"desc":"IP where the document is being submitted from.","default":"","type":"string","name":"documents[ip]"},{"_id":"589b5e4d6d051e0f00f42ff6","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":"589b5e4d6d051e0f00f42ff5","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":"589b5e4d6d051e0f00f42ff4","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. See [here](doc:user-resources#section-supported-entity-types).","default":"","type":"string","name":"documents[entity_type]"},{"_id":"589b5e4d6d051e0f00f42ff3","ref":"","in":"body","required":false,"desc":"Industry in which the document owner operates. In case of a person it can be their field of profession, in case of a corp this can be their line of business. See [here](doc:user-resources#section-supported-entity-scope).","default":"","type":"string","name":"documents[entity_scope]"},{"_id":"589b5e4d6d051e0f00f42ff2","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":"589b5e4d6d051e0f00f42ff1","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":"589b5e4d6d051e0f00f42ff0","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":"string","name":"documents[year]"},{"_id":"589b5e4d6d051e0f00f42fef","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":"589b5e4d6d051e0f00f42fee","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":"589b5e4d6d051e0f00f42fed","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":"589b5e4d6d051e0f00f42fec","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":"589b5e4d6d051e0f00f42feb","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. This value needs to be in ISO Alpha-2.","default":"","type":"string","name":"documents[address_country_code]"},{"_id":"589b5e4d6d051e0f00f42fea","ref":"","in":"body","required":false,"desc":"Type of virtual document being submitted.","default":"","type":"string","name":"documents.virtual_docs[document_value]"},{"_id":"589b5e4d6d051e0f00f42fe9","ref":"","in":"body","required":false,"desc":"Value of virtual document being submitted.","default":"","type":"string","name":"documents.virtual_docs[document_type]"},{"_id":"589b5e4d6d051e0f00f42fe8","ref":"","in":"body","required":false,"desc":"Type of physical document being submitted.","default":"","type":"string","name":"documents.physical_docs[document_value]"},{"_id":"589b5e4d6d051e0f00f42fe7","ref":"","in":"body","required":false,"desc":"Value of physical document being submitted.","default":"","type":"string","name":"documents.physical_docs[document_type]"},{"_id":"589b5e4d6d051e0f00f42fe6","ref":"","in":"body","required":false,"desc":"Type of social document being submitted.","default":"","type":"string","name":"documents.social_docs[document_value]"},{"_id":"589b5e4d6d051e0f00f42fe5","ref":"","in":"body","required":false,"desc":"Value of social document being submitted.","default":"","type":"string","name":"documents.social_docs[document_type]"},{"_id":"55fa3f2a17b9d00d00969ea4","ref":"","in":"body","required":false,"desc":"Any note that you wish to supply with the user","default":"","type":"string","name":"extra.note"},{"_id":"55fa3f2a17b9d00d00969ea3","ref":"","in":"body","required":false,"desc":"Any ID you wish to register to the user","default":"","type":"string","name":"extra.supp_id"},{"_id":"55fa3f2a17b9d00d00969ea2","ref":"","in":"body","required":false,"desc":"If the user is a business user, send us True. False by default","default":"","type":"boolean","name":"extra.is_business"},{"_id":"573920ed9042980e00ad1a9f","ref":"","in":"body","required":false,"desc":"CIP tag associated with the account.","default":"","type":"int","name":"extra.cip_tag"},{"_id":"587961a15f13bb0f0091c7fe","ref":"","in":"body","required":false,"desc":"Value denotes if the user can be searched by email/name on Synapse services","default":"false","type":"boolean","name":"extra.is_hidden"}],"url":"/users"},"isReference":true,"order":3,"body":"","excerpt":"","slug":"create-a-user","type":"endpoint","title":"Create User"}

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Body Params

logins[email]:
required
string
Email associated with the user login
logins[password]:
string
Password associated with the user login
logins[read_only]:
boolean
If the login credentials are for admin privileges or ready only. By default read_only is false
phone_numbers:
required
array of strings
All the phone numbers you wish to register with this account
legal_names:
required
array of strings
All the legal names you wish to register with this account
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. See [here](doc:user-resources#section-supported-entity-types).
documents[entity_scope]:
string
Industry in which the document owner operates. In case of a person it can be their field of profession, in case of a corp this can be their line of business. See [here](doc:user-resources#section-supported-entity-scope).
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]:
string
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. This value needs to be in ISO Alpha-2.
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[document_value]:
string
Type of physical document being submitted.
documents.physical_docs[document_type]:
string
Value of physical document being submitted.
documents.social_docs[document_value]:
string
Type of social document being submitted.
documents.social_docs[document_type]:
string
Value of social document being submitted.
extra.note:
string
Any note that you wish to supply with the user
extra.supp_id:
string
Any ID you wish to register to the user
extra.is_business:
boolean
If the user is a business user, send us True. False by default
extra.cip_tag:
integer
CIP tag associated with the account.
extra.is_hidden:
booleanfalse
Value denotes if the user can be searched by email/name on Synapse services

Examples


Result Format