Update Address
PATCH{baseUrl}/us/api/v1/kyc/addresses
Payload
All fields are optional except userId and type (partial update).
| Attribute | Type | Required | Description |
|---|---|---|---|
| userId | Integer | Yes | Target user ID. |
| type | Enum | Yes | MAILING | RESIDENTIAL | BUSINESS | … |
| countryId | Integer | No | Internal country ID. |
| countryCode | String | No | ISO Alpha-3 code. |
| stateId | Integer | No | Internal state/province ID. |
| stateName | String | No | State/province name. |
| cityId | Integer | No | Internal city ID. |
| cityName | String | No | City name. |
| addressLine1 | String | No | — |
| addressLine2 | String | No | — |
| postalCode | String | No | — |
| longitude | String | No | — |
| latitude | String | No | — |
Request Example
{
"userId": 604,
"type": "MAILING",
"countryId": 1,
"countryCode": "IND",
"stateId": 3871,
"stateName": "California",
"cityId": 72,
"cityName": "Los Angeles",
"addressLine1": "123 Main Street 123445",
"addressLine2": "Apt 4B",
"postalCode": "6019",
"longitude": "-118.2437",
"latitude": "34.0522",
"status": true
}Response
| Field | Type | Description |
|---|---|---|
| id | Integer | Address record ID. |
| userId | Integer | Owner user ID. |
| type | Enum | Address type. |
| country | Object | { id, name }. |
| countryCode | String | ISO Alpha-3. |
| state | Object | { id, name }. |
| stateName | String | State/province name. |
| city | Object | { id, name }. |
| cityName | String | City name. |
| addressLine1 | String | — |
| addressLine2 | String | — |
| postalCode | String | — |
| longitude | String | — |
| latitude | String | — |
| status | Boolean | Active (true) or inactive (false). |
200 — SUCCESS
{
"data": {
"id": 11,
"userId": 604,
"type": "MAILING",
"country": { "id": 1, "name": "Afghanistan" },
"countryCode": "AFG",
"state": { "id": 3871, "name": "Badghis" },
"stateName": "Badghis",
"city": { "id": 72, "name": "Ghormach" },
"cityName": "Ghormach",
"addressLine1": "123 Main Street 123445",
"addressLine2": "Apt 4B",
"postalCode": "6019",
"longitude": "-118.2437",
"latitude": "34.0522",
"status": false
}
}