---
title: "Get unmasked client addresses"
method: GET
path: "/api/storage/profile-system/profiles/{profileId}/addresses/unmask"
tags: ["Addresses"]
---

# Get unmasked client addresses

`GET /api/storage/profile-system/profiles/{profileId}/addresses/unmask`

## Request

- Base URL: `https://apiexamples.vtexcommercestable.com.br`
- URL: `https://apiexamples.vtexcommercestable.com.br/api/storage/profile-system/profiles/{profileId}/addresses/unmask`
- Auth: one of:
  - API key in header `X-VTEX-API-AppKey` and API key in header `X-VTEX-API-AppToken`
  - API key in header `VtexIdclientAutCookie`

Retrieves unmasked information of all addresses of a given client, by its `profileId`.


Learn more about the [Profile System](https://developers.vtex.com/vtex-rest-api/docs/profile-system) and its other API endpoints.

>⚠️ The Profile System is only compatible with stores using the PII data architecture from [Data Protection Plus](https://developers.vtex.com/docs/guides/data-protection-plus), which is in closed beta phase, only available in select regions.
>
> This feature is part of [VTEX Shield](https://help.vtex.com/en/tutorial/vtex-shield--2CVk6H9eY2CBtHjtDI7BFh). If you are already a VTEX customer and want to adopt VTEX Shield for your business, please contact [Commercial Support](https://help.vtex.com/en/tracks/support-at-vtex--4AXsGdGHqExp9ZkiNq9eMy/3KQWGgkPOwbFTPfBxL7YwZ). Additional fees may apply. If you are not yet a customer but are interested in this solution, please complete our [contact form](https://vtex.com/us-en/contact/).

## Permissions

Any user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:

| **Product** | **Category** | **Resource** |
| --------------- | ----------------- | ----------------- |
| Profile System | Documents | **Get Item** |
| Profile System | Documents | **Save and Update Item** |
| Profile System | Documents | **Delete Item** |

There are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint.To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).

>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.

## Path parameters

- `profileId` string, required

## Query parameters

- `alternativeKey` 'email' | 'document'

## Headers

- `Content-Type` string, required
- `Accept` string, required

## Response `200`

OK

- UnmaskedAddressResponse[]
  - `id` string: ID of a client's address.
  - `document` Address: Address information.
    - `postalCode` string, required: Address postal code.
    - `countryName` string, required: Name of the address country.
    - `countryCode` string: Two letter country code.
    - `administrativeAreaLevel1` string, required: Name of administrative area, such as the state or province.
    - `locality` string, required: Name of address locality, such as the city.
    - `localityAreaLevel1` string, required: Name of the address locality area, such as the neighborhood or district.
    - `route` string, required: Address route or street name.
    - `streetNumber` string, required: Address street number.
    - `profileId` string, required: ID of the client's profile.
    - `contactId` string: Contact unique identifier.
  - `meta` AddressMeta: Address metadata.
    - `version` string, required: Unique identifier of the address version.
    - `author` string, required: Unique identifier of the user who created the address.
    - `creationDate` string, required: Date when the address was created in ISO 8601 format.
    - `lastUpdateDate` string, required: Date when the address was last updated in ISO 8601 format.

## Changes

- **2024-11-22** `e27de7bcbf60`: 1 breaking, 2 info
  - the `query` request parameter `alternativeKey` was restricted to a list of enum values
  - added the new enum value `document` to the `query` request parameter `alternativeKey`
  - added the new enum value `email` to the `query` request parameter `alternativeKey`
- **2023-11-21** `daeb92023d45`: 1 info
  - added the optional property `items/document/contactId` to the response with the `200` status
- **2023-10-20** `75d99bccaed6`: 1 breaking
  - the `items/document/profileId` response's property type changed from no type to `string` for status `200`
- **2023-10-18** `f18d811082f5`: 3 info
  - added the optional property `items/document` to the response with the `200` status
  - added the optional property `items/id` to the response with the `200` status
  - added the optional property `items/meta` to the response with the `200` status

[Operation history](https://skmtc.dev/vtex/apis/profile-system-pii-data-architecture/changes/api/storage/profile-system/profiles/:profileId/addresses/unmask/get.md)

---

[API](https://skmtc.dev/vtex/apis/profile-system-pii-data-architecture.md) - [All operations](https://skmtc.dev/vtex/apis/profile-system-pii-data-architecture/llms.txt) - [OpenAPI document](https://skmtc.dev/vtex/apis/profile-system-pii-data-architecture/revisions/23729fa2a727?raw)