latestOpenAPI 3.0.32026-08-224982,0272.8 MB
e445c15e5bee
User
Get user
Returns the associated user
get/api/v2/user/{id}
Path parameters
idstring required
Example:59cd72485007a239fb00282ed480da1f
The user ID, email address, or me for the currently authenticated user
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.
Response
OK
Example response
{
"user": {
"id": "59cd72485007a239fb00282ed480da1f",
"freezeReason": "Frozen due to suspicious activity",
"name": {
"first": "Jane",
"full": "Jane Doe",
"last": "Doe"
},
"username": "user@example.com",
"email": {
"email": "user@example.com",
"verified": true
},
"phone": {
"phone": "408-718-6885",
"verified": true
},
"country": "USA",
"state": "New York",
"kycStatus": "approved"
}
}