Ctrl+K

Get settings

get/api/v2/user/settings

Returns a combination of the User object and user settings fields. This spec is incomplete. It only documents the client field.

200 Response

settings object
id string
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
isActive boolean
isFrozen boolean
freezeReason string
Example: Frozen due to suspicious activity
name object
username string <email>
Example: user@example.com
email object
phone object
country string
Example: USA
state string
Example: New York
kycStatus string
user's overall KYC status
Allowed values: approved pending rejected unverified
Example: approved
client object required
A collection of properties that can be set and read by API clients, for the purpose of persisting client-side user settings. These properties do not affect server behavior.
Example: {"name":"Joe","age":12,"parents":[{"name":"Jim","age":41},{"name":"Sue","age":38}]}