Profile System - PII data architecture
The Profile System is only compatible with stores using the PII data architecture from Data Protection Plus, which is in closed beta phase, only available in select regions.
This feature is part of VTEX Shield. If you are already a VTEX customer and want to adopt VTEX Shield for your business, please contact Commercial Support. Additional fees may apply. If you are not yet a customer but are interested in this solution, please complete our contact form.
The Profile System is VTEX's single source of truth regarding shoppers' profile data for stores using the PII data architecture from Data Protection Plus. Other modules, such as Checkout and Order Management, can request data from the Profile System when necessary. Learn more at the Profile System guide.
Data stored in the Profile System is not related to documents saved in Master Data v1 or Master Data v2. The API endpoints and features described in this article only apply to documents registered in the new Profile System designed to handle PII data architecture.
Endpoints
Profiles
| Summary | Method | Path |
|---|---|---|
| Create client profile | POST | /api/storage/profile-system/profiles |
| Get profile | GET | /api/storage/profile-system/profiles/{profileId} |
| Update client profile | PATCH | /api/storage/profile-system/profiles/{profileId} |
| Delete client profile | DELETE | /api/storage/profile-system/profiles/{profileId} |
| Get unmasked profile | GET | /api/storage/profile-system/profiles/{profileId}/unmask |
| Get profile by version | GET | /api/storage/profile-system/profiles/{profileId}/versions/{profileVersionId} |
| Get unmasked profile by version | GET | /api/storage/profile-system/profiles/{profileId}/versions/{profileVersionId}/unmask |
Addresses
| Summary | Method | Path |
|---|---|---|
| Create client address | POST | /api/storage/profile-system/profiles/{profileId}/addresses |
| Get client addresses | GET | /api/storage/profile-system/profiles/{profileId}/addresses |
| Get unmasked client addresses | GET | /api/storage/profile-system/profiles/{profileId}/addresses/unmask |
| Get address | GET | /api/storage/profile-system/profiles/{profileId}/addresses/{addressId} |
| Update client address | PATCH | /api/storage/profile-system/profiles/{profileId}/addresses/{addressId} |
| Delete address | DELETE | /api/storage/profile-system/profiles/{profileId}/addresses/{addressId} |
| Get unmasked address | GET | /api/storage/profile-system/profiles/{profileId}/addresses/{addressId}/unmask |
| Get address by version | GET | /api/storage/profile-system/profiles/{profileId}/addresses/{addressId}/versions/{addressVersionId} |
| Get unmasked address by version | GET | /api/storage/profile-system/profiles/{profileId}/addresses/{addressId}/versions/{addressVersionId}/unmask |
Prospects
| Summary | Method | Path |
|---|---|---|
| Create prospect | POST | /api/storage/profile-system/prospects |
| Get prospects | GET | /api/storage/profile-system/prospects |
| Get unmasked prospects | GET | /api/storage/profile-system/prospects/unmask |
| Get prospect | GET | /api/storage/profile-system/prospects/{prospectId} |
| Update prospect | PATCH | /api/storage/profile-system/prospects/{prospectId} |
| Delete prospect | DELETE | /api/storage/profile-system/prospects/{prospectId} |
| Get unmasked prospect | GET | /api/storage/profile-system/prospects/{prospectId}/unmask |
Purchase information
| Summary | Method | Path |
|---|---|---|
| Create purchase information | POST | /api/storage/profile-system/profiles/{profileId}/purchase-info |
| Get purchase information | GET | /api/storage/profile-system/profiles/{profileId}/purchase-info |
| Update purchase information | PATCH | /api/storage/profile-system/profiles/{profileId}/purchase-info |
| Delete purchase information | DELETE | /api/storage/profile-system/profiles/{profileId}/purchase-info |
| Get unmasked purchase information | GET | /api/storage/profile-system/profiles/{profileId}/purchase-info/unmask |
Schemas
| Summary | Method | Path |
|---|---|---|
| Get full schema | GET | /api/storage/profile-system/schemas/profileSystem |
| Create or delete custom fields | PUT | /api/storage/profile-system/schemas/profileSystem/custom |
| Get custom fields | GET | /api/storage/profile-system/schemas/profileSystem/custom |