| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Overview
Use this method to add a company address to a company applicant.
Each applicant can hold several addresses, distinguished by their addressTypes (for example, a trade point address and a legal registration address). 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 when a company applicant needs more than one verified address on file — for
example, a legal registration address for KYB checks and a separate trade point address for
site verification.
Notes
- Omit
idwhen creating a new address — the service generates a UUID for it and returns it
in the response.addressTypesaccepts up to 6 values:trade,legal, orpostal.- Set
mainto mark this address as the primary one within its address type.
Request example
curl -X POST 'https://api.sumsub.com/resources/applicants/5f649369aee05c75ea500000/fixedInfo/companyAddresses' \
-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 '{
"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"
}
}'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": "Invalid country code",
"code": 400,
"correlationId": "b628a7fbdf4fa487b26406e79e76f3f7"
}Response codes
| Status | Description |
|---|---|
200 | Address added; returns the updated applicant profile — see Response examples. |
400 | Invalid request — for example, a malformed country/stateCode, or an unrecognized addressTypes value. |