> For the complete documentation index, see [llms.txt](https://paas.docs.machnetinc.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://paas.docs.machnetinc.com/api-references/user/update-a-receive-user.md).

# Update a Receive User

This API allows you to update the receive user information. Receive user details can only be updated if no transactions have been forwarded for delivery for the user. Hence, a receive user can only be updated when Delivery Status is NONE and in some cases, DELIVERY HOLD. 

#### `PATCH /users/{{receive_user_id}}`

{% tabs %}
{% tab title="Individual" %}

| **Fields**                  | **Updatable** | **Additional Details**                                                                            |
| --------------------------- | ------------- | ------------------------------------------------------------------------------------------------- |
| first\_name                 | Yes           |                                                                                                   |
| middle\_name                | Yes           |                                                                                                   |
| last\_number                | Yes           |                                                                                                   |
| gender                      | No            | Can only be updated if not provided earlier                                                       |
| mobile\_phone               | Yes           |                                                                                                   |
| date\_of*\_*birth | Yes           |                                                                                                   |
| email                       | Yes           |                                                                                                   |
| occupation                  | No            | Can only be updated if not provided earlier                                                       |
| user\_relationship          | No            | Can only be updated if not provided earlier                                                       |
| address\_line1              | Yes           |                                                                                                   |
| address\_line2              | Yes           |                                                                                                   |
| city                        | Yes           |                                                                                                   |
| state                       | Yes           |                                                                                                   |
| country                     | No            |                                                                                                   |
| zipcode                     | Yes           |                                                                                                   |
| physical\_documents         | Yes           | Updating physical\_document object will add a new copy of the document and archive the older one. |
| virtual\_documents          | Yes           |                                                                                                   |
| {% endtab %}                |               |                                                                                                   |

{% tab title="Business" %}

| **Fields**          | **Updatable** | **Remarks** |
| ------------------- | ------------- | ----------- |
| first\_name         | Yes           |             |
| mobile\_number      | Yes           |             |
| virtual\_documents  | No            |             |
| physical\_documents | Yes           |             |
| address\_line1      | Yes           |             |
| address\_line2      | Yes           |             |
| state               | Yes           |             |
| city                | Yes           |             |
| zipcode             | Yes           |             |
| country             | No            |             |
| {% endtab %}        |               |             |

{% tab title="Request Sample" %}

```
curl --location -g --request PATCH '{{url}}/users/{{receive_user_id}}' \
--header 'X-Client-Id: {{client_id}}' \
--header 'X-Client-Secret: {{client_secret}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "first_name": "raman",
    "last_name": "machnett",
    "email": "pd.p@gmail.com",
    "date_of_birth": "2000-01-02",
    "mobile_phone": "237653801975",
     "send_user_id":"3cf826ea-1d0c-46a8-a93e-4c8dc9cfbf80",
     "physical_documents": [
        {
            "document_value": "data:image/jpg;base64,SUQsasasasas909090==",
            "document_value_back": "data:image/jpg;base64,SUQsasasasas909090==",
            "document_type": "OTHER",
             "custom_document_type": "citizenship",
            "country": "US",
            "state": "Ak"
        }
    ],
    "virtual_documents": [
        {
            "document_value": "111111112",
            "document_type": "OTHER",
             "custom_document_type": "citizenship",
            "expiry_date": "2025-03-10",
            "id_issuing_authority": "MN",
            "country": "US",
            "state": "Ak"
        }
    ]
}'
```

{% endtab %}

{% tab title="Response" %}

```
{
    "address_line2": "500 8 El Camino Real Santa Clara",
    "city": "Santa Clara",
    "country": "GH",
    "created_at": "2022-09-30T04:46:59.167529",
    "date_of_birth": "2000-01-02",
    "email": "pd.p@gmail.com",
    "first_name": "raman",
    "gender": "female",
    "id": "3cf826ea-1d0c-46a8-a93e-4c8dc9cfbf80",
    "ip_address": "10.0.0.1",
    "last_name": "machnett",
    "mobile_phone": "237653801975",
    "occupation": "QA",
    "physical_documents": [
        {
            "country": "US",
            "custom_document_type": "citizenship",
            "document_type": "OTHER",
            "id": "1731c62b-a95e-4a59-94e1-cfbe5c95978a",
            "state": "Ak"
        }
    ],
    "status": "UNVERIFIED",
    "user_relationship": "SISTER",
    "virtual_documents": [
        {
            "country": "US",
            "custom_document_type": "citizenship",
            "document_type": "OTHER",
            "document_value": "111111112",
            "id": "f937c333-e76d-4fd2-b02c-01a013857ea3",
            "state": "Ak",
            "expiry_date": "2025-03-10",
            "id_issuing_authority": "MN"
        }
    ],
    "zipcode": "23775-9K"
}
```

{% endtab %}
{% endtabs %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://paas.docs.machnetinc.com/api-references/user/update-a-receive-user.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.