{"_id":"59f79e3c584eb200345cebac","project":"59f79e3c584eb200345ceafc","version":{"_id":"59f79e3c584eb200345ceaff","project":"59f79e3c584eb200345ceafc","__v":8,"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","5afb6888212c690003ae3d3b","5b4bdcd3737d1800031d2293","5b9ed89212362100036b5a1c","5bb29bec77c22500034757ea","5bb29bfe77c22500034757ec","5bc8fa8063924c00186c5ded","5bc8fe9fa472190014a6b103"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"3.1.0","version":"3.1"},"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"},"user":"58d1abdd704af00f0062d849","__v":5,"parentDoc":null,"githubsync":"","updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-06-24T00:27:09.077Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"settings":"","results":{"codes":[{"code":"{\n    \"_id\": \"594e0f151acea2002e6665bb\",\n    \"_links\": {\n        \"self\": {\n            \"href\": \"https://uat-api.synapsefi.com/v3.1/users/594e0f151acea2002e6665bb\"\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    \"emails\": [],\n    \"extra\": {\n        \"cip_tag\": 1,\n        \"date_joined\": 1498287892583,\n        \"extra_security\": false,\n        \"is_business\": false,\n        \"last_updated\": 1498287892583,\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\": \"UNVERIFIED\",\n    \"phone_numbers\": [\n        \"901.111.1111\",\n        \"[email protected]\"\n    ],\n    \"photos\": [],\n    \"refresh_token\": \"refresh_bI0gEY4hv5jZsteonkcrD6qyO3fz2KTd8HFCW9mp\"\n}","language":"json","status":200,"name":""},{"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\": \"MISSING|INVALID\",\n        \"virtual_doc\": \"MISSING|INVALID\"\n    },\n    \"documents\": [\n        {\n            \"id\": \"2a4a5957a3a62aaac1a0dd0edcae96ea2cdee688ec6337b20745eed8869e3ac8\",\n            \"name\": \"Test User\",\n            \"permission_scope\": \"UNVERIFIED\",\n            \"physical_docs\": [\n                {\n                    \"document_type\": \"GOVT_ID\",\n                    \"id\": \"c486c2cb8c1bce695fcfae3197e14aa5b8ddec184c2779d00d581abee5d9a04c\",\n                    \"last_updated\": 1498288031319,\n                    \"status\": \"SUBMITTED|REVIEWING\"\n                }\n            ],\n            \"social_docs\": [\n                {\n                    \"document_type\": \"EMAIL\",\n                    \"id\": \"2c45158f6431ca874bbe82f63d5905567854dde4d8b81539944e5779e5eee741\",\n                    \"last_updated\": 1498288032328,\n                    \"status\": \"SUBMITTED|REVIEWING\"\n                },\n                {\n                    \"document_type\": \"FACEBOOK\",\n                    \"id\": \"8f314a6a53f36ee569455761e49a2a7fe790d251c5611c65255befdb303602b7\",\n                    \"last_updated\": 1498288031824,\n                    \"status\": \"SUBMITTED|REVIEWING\"\n                },\n                {\n                    \"document_type\": \"PHONE_NUMBER\",\n                    \"id\": \"fda60784d6375bc44edafaaeae149626c4c13dcb92e85a2a7a00eec2cdfd2b6f\",\n                    \"last_updated\": 1498288032830,\n                    \"status\": \"SUBMITTED|REVIEWING\"\n                },\n                {\n                    \"document_type\": \"IP\",\n                    \"id\": \"28d9177b22c127d9a51d8903893864accf6e553ac326704a4c0d585eaad2516a\",\n                    \"last_updated\": 1498288033333,\n                    \"status\": \"SUBMITTED|REVIEWING\"\n                }\n            ],\n            \"virtual_docs\": [\n                {\n                    \"document_type\": \"SSN\",\n                    \"id\": \"ee596c2896dddc19b76c07a184fe7d3cf5a04b8e94b9108190cac7890739017f\",\n                    \"last_updated\": 1498288030812,\n                    \"status\": \"SUBMITTED|REVIEWING\"\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\": 1498288029784,\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\": \"UNVERIFIED\",\n    \"phone_numbers\": [\n        \"901.111.1111\",\n        \"[email protected]\"\n    ],\n    \"photos\": [],\n    \"refresh_token\": \"refresh_ehG7YBS8ZiD0sLa6PQHMUxryovVkJzElC5gWROXq\"\n}","language":"json","status":200,"name":"With Base Docs"}]},"method":"post","examples":{"codes":[{"language":"http","name":"w/o Base Docs","code":"POST /v3.1/users 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: |e83cf6ddcf778e37bfe3d48fc78a6502062fc\nContent-Type: application/json\n\n{\n  \"logins\": [\n    {\n      \"email\": \"[email protected]\"\n    }\n  ],\n  \"phone_numbers\": [\n    \"901.111.1111\",\n    \"[email protected]\"\n  ],\n  \"legal_names\": [\n    \"Test User\"\n  ],\n  \"extra\": {\n    \"supp_id\": \"122eddfgbeafrfvbbb\",\n    \"cip_tag\":1,\n    \"is_business\": false\n  }\n}"},{"name":"With Base Docs","language":"http","code":"POST /v3.1/users 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: |e83cf6ddcf778e37bfe3d48fc78a6502062fc\nContent-Type: application/json\n\n{\n  \"logins\": [\n    {\n      \"email\": \"[email protected]\"\n    }\n  ],\n  \"phone_numbers\": [\n    \"901.111.1111\",\n    \"[email protected]\"\n  ],\n  \"legal_names\": [\n    \"Test User\"\n  ],\n  \"documents\":[{\n        \"email\":\"[email protected]\",\n        \"phone_number\":\"901.111.1111\",\n        \"ip\":\"::1\",\n        \"name\":\"Test User\",\n        \"alias\":\"Test\",\n        \"entity_type\":\"M\",\n        \"entity_scope\":\"Arts & Entertainment\",\n        \"day\":2,\n        \"month\":5,\n        \"year\":1989,\n        \"address_street\":\"1 Market St.\",\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,SUQs==\",\n            \"document_type\": \"GOVT_ID\"\n        }],\n        \"social_docs\":[{\n            \"document_value\":\"https://www.facebook.com/valid\",\n            \"document_type\":\"FACEBOOK\"\n        }]\n    }],\n  \"extra\": {\n    \"supp_id\": \"122eddfgbeafrfvbbb\",\n    \"cip_tag\":1,\n    \"is_business\": false\n  }\n}"}]},"auth":"required","params":[{"_id":"5573b11e91ce6e190023b76a","ref":"","in":"body","required":true,"desc":"User logins. See Login Object [here](#section-login-resource)","default":"","type":"array_object","name":"logins"},{"_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":"User KYC documents. See Documents Object [here](#section-documents-resource)","default":"","type":"array_object","name":"documents"},{"_id":"55fa3f2a17b9d00d00969ea4","ref":"","in":"body","required":false,"desc":"Any note that you wish to supply to Synapse about the user (not returned with user object)","default":"","type":"string","name":"extra.note"},{"_id":"594e155257b2c60061f146c5","ref":"","in":"body","required":false,"desc":"Any note that you wish to attach to the user (returned with user object)","default":"","type":"string","name":"extra.public_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":"5b317b7fd27b630003327ddd","ref":"","in":"body","required":false,"desc":"If you wish for the user to get a 2FA code every time they OAuth or Login themselves, set this to `true`","default":"false","type":"boolean","name":"extra.extra_security"},{"_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":"is_hidden"}],"url":"/v3.1/users"},"isReference":true,"order":2,"body":"[block:api-header]\n{}\n[/block]\n## Login Resource\n[block:html]\n{\n  \"html\": \"<div class=\\\"api-manager\\\"><div class=\\\"param-table\\\"><div class=\\\"table\\\"><h4 class=\\\"paramGroupTitle\\\">Body Params</h4><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong>email<span class=\\\"colon\\\">:</span></strong><div class=\\\"required\\\">required</div></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">string</strong><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>Email associated with the login</p>\\n</div></div></div><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong>password<span class=\\\"colon\\\">:</span></strong></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">string</strong><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>Password associated with the user login</p>\\n</div></div></div><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong>scope<span class=\\\"colon\\\">:</span></strong><div class=\\\"required\\\">required</div></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">string</strong><span class=\\\"param-default text-muted\\\">READ_AND_WRITE</span><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>Value denotes what permissions the login credentials has. Currently only two scopes are supported: <code>READ_AND_WRITE</code> &amp; <code>READ</code></p>\\n</div></div></div></div></div></div>\"\n}\n[/block]\n## Documents Resource\n[block:html]\n{\n  \"html\": \"<div class=\\\"api-manager\\\"><div class=\\\"param-table\\\"><div class=\\\"table\\\"><h4 class=\\\"paramGroupTitle\\\">Body Params</h4><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong>name<span class=\\\"colon\\\">:</span></strong><div class=\\\"required\\\">required</div></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">string</strong><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>Name of the document owner</p>\\n</div></div></div><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong>alias<span class=\\\"colon\\\">:</span></strong></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">string</strong><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>Alias of the document owner (this can be the name or in case of businesses it can be the DBA entry)</p>\\n</div></div></div><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong>email<span class=\\\"colon\\\">:</span></strong><div class=\\\"required\\\">required</div></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">string</strong><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>Email associated with the document</p>\\n</div></div></div><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong>phone_number<span class=\\\"colon\\\">:</span></strong><div class=\\\"required\\\">required</div></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">string</strong><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>Phone number associated with the document</p>\\n</div></div></div><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong>ip<span class=\\\"colon\\\">:</span></strong><div class=\\\"required\\\">required</div></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">string</strong><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>IP of where the document is being submitted from</p>\\n</div></div></div><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong>entity_type<span class=\\\"colon\\\">:</span></strong><div class=\\\"required\\\">required</div></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">string</strong><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>Entity type of the document owner, this can be gender in case of an individual or DBA in case of a business. See <a href=\\\"https://docs.synapsefi.com/v3.1/docs/user-resources#section-supported-entity-types\\\">here</a></p>\\n</div></div></div><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong>entity_scope<span class=\\\"colon\\\">:</span></strong><div class=\\\"required\\\">required</div></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">string</strong><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>Industry in which the document owner operates. In case of an individual it can be their field of profession, in case of a corp this can be their line of business. See <a href=\\\"https://docs.synapsefi.com/v3.1/docs/user-resources#section-supported-entity-scope\\\">here</a></p>\\n</div></div></div><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong>day<span class=\\\"colon\\\">:</span></strong><div class=\\\"required\\\">required</div></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">integer</strong><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>In case of a person this is day of birth. In case of business entity, this is day of organization</p>\\n</div></div></div><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong>month<span class=\\\"colon\\\">:</span></strong><div class=\\\"required\\\">required</div></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">integer</strong><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>In case of a person this is month of birth. In case of business entity, this is month of organization</p>\\n</div></div></div><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong>year<span class=\\\"colon\\\">:</span></strong><div class=\\\"required\\\">required</div></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">integer</strong><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>In case of a person this is year of birth (must be over 18). In case of business entity, this is year of organization</p>\\n</div></div></div><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong>address_street<span class=\\\"colon\\\">:</span></strong><div class=\\\"required\\\">required</div></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">string</strong><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>Address associated with the document owner, this can be home address of a person or business address of a corp.</p>\\n</div></div></div><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong>address_city<span class=\\\"colon\\\">:</span></strong><div class=\\\"required\\\">required</div></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">string</strong><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>Address associated with the document owner, this can be home address of a person or business address of a corp.</p>\\n</div></div></div><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong>address_subdivision<span class=\\\"colon\\\">:</span></strong><div class=\\\"required\\\">required</div></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">string</strong><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>Address associated with the document owner, this can be home address of a person or business address of a corp. <strong>This value needs to be in <a href=\\\"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2\\\">ISO Alpha-2</a></strong>.</p>\\n</div></div></div><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong>address_postal_code<span class=\\\"colon\\\">:</span></strong><div class=\\\"required\\\">required</div></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">string</strong><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>Address associated with the document owner, this can be home address of a person or business address of a corp.</p>\\n</div></div></div><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong>address_country_code<span class=\\\"colon\\\">:</span></strong><div class=\\\"required\\\">required</div></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">string</strong><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>Address associated with the document owner, this can be home address of a person or business address of a corp. <strong>This value needs to be in <a href=\\\"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2\\\">ISO Alpha-2</a></strong>.</p>\\n</div></div></div><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong>virtual_docs<span class=\\\"colon\\\">:</span></strong></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">array of objects</strong><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>See Sub-Document Object <a href=\\\"#section-sub-document-resource\\\">here</a></p>\\n</div></div></div><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong>physical_docs<span class=\\\"colon\\\">:</span></strong></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">array of objects</strong><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>See Sub-Document Object <a href=\\\"#section-sub-document-resource\\\">here</a></p>\\n</div></div></div><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong>social_docs<span class=\\\"colon\\\">:</span></strong></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">array of objects</strong><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>See Sub-Document Object <a href=\\\"#section-sub-document-resource\\\">here</a></p>\\n</div></div></div></div></div></div>\"\n}\n[/block]\n## Sub-Document Resource\n[block:html]\n{\n  \"html\": \"<div class=\\\"api-manager\\\"><div class=\\\"param-table\\\"><div class=\\\"table\\\"><h4 class=\\\"paramGroupTitle\\\">Body Params</h4><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong>document_type<span class=\\\"colon\\\">:</span></strong><div class=\\\"required\\\">required</div></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">string</strong><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>Type of document (<a href=\\\"https://docs.synapsefi.com/v3.1/docs/user-resources#section-physical-document-types\\\">physical</a>, <a href=\\\"https://docs.synapsefi.com/v3.1/docs/user-resources#section-virtual-document-types\\\">virtual</a>, <a href=\\\"https://docs.synapsefi.com/v3.1/docs/user-resources#section-social-document-types\\\">social</a>)</p>\\n</div></div></div><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong>document_value<span class=\\\"colon\\\">:</span></strong><div class=\\\"required\\\">required</div></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">string</strong><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>Value of the document (in case of physical documents, submit the padded base64 value of the file you wish to upload)</p>\\n</div></div></div></div></div></div>\"\n}\n[/block]\n\n[block:api-header]\n{}\n[/block]\n## Idempotent Requests\n\nUsers POST call supports [idempotency](https://en.wikipedia.org/wiki/Idempotence) for safely retrying requests without accidentally performing the same operation twice. For example, if a request to create a user fails due to a network connection error, you can retry the request with the same idempotency key to guarantee that only a user object is created.\n\nTo perform an idempotent request, attach a unique key to any POST request made to the API via the `X-SP-IDEMPOTENCY-KEY: <key>` header.\n\n**Idempotency keys expire after 24 hours.**","excerpt":"Create a new user on your platform","slug":"create-a-user","type":"endpoint","title":"Create User"}

