Get End User

GET

https://api.sfox.com/v1/enterprise/users/:user_id

Retrieve a single, specific end user.


Retrieve a list of multiple end users by executing a Get Multiple End Users request.

Request

Path Parameters

Parameter
Description

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

Field
Description

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

200: OK
Response for a single user_id: client_account_1
{
    "data": {
        "account_type": "individual",
        "account_role": "Client",
        "user_id": "client_account_1",
        "advisor_user_id": null,
        "email": "[email protected]",
        "first_name": "Sean",
        "last_name": "Fox",
        "phone_number": "+12345678900",
        "status": "VERIFIED",
        "requirements": {
            "email": false,
            "sms": false
        }
    }
}

Last updated