View User

get https://uat-api.synapsefi.com/v3.1/users/{user_id}

Get user information by user ID

User Object

Key	Type	Description
_id	string	Object ID of the user
_links.self.href	string	HAL-style link for the object
client.id	string	Object ID of client
client.name	string	Name of the client that created the user
documents[]	array of objects	List of Base Document Objects
extra.cip_tag	integer	Customer Identification Program number
extra.date_joined	integer	Date user joined (milliseconds since Unix epoch time).
extra.is_business	boolean	Flag for businesses
extra.is_trusted	boolean	Flag for trusted users
extra.last_updated	integer	Date user was last updated (milliseconds since Unix epoch time).
extra.supp_id	string	Additional ID to assign to user
legal_names	array of strings	Legal names associated with the user
logins[]	array of objects	List of login objects
permission	string	See User Permissions for more information.
permission_code	string	For closed or locked users, `permission_code` will specify the reason the user was closed or locked. See User Permission Codes (Reason Codes) for more information.
phone_numbers	array of strings	List of emails and phone numbers for verifying MFA
refresh_token	string	User-specific refresh token for `oauth` (expires after 10 uses)
watchlists	string	Flag to indicate if user is a `SOFT_MATCH` or `MATCH` in watchlists / sanctions lists checks performed by Synapse's KYC verification system. Verified users who pass these checks should have `NO_MATCH` reflected for this flag, while unverified users will generally show as `PENDING`. See Sanctions Tiers and Watchlists Explained for more information.

Login Object

Key	Type	Description
email	string	Login email
scope	string	Permissions granted to login credentials

Additional Information

Use this call when you need to:

Grab a new refresh_token from the user (for Issue OAuth Key)
View KYC documents, including those not stored on your servers
Check the status of a user's documents

Language

Authorization

OAuth2