# User Update-Request
```
STAGING_URL: https://switch-api-staging.herokuapp.com
LIVE_URL: https://switchapi.azurewebsites.net
```
## Create Update-Request
`POST` `https://switch-api-staging.herokuapp.com/user/update_requests/:user_attribute`
This endpoint allows the user to request for an update on his/her profile or BVN.
#### Path Parameters
| Name | Type | Description |
| --------------- | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| user\_attribute | string | The attribute being updated.
Could be any of the following: name, email, address, phone or date\_of\_birth
|
#### Headers
| Name | Type | Description |
| ----------- | ------ | ---------------------------------------------------------- |
| auth\_token | string | Format for ***auth\_token*** is ***Bearer token\_string*** |
#### Request Body
| Name | Type | Description |
| --------------------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| zipcode | string | The user's zipcode.
Required when user\_attribute is address
|
| bvn\_change | boolean | Determines whether the changes should be made on the user's BVN. Defaults to ***true*** |
| city | string | The user's city of residence.
Required when user\_attribute is address
|
| state | string | The user's state of residence.
Required when user\_attribute is address
|
| reason | string | Only required when ***user\_attribute*** is ***name***. Could be either ***marriage, spelling\_error*** or ***total\_name\_change***. |
| first\_name | string | The new first name.
Required when user\_attribute is name
|
| last\_name | string | The new last name.
Required when user\_attribute is name
|
| email | string | The new email.
Required when user\_attribute is email
|
| address | string | The new street address.
Required when user\_attribute is address
|
| phone | string | The new phone number.
Required when user\_attribute is phone
|
| date\_of\_birth | string | The correct date of birth.
Required when user\_attribute is date\_of\_birth
|
| switch\_change | boolean | Determines whether the changes should be made on the Switch app. Defaults to ***false*** |
| marriage\_certificate\_url | string | The url of the image containing the marriage certificate.
Required when user\_attribute is name and reason is marriage
|
| affidavit\_url | string | The url of the image containing the affidavit.
Required when
- user\_attribute is name and reason is marriage
- user\_attribute is name and reason is total\_name\_change
- user\_attribute is date\_of\_birth
|
| newspaper\_publication\_url | string | The url of the image containing the newspaper publication.
Required when user\_attribute is name and reason is
- marriage
- total\_name\_change
|
| photo\_id\_url | string | The url of the image containing the photo id.
Required when
- user\_attribute is name
- user\_attribute is date\_of\_birth
|
| photo\_id\_issuer | string | The photo id issuer (valid values: ***drivers\_license***, ***voters\_card***, ***international\_passport*** and ***national\_id\_card***) |
| photo\_id\_number | string | The number of the photo id |
| photo\_id\_expiry | string | The expiry date of the photo id |
| utility\_bill\_url | string | The url of the image containing the utility bill.
Required when user\_attribute is address
|
| birth\_certificate\_url | string | The url of the image containing the birth certificate.
Required when user\_attribute is date\_of\_birth
|
{% tabs %}
{% tab title="200 " %}
```
{
"message": "Your update-request has been received and will be processed within the next 7 working days."
}
```
{% endtab %}
{% tab title="400 " %}
```
{
"message": "user's signature not yet verified'"
}
```
{% endtab %}
{% endtabs %}
## Get user's update-requests
`GET` `https://switch-api-staging.herokuapp.com/user/update_requests`
Retrieves all the user's update-requests
#### Headers
| Name | Type | Description |
| ----------- | ------ | ---------------------------------------------------------- |
| auth\_token | string | Format for ***auth\_token*** is ***Bearer token\_string*** |
{% tabs %}
{% tab title="200 " %}
```
{
"message": "User update-requests retrieved successfully",
"data": [
{
"id": 32,
"old_value": {
"first_name": "Tayo",
"last_name": "Tade"
},
"new_value": {
"first_name": "Ayo",
"last_name": "Ade"
},
"user_attribute": "name",
"reason": "total_name_change",
"switch_change": false,
"bvn_change": true,
"status": "pending",
"created_at": "2019-05-10T11:26:02.500Z"
},
{
"id": 33,
"old_value": {
"email": "tayo@gmail.com"
},
"new_value": {
"email": "someone@email.com"
},
"user_attribute": "email",
"reason": "spelling_error",
"switch_change": false,
"bvn_change": true,
"status": "pending",
"created_at": "2019-05-10T11:26:58.032Z"
},
{
"id": 34,
"old_value": {
"phone": "+2348184292899"
},
"new_value": {
"phone": "+2348023193506"
},
"user_attribute": "phone",
"reason": "spelling_error",
"switch_change": false,
"bvn_change": true,
"status": "pending",
"created_at": "2019-05-10T11:27:37.279Z"
},
{
"id": 35,
"old_value": {
"date_of_birth": "1991-11-10"
},
"new_value": {
"date_of_birth": "1990-11-10"
},
"user_attribute": "date_of_birth",
"reason": "spelling_error",
"switch_change": false,
"bvn_change": true,
"status": "pending",
"created_at": "2019-05-10T11:29:29.290Z"
},
{
"id": 36,
"old_value": {
"address": "some street",
"city": "some city",
"state": "some state",
"zipcode": "something"
},
"new_value": {
"address": "street",
"city": "city",
"state": "state",
"zipcode": "zipcode"
},
"user_attribute": "address",
"reason": "spelling_error",
"switch_change": false,
"bvn_change": true,
"status": "pending",
"created_at": "2019-05-10T11:38:01.146Z"
}
]
}
```
{% endtab %}
{% endtabs %}
---
# Agent Instructions: 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:
```
GET https://switchng.gitbook.io/switch/user-update-request.md?ask=
```
The question should be specific, self-contained, and written in natural language.
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.