postCreate User

Create a new user on your platform

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Body Params

logins:
required
array of objects
User logins. See Login Object [here](#section-login-resource)
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:
array of objects
User KYC documents. See Documents Object [here](#section-documents-resource)
extra.note:
string
Any note that you wish to supply to Synapse about the user (not returned with user object)
extra.public_note:
string
Any note that you wish to attach to the user (returned with user object)
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.extra_security:
booleanfalse
If you wish for the user to get a 2FA code every time they OAuth or Login themselves, set this to `true`
is_hidden:
booleanfalse
Value denotes if the user can be searched by email/name on Synapse services

Examples


Result Format


Documentation

[block:api-header] {} [/block] ## Login Resource [block:html] { "html": "<div class=\"api-manager\"><div class=\"param-table\"><div class=\"table\"><h4 class=\"paramGroupTitle\">Body Params</h4><div class=\"tr\"><div class=\"td param\"><strong>email<span class=\"colon\">:</span></strong><div class=\"required\">required</div></div><div class=\"td\"><strong class=\"param-type\">string</strong><div marked=\"\" class=\"ng-isolate-scope\"><p>Email associated with the login</p>\n</div></div></div><div class=\"tr\"><div class=\"td param\"><strong>password<span class=\"colon\">:</span></strong></div><div class=\"td\"><strong class=\"param-type\">string</strong><div marked=\"\" class=\"ng-isolate-scope\"><p>Password associated with the user login</p>\n</div></div></div><div class=\"tr\"><div class=\"td param\"><strong>scope<span class=\"colon\">:</span></strong><div class=\"required\">required</div></div><div class=\"td\"><strong class=\"param-type\">string</strong><span class=\"param-default text-muted\">READ_AND_WRITE</span><div marked=\"\" class=\"ng-isolate-scope\"><p>Value denotes what permissions the login credentials has. Currently only two scopes are supported: <code>READ_AND_WRITE</code> &amp; <code>READ</code></p>\n</div></div></div></div></div></div>" } [/block] ## Documents Resource [block:html] { "html": "<div class=\"api-manager\"><div class=\"param-table\"><div class=\"table\"><h4 class=\"paramGroupTitle\">Body Params</h4><div class=\"tr\"><div class=\"td param\"><strong>name<span class=\"colon\">:</span></strong><div class=\"required\">required</div></div><div class=\"td\"><strong class=\"param-type\">string</strong><div marked=\"\" class=\"ng-isolate-scope\"><p>Name of the document owner</p>\n</div></div></div><div class=\"tr\"><div class=\"td param\"><strong>alias<span class=\"colon\">:</span></strong></div><div class=\"td\"><strong class=\"param-type\">string</strong><div marked=\"\" class=\"ng-isolate-scope\"><p>Alias of the document owner (this can be the name or in case of businesses it can be the DBA entry)</p>\n</div></div></div><div class=\"tr\"><div class=\"td param\"><strong>email<span class=\"colon\">:</span></strong><div class=\"required\">required</div></div><div class=\"td\"><strong class=\"param-type\">string</strong><div marked=\"\" class=\"ng-isolate-scope\"><p>Email associated with the document</p>\n</div></div></div><div class=\"tr\"><div class=\"td param\"><strong>phone_number<span class=\"colon\">:</span></strong><div class=\"required\">required</div></div><div class=\"td\"><strong class=\"param-type\">string</strong><div marked=\"\" class=\"ng-isolate-scope\"><p>Phone number associated with the document</p>\n</div></div></div><div class=\"tr\"><div class=\"td param\"><strong>ip<span class=\"colon\">:</span></strong><div class=\"required\">required</div></div><div class=\"td\"><strong class=\"param-type\">string</strong><div marked=\"\" class=\"ng-isolate-scope\"><p>IP of where the document is being submitted from</p>\n</div></div></div><div class=\"tr\"><div class=\"td param\"><strong>entity_type<span class=\"colon\">:</span></strong><div class=\"required\">required</div></div><div class=\"td\"><strong class=\"param-type\">string</strong><div marked=\"\" class=\"ng-isolate-scope\"><p>Entity type of the document owner, this can be gender in case of an individual or DBA in case of a business. See <a href=\"https://docs.synapsefi.com/v3.1/docs/user-resources#section-supported-entity-types\">here</a></p>\n</div></div></div><div class=\"tr\"><div class=\"td param\"><strong>entity_scope<span class=\"colon\">:</span></strong><div class=\"required\">required</div></div><div class=\"td\"><strong class=\"param-type\">string</strong><div marked=\"\" class=\"ng-isolate-scope\"><p>Industry in which the document owner operates. In case of an individual it can be their field of profession, in case of a corp this can be their line of business. See <a href=\"https://docs.synapsefi.com/v3.1/docs/user-resources#section-supported-entity-scope\">here</a></p>\n</div></div></div><div class=\"tr\"><div class=\"td param\"><strong>day<span class=\"colon\">:</span></strong><div class=\"required\">required</div></div><div class=\"td\"><strong class=\"param-type\">integer</strong><div marked=\"\" class=\"ng-isolate-scope\"><p>In case of a person this is day of birth. In case of business entity, this is day of organization</p>\n</div></div></div><div class=\"tr\"><div class=\"td param\"><strong>month<span class=\"colon\">:</span></strong><div class=\"required\">required</div></div><div class=\"td\"><strong class=\"param-type\">integer</strong><div marked=\"\" class=\"ng-isolate-scope\"><p>In case of a person this is month of birth. In case of business entity, this is month of organization</p>\n</div></div></div><div class=\"tr\"><div class=\"td param\"><strong>year<span class=\"colon\">:</span></strong><div class=\"required\">required</div></div><div class=\"td\"><strong class=\"param-type\">integer</strong><div marked=\"\" class=\"ng-isolate-scope\"><p>In case of a person this is year of birth (must be over 18). In case of business entity, this is year of organization</p>\n</div></div></div><div class=\"tr\"><div class=\"td param\"><strong>address_street<span class=\"colon\">:</span></strong><div class=\"required\">required</div></div><div class=\"td\"><strong class=\"param-type\">string</strong><div marked=\"\" class=\"ng-isolate-scope\"><p>Address associated with the document owner, this can be home address of a person or business address of a corp.</p>\n</div></div></div><div class=\"tr\"><div class=\"td param\"><strong>address_city<span class=\"colon\">:</span></strong><div class=\"required\">required</div></div><div class=\"td\"><strong class=\"param-type\">string</strong><div marked=\"\" class=\"ng-isolate-scope\"><p>Address associated with the document owner, this can be home address of a person or business address of a corp.</p>\n</div></div></div><div class=\"tr\"><div class=\"td param\"><strong>address_subdivision<span class=\"colon\">:</span></strong><div class=\"required\">required</div></div><div class=\"td\"><strong class=\"param-type\">string</strong><div marked=\"\" class=\"ng-isolate-scope\"><p>Address associated with the document owner, this can be home address of a person or business address of a corp. <strong>This value needs to be in <a href=\"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2\">ISO Alpha-2</a></strong>.</p>\n</div></div></div><div class=\"tr\"><div class=\"td param\"><strong>address_postal_code<span class=\"colon\">:</span></strong><div class=\"required\">required</div></div><div class=\"td\"><strong class=\"param-type\">string</strong><div marked=\"\" class=\"ng-isolate-scope\"><p>Address associated with the document owner, this can be home address of a person or business address of a corp.</p>\n</div></div></div><div class=\"tr\"><div class=\"td param\"><strong>address_country_code<span class=\"colon\">:</span></strong><div class=\"required\">required</div></div><div class=\"td\"><strong class=\"param-type\">string</strong><div marked=\"\" class=\"ng-isolate-scope\"><p>Address associated with the document owner, this can be home address of a person or business address of a corp. <strong>This value needs to be in <a href=\"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2\">ISO Alpha-2</a></strong>.</p>\n</div></div></div><div class=\"tr\"><div class=\"td param\"><strong>virtual_docs<span class=\"colon\">:</span></strong></div><div class=\"td\"><strong class=\"param-type\">array of objects</strong><div marked=\"\" class=\"ng-isolate-scope\"><p>See Sub-Document Object <a href=\"#section-sub-document-resource\">here</a></p>\n</div></div></div><div class=\"tr\"><div class=\"td param\"><strong>physical_docs<span class=\"colon\">:</span></strong></div><div class=\"td\"><strong class=\"param-type\">array of objects</strong><div marked=\"\" class=\"ng-isolate-scope\"><p>See Sub-Document Object <a href=\"#section-sub-document-resource\">here</a></p>\n</div></div></div><div class=\"tr\"><div class=\"td param\"><strong>social_docs<span class=\"colon\">:</span></strong></div><div class=\"td\"><strong class=\"param-type\">array of objects</strong><div marked=\"\" class=\"ng-isolate-scope\"><p>See Sub-Document Object <a href=\"#section-sub-document-resource\">here</a></p>\n</div></div></div></div></div></div>" } [/block] ## Sub-Document Resource [block:html] { "html": "<div class=\"api-manager\"><div class=\"param-table\"><div class=\"table\"><h4 class=\"paramGroupTitle\">Body Params</h4><div class=\"tr\"><div class=\"td param\"><strong>document_type<span class=\"colon\">:</span></strong><div class=\"required\">required</div></div><div class=\"td\"><strong class=\"param-type\">string</strong><div marked=\"\" class=\"ng-isolate-scope\"><p>Type of document (<a href=\"https://docs.synapsefi.com/v3.1/docs/user-resources#section-physical-document-types\">physical</a>, <a href=\"https://docs.synapsefi.com/v3.1/docs/user-resources#section-virtual-document-types\">virtual</a>, <a href=\"https://docs.synapsefi.com/v3.1/docs/user-resources#section-social-document-types\">social</a>)</p>\n</div></div></div><div class=\"tr\"><div class=\"td param\"><strong>document_value<span class=\"colon\">:</span></strong><div class=\"required\">required</div></div><div class=\"td\"><strong class=\"param-type\">string</strong><div marked=\"\" class=\"ng-isolate-scope\"><p>Value of the document (in case of physical documents, submit the padded base64 value of the file you wish to upload)</p>\n</div></div></div></div></div></div>" } [/block] [block:api-header] {} [/block] ## Idempotent Requests Users POST call supports [idempotency](https://en.wikipedia.org/wiki/Idempotence) for safely retrying requests without accidentally performing the same operation twice. For example, if a request to create a user fails due to a network connection error, you can retry the request with the same idempotency key to guarantee that only a user object is created. To perform an idempotent request, attach a unique key to any POST request made to the API via the `X-SP-IDEMPOTENCY-KEY: <key>` header. **Idempotency keys expire after 24 hours.**