# Update End User

<table data-header-hidden><thead><tr><th width="88.976318359375" align="center"></th><th></th></tr></thead><tbody><tr><td align="center"><mark style="color:blue;"><strong>PATCH</strong></mark> </td><td>https://api.sfox.com/v1/enterprise/users/{user_id}</td></tr></tbody></table>

Update an existing end user, likely as part of the onboarding and KYC process.  As a reminder, an end user represents a customer of your business. An end user can be either an `individual` (person) or `corporation` (business).

{% hint style="info" %}
Only a subset of attributes are accepted on the PATCH endpoint.  This subset represents the non-required attributes within the `create end user` payload.\
\
Further, the PATCH endpoint only updates attributes which previously had non-existent (null) values.  It does **not** overwrite values that currently exist on the end user.
{% endhint %}

***

## Request

### Accepted Body Parameters

<table data-full-width="false"><thead><tr><th width="229.85546875" valign="top">Parameter</th><th valign="top">Description</th></tr></thead><tbody><tr><td valign="top"><code>source_of_funds</code> <br>string</td><td valign="top">Primary source of end user's funds transferred to their account.<br><em>Possible values:</em> <code>employment</code>,  <code>savings</code>,  <code>business_income</code>, <code>investor_capital</code>, <code>investments</code>, <code>property_sale</code>, <code>loans</code>, <code>retirement</code>, <code>trading</code>, <code>mining</code>, <code>airdrops</code>, <code>grants</code>, <code>donations_winnings</code>, <code>inheritance_gifts</code>, <code>other</code></td></tr><tr><td valign="top"><code>source_of_funds_other</code><br>string</td><td valign="top"><p>Description of the end user's primary source of funds, if <code>source_of_funds</code> = <code>other</code>. </p><p></p><p><strong>Required if <code>source_of_funds</code> = <code>other</code></strong></p></td></tr><tr><td valign="top"><code>intermediary_status</code><br>boolean</td><td valign="top">Will the end user be receiving or sending funds on behalf of someone other than themselves.</td></tr><tr><td valign="top"><code>expected_transfer_volume</code> <br>string</td><td valign="top"><p>Expected monthly USD notional volume of transfers (sent and received).</p><p><br><em>Possible values: <code>under_1000</code>, <code>1000_to_9999</code>, <code>10000_to_99999</code>, <code>100000_to_249999</code>, <code>250000_to_999999</code>, <code>1000000_to_9999999</code>, <code>10000000_to_99999999</code>, <code>over_100000000</code></em></p></td></tr><tr><td valign="top"><code>expected_trade_volume</code> <br>string</td><td valign="top"><p>Expected monthly USD notional volume of trading (buys and sells).</p><p><br><em>Possible values:</em> <code>under_1000</code>, <code>1000_to_9999</code>, <code>10000_to_99999</code>, <code>100000_to_249999</code>, <code>250000_to_999999</code>, <code>1000000_to_9999999</code>, <code>10000000_to_99999999</code>, <code>over_100000000</code></p></td></tr><tr><td valign="top"><code>individual</code><br><a href="#individual-parameters">object</a></td><td valign="top"><p>The individual's identity information, specified in an <a href="#individual-parameters">Individual object</a>.</p><p><br><strong>Required if <code>account_type</code> = <code>individual</code></strong></p></td></tr><tr><td valign="top"><code>business</code><br><a href="#business-parameters">object</a></td><td valign="top"><p>The business entity and organizational information, specified in a <a href="#business-parameters">Business object</a>.</p><p><br><strong>Required if <code>account_type</code> = <code>corporation</code></strong> </p></td></tr><tr><td valign="top"><code>beneficial_owners</code><br> [<a href="#beneficial-owner-parameters">object</a>]</td><td valign="top"><p>The business' beneficial owners, specified as an array of <a href="#beneficial-owner-parameters">Beneficial Owner objects</a>. </p><p><br><strong>Required if <code>account_type</code> = <code>corporation</code></strong></p></td></tr></tbody></table>

