Get End User
GET
https://api.sfox.com/v1/enterprise/users/:user_id
Retrieve a single, specific end user.
Request
Path Parameters
user_id
required, string
user_id
of the specific end user to retrieve.
Example Requests
curl -H "Authorization: Bearer ${ENTERPRISE_API_KEY}" \
'https://api.sfox.com/v1/enterprise/users/${USER_ID}'
Response
Returns a data
object with the following response fields.
Response Fields
account_type
string
The end user's account type.
Possible values: individual
, corporation
account_role
string
The end user's role.
Possible values: Client
, Advisor
user_id
string
End user's unique ID, defined by you.
advisor_user_id
nullable, string
user_id
of the end user's, if applicable.
email
string
Email address of the user.
first_name
string
First name of the user.
last_name
string
Last name of the user.
phone_number
string
Phone number of the user in E.164 format (e.g. +14155552671
).
status
string
Verification status of the user’s sFOX account.
Possible values: PENDING
, VERIFIED
, UNSUPPORTED
requirements
object
The remaining requirements to complete account verification.
Responses
Last updated