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.

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\">integer</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.synapsepay.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.synapsepay.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.synapsepay.com/v3.1/docs/user-resources#section-physical-document-types\">physical</a>, <a href=\"https://docs.synapsepay.com/v3.1/docs/user-resources#section-virtual-document-types\">virtual</a>, <a href=\"https://docs.synapsepay.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.**