#### Individual Parameters

<table data-full-width="false"><thead><tr><th width="239.5625" valign="top">Parameter</th><th valign="top">Description</th></tr></thead><tbody><tr><td valign="top"><code>employment_status</code><br>string</td><td valign="top"><p>The individual's current working status or working relationship with organization(s).</p><p><br>Possible values: <code>full_time_employee</code>, <code>unemployed</code>, <code>retired</code>, <code>student</code>,  <code>self_employed</code>, <code>independent_contractor</code></p></td></tr><tr><td valign="top"><code>industry</code><br>string</td><td valign="top"><p>The industry or sector that the individual primarily or currently works in.</p><p><br>Possible values: <code>agriculture</code>, <code>administrative_support_services</code>, <code>arts_media</code>, <code>consulting</code>, <code>construction</code>, <code>education</code>, <code>entertainment</code>, <code>energy</code>, <code>ecommerce_digital_platforms</code>, <code>financial_services</code>, <code>food_hospitality</code>, <code>government</code>, <code>healthcare</code>, <code>information_media</code>, <code>manufacturing</code>, <code>mining_crypto</code>, <code>mining_extraction</code>, <code>non_profit</code>, <code>professional_services</code>, <code>personal_services</code>, <code>real_estate</code>, <code>retail_trade</code>,  <code>social_services</code>, <code>transportation_warehousing</code>, <code>technology_software</code>, <code>utilities</code>, <code>wholesale_trade</code></p></td></tr><tr><td valign="top"><code>occupation</code><br>string</td><td valign="top"><p>The individual's primary occupation.</p><p><br>Possible values: <code>management_executive</code>, <code>business_financial_operations</code>, <code>computer_mathematical</code>, <code>architecture_engineering</code>, <code>life_physical_social_science</code>, <code>healthcare_practitioners_technical</code>, <code>healthcare_support</code>, <code>legal</code>, <code>education_training_library</code>, <code>arts_design_entertainment_media</code>, <code>community_social_service</code>, <code>protective_service</code>, <code>sales_related</code>, <code>office_administrative_support</code>, <code>food_preparation_serving</code>, <code>personal_care_service</code>, <code>building_grounds_maintenance</code>, <code>construction_extraction</code>, <code>installation_maintenance_repair</code>, <code>production_manufacturing</code>, <code>transportation_material_moving</code>, <code>farming_fishing_forestry</code>, <code>military</code>, <code>student</code>, <code>homemaker_caregiver</code>, <code>unemployed_between_jobs</code>, <code>retired</code></p></td></tr><tr><td valign="top"><code>job_title</code><br>string</td><td valign="top">The individual's current job title or position.</td></tr></tbody></table>

#### Business Parameters

<table data-full-width="false"><thead><tr><th width="239.52734375" valign="top">Parameter</th><th valign="top">Description</th></tr></thead><tbody><tr><td valign="top"><code>website</code><br>string</td><td valign="top">URL to the business’s website.</td></tr></tbody></table>

#### Beneficial Owner Parameters

