| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Overview
Use this method to update an existing company address on a company applicant.
Only the fields supplied in the request body are changed — omitted fields keep their current values. The method returns the applicant's updated profile.
Required permissions
To use this method, your app token must have the Change applicant's personal data permission.
Use case
Use this method to correct or refresh a single company address — for example, updating the postCode after a verified move, or attaching a new imageId once a fresh proof-of-address document has been uploaded — without having to resend the whole address object.
Notes
- This is a partial update: fields you do not include in the body are left untouched.
companyAddressIdis theidreturned for this address by Add company address (or read back via the applicant profile) — not theimageIdor any other identifier.- To replace
address, send the fulladdressobject — individual sub-fields ofaddress
cannot be updated independently.
Request example
curl -X PATCH
'https://api.sumsub.com/resources/applicants/5f649369aee05c75ea500000/fixedInfo/companyAddresses/9d759173-b4a4-4e9f-b168-07e29de1a2op' \
-H 'X-App-Token: <your-app-token>' \
-H 'X-App-Access-Sig: <your-signature>' \
-H 'X-App-Access-Ts: <unix-timestamp>' \
-H 'Content-Type: application/json' \
-d '{
"address": {
"street": "Piilipuuntie 3 E 85",
"town": "Espoo",
"postCode": "02251",
"stateCode": "FI-18",
"country": "FIN",
"formattedAddress": "Piilipuuntie 3 E 85, Espoo, Finland, 02251"
},
"addressTypes": [
"trade"
],
"main": true,
"imageId": 123456789
}'Response explained
The response is a JSON object that represents the applicant data with the updated company
address list.
The fields specifically updated by this method are documented below.
companyAddresses[] element fields
companyAddresses[] element fields| Field | Type | Description |
|---|---|---|
id | String | Address identifier. Generated by the service when the address is created. |
addressTypes | Array of strings | Address types assigned to this address. Possible values:
|
address | Object | Structured company address. See address attributes below. |
main | Boolean | Indicates whether this address is the main one within its address type. |
imageId | Integer | Identifier of an uploaded proof-of-address image, if one was attached. |
companyAddresses[].address attributes
companyAddresses[].address attributes| Field | Type | Description |
|---|---|---|
street | String | Street and building. |
town | String | Town or city. |
postCode | String | Postal code. |
stateCode | String | State code based on the address, in the ISO 3166-2 format (for example, TR-34, AD-07). |
country | String | 3-letter ISO 3166-1 alpha-3 country code (for example, FIN). |
formattedAddress | String | Full address as a single string. |
Response examples
If the request is processed successfully, you will get an object representing the applicant profile with the updated fields shown in the example below:
{
...
{
"companyAddresses": [
{
"id": "9d759173-b4a4-4e9f-b168-07e29de1a2bd",
"addressTypes": [
"trade"
],
"main": true,
"address": {
"street": "Piilipuuntie 3 E 85",
"town": "Espoo",
"postCode": "02250",
"stateCode": "FI-18",
"country": "FIN",
"formattedAddress": "Piilipuuntie 3 E 85, Espoo, Finland, 02250"
}
}
]
}
...
}If the request fails, you will receive an HTTP response containing an error code along with a
message explaining the error. For example:
{
"description": "Company address 9d759173-b4a4-4e9f-b168-07e29de1a2bd not found",
"code": 404,
"correlationId": "b628a7fbdf4fa487b26406e79e76f3f7"
}Response codes
| Status | Description |
|---|---|
200 | Address updated; returns the updated applicant profile — see Response examples. |
400 | Invalid request — for example, a malformed country/stateCode, or an unrecognized addressTypes value. |
404 | No company address with the given companyAddressId exists on this applicant. |