[Required] List of login credentials (refer to "User Login Credentials Object" below)
phone_numbers
array of strings
[Required] All the phone numbers and emails you wish to register with this account
legal_names
array of strings
[Required] All the legal names you wish to register with this account
documents[]
array of objects
List of user KYC documents. See Base Documents for more information
extra.cip_tag
integer
CIP tag associated with the account
extra.extra_security
boolean
If you wish for the user to get a 2FA code every time they OAuth or Login themselves, set this to true
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.is_business
boolean
Set to true if business account
extra.supp_id
string
[Max Characters: 250] Additional ID to assign to the node
User Login Credentials Object
Key
Type
Description
email
string
[Required] Login email
password
string
[Required] Must be at least 8 characters long and include a combination of the following: a lowercase letter, an uppercase letter, a number, and a special character