To update beneficial owner attributes, you must first fetch the `id` of the beneficial owner you want to update via [Get End User](https://docs.sfox.com/connect/~/revisions/XjE6iuJxJevKdUgj0u8F/rest-api/end-users/get-end-user). &#x20;

Once you have the `id`, it must be included in the JSON payload's `Beneficial Owner` object so the sFOX system knows which owner should be updated.  To illustrate, an example JSON structure is defined [here](https://app.gitbook.com/o/DDorFtFaZPzNTnUuO47c/s/SqieKWDmfvEO9Y0sbJUb/~/edit/~/changes/263/rest-api/end-users/update-end-user#curl-1).

<table data-full-width="false"><thead><tr><th width="240.46875" valign="top">Parameter</th><th valign="top">Description</th></tr></thead><tbody><tr><td valign="top"><code>employment_status</code><br>string</td><td valign="top"><p>The owner's current working status or working relationship with organization(s).</p><p><br>Possible values: <code>full_time_employee</code>, <code>unemployed</code>, <code>retired</code>, <code>student</code>,  <code>self_employed</code>, <code>independent_contractor</code></p></td></tr><tr><td valign="top"><code>industry</code><br>string</td><td valign="top"><p>The industry or sector that the owner primarily or currently works in.</p><p><br>Possible values: <code>agriculture</code>, <code>administrative_support_services</code>, <code>arts_media</code>, <code>consulting</code>, <code>construction</code>, <code>education</code>, <code>entertainment</code>, <code>energy</code>, <code>ecommerce_digital_platforms</code>, <code>financial_services</code>, <code>food_hospitality</code>, <code>government</code>, <code>healthcare</code>, <code>information_media</code>, <code>manufacturing</code>, <code>mining_crypto</code>, <code>mining_extraction</code>, <code>non_profit</code>, <code>professional_services</code>, <code>personal_services</code>, <code>real_estate</code>, <code>retail_trade</code>,  <code>social_services</code>, <code>transportation_warehousing</code>, <code>technology_software</code>, <code>utilities</code>, <code>wholesale_trade</code></p></td></tr><tr><td valign="top"><code>occupation</code><br>string</td><td valign="top"><p>The owner's primary occupation.</p><p><br>Possible values: <code>management_executive</code>, <code>business_financial_operations</code>, <code>computer_mathematical</code>, <code>architecture_engineering</code>, <code>life_physical_social_science</code>, <code>healthcare_practitioners_technical</code>, <code>healthcare_support</code>, <code>legal</code>, <code>education_training_library</code>, <code>arts_design_entertainment_media</code>, <code>community_social_service</code>, <code>protective_service</code>, <code>sales_related</code>, <code>office_administrative_support</code>, <code>food_preparation_serving</code>, <code>personal_care_service</code>, <code>building_grounds_maintenance</code>, <code>construction_extraction</code>, <code>installation_maintenance_repair</code>, <code>production_manufacturing</code>, <code>transportation_material_moving</code>, <code>farming_fishing_forestry</code>, <code>military</code>, <code>student</code>, <code>homemaker_caregiver</code>, <code>unemployed_between_jobs</code>, <code>retired</code></p></td></tr><tr><td valign="top"><code>job_title</code><br>string</td><td valign="top">The owner's current job title or position.</td></tr></tbody></table>

### Example Requests

#### Individual End User

{% tabs %}
{% tab title="cURL" %}
{% code overflow="wrap" lineNumbers="true" expandable="true" %}

```bash
#update individual end user
curl --location -- request PATCH 'https://api.sfox.com/v1/enterprise/users/{user_id}' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer ${ENTERPRISE_API_KEY}' \
--data-raw '{
    "source_of_funds": "employment",
    "intermediary_status": false,
    "expected_transfer_volume": "250000_to_999999",
    "expected_trade_volume": "250000_to_999999"
    }
}'
```

{% endcode %}
{% endtab %}
{% endtabs %}

#### Business End User

{% tabs %}
{% tab title="cURL" %}
{% code overflow="wrap" lineNumbers="true" expandable="true" %}

```bash
#update business end user
curl --location -- request PATCH 'https://api.sfox.com/v1/enterprise/users/{user_id}' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer ${ENTERPRISE_API_KEY}' \
--data-raw '{
"beneficial_owners": [
              {
            "id": "c76ed773-2166-11f1-97c3-0251c",
            "job_title": "Crypto Executive",
            "industry": "Consulting"
              }
            }'
```

{% endcode %}
{% endtab %}
{% endtabs %}

***

### Response

The response object shares the same schema as the [Get End User](https://docs.sfox.com/connect/rest-api/end-users/get-end-user#id-200-ok) endpoint, with the provided values now updated.