Ctrl+K

Get user

get/api/v2/user/{id}

Returns the associated user

Path Parameters

  • idstringRequired
    The user ID, email address, or `me` for the currently authenticated user
    Example: 59cd72485007a239fb00282ed480da1f
    Pattern: ^[0-9a-f]{32}$

Query Parameters

  • orgIdstring
    The organization ID by which to filter the user's enterprises.
  • maxEnterprisesinteger
    Specifies the maximum number of enterprises to return. An organization ID must be provided. The maximum limit is 50 enterprises.

200 Response

id string
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
isActive boolean
isFrozen boolean
freezeReason string
Example: Frozen due to suspicious activity
name object
first string
Example: Jane
full string
Example: Jane Doe
last string
Example: Doe
username string <email>
Example: user@example.com
email object
email string <email>
Example: user@example.com
verified boolean
Example: true
phone object
phone string
Example: 408-718-6885
verified boolean
Example: true
country string
Example: USA
state string
Example: New York
kycStatus string
user's overall KYC status
Allowed values: approved pending rejected unverified
Example: approved

400 Response

One of
error string required
Human-readable error message
requestId string required
Client request id
context object
Properties that apply to a specific error name
name string required
Error code