---
name: profile-system-pii-data-architecture
description: "Profile System - PII data architecture API skill. Use when working with Profile System - PII data architecture for api. Covers 31 endpoints."
version: 1.0.0
generator: lapsh
---

# Profile System - PII data architecture
API version: 1.0

## Auth
ApiKey X-VTEX-API-AppKey in header | ApiKey X-VTEX-API-AppToken in header | ApiKey VtexIdclientAutCookie in header

## Base URL
https://apiexamples.vtexcommercestable.com.br

## Setup
1. Set your API key in the appropriate header
2. GET /api/storage/profile-system/prospects -- verify access
3. POST /api/storage/profile-system/profiles -- create first profiles

## Endpoints

31 endpoints across 1 groups. See references/api-spec.lap for full details.

### api
| Method | Path | Description |
|--------|------|-------------|
| POST | /api/storage/profile-system/profiles | Create client profile |
| GET | /api/storage/profile-system/profiles/{profileId} | Get profile |
| PATCH | /api/storage/profile-system/profiles/{profileId} | Update client profile |
| DELETE | /api/storage/profile-system/profiles/{profileId} | Delete client profile |
| GET | /api/storage/profile-system/profiles/{profileId}/unmask | Get unmasked profile |
| GET | /api/storage/profile-system/profiles/{profileId}/versions/{profileVersionId} | Get profile by version |
| GET | /api/storage/profile-system/profiles/{profileId}/versions/{profileVersionId}/unmask | Get unmasked profile by version |
| POST | /api/storage/profile-system/profiles/{profileId}/addresses | Create client address |
| GET | /api/storage/profile-system/profiles/{profileId}/addresses | Get client addresses |
| GET | /api/storage/profile-system/profiles/{profileId}/addresses/unmask | Get unmasked client addresses |
| GET | /api/storage/profile-system/profiles/{profileId}/addresses/{addressId} | Get address |
| PATCH | /api/storage/profile-system/profiles/{profileId}/addresses/{addressId} | Update client address |
| DELETE | /api/storage/profile-system/profiles/{profileId}/addresses/{addressId} | Delete address |
| GET | /api/storage/profile-system/profiles/{profileId}/addresses/{addressId}/unmask | Get unmasked address |
| GET | /api/storage/profile-system/profiles/{profileId}/addresses/{addressId}/versions/{addressVersionId} | Get address by version |
| GET | /api/storage/profile-system/profiles/{profileId}/addresses/{addressId}/versions/{addressVersionId}/unmask | Get unmasked address by version |
| POST | /api/storage/profile-system/prospects | Create prospect |
| GET | /api/storage/profile-system/prospects | Get prospects |
| GET | /api/storage/profile-system/prospects/unmask | Get unmasked prospects |
| GET | /api/storage/profile-system/prospects/{prospectId} | Get prospect |
| PATCH | /api/storage/profile-system/prospects/{prospectId} | Update prospect |
| DELETE | /api/storage/profile-system/prospects/{prospectId} | Delete prospect |
| GET | /api/storage/profile-system/prospects/{prospectId}/unmask | Get unmasked prospect |
| POST | /api/storage/profile-system/profiles/{profileId}/purchase-info | Create purchase information |
| GET | /api/storage/profile-system/profiles/{profileId}/purchase-info | Get purchase information |
| PATCH | /api/storage/profile-system/profiles/{profileId}/purchase-info | Update purchase information |
| DELETE | /api/storage/profile-system/profiles/{profileId}/purchase-info | Delete purchase information |
| GET | /api/storage/profile-system/profiles/{profileId}/purchase-info/unmask | Get unmasked purchase information |
| GET | /api/storage/profile-system/schemas/profileSystem | Get full schema |
| PUT | /api/storage/profile-system/schemas/profileSystem/custom | Create or delete custom fields |
| GET | /api/storage/profile-system/schemas/profileSystem/custom | Get custom fields |

## Common Questions

Match user requests to endpoints in references/api-spec.lap. Key patterns:
- "Create a profile?" -> POST /api/storage/profile-system/profiles
- "Get profile details?" -> GET /api/storage/profile-system/profiles/{profileId}
- "Partially update a profile?" -> PATCH /api/storage/profile-system/profiles/{profileId}
- "Delete a profile?" -> DELETE /api/storage/profile-system/profiles/{profileId}
- "List all unmask?" -> GET /api/storage/profile-system/profiles/{profileId}/unmask
- "Get version details?" -> GET /api/storage/profile-system/profiles/{profileId}/versions/{profileVersionId}
- "List all unmask?" -> GET /api/storage/profile-system/profiles/{profileId}/versions/{profileVersionId}/unmask
- "Create a address?" -> POST /api/storage/profile-system/profiles/{profileId}/addresses
- "List all addresses?" -> GET /api/storage/profile-system/profiles/{profileId}/addresses
- "List all unmask?" -> GET /api/storage/profile-system/profiles/{profileId}/addresses/unmask
- "Get address details?" -> GET /api/storage/profile-system/profiles/{profileId}/addresses/{addressId}
- "Partially update a address?" -> PATCH /api/storage/profile-system/profiles/{profileId}/addresses/{addressId}
- "Delete a address?" -> DELETE /api/storage/profile-system/profiles/{profileId}/addresses/{addressId}
- "List all unmask?" -> GET /api/storage/profile-system/profiles/{profileId}/addresses/{addressId}/unmask
- "Get version details?" -> GET /api/storage/profile-system/profiles/{profileId}/addresses/{addressId}/versions/{addressVersionId}
- "List all unmask?" -> GET /api/storage/profile-system/profiles/{profileId}/addresses/{addressId}/versions/{addressVersionId}/unmask
- "Create a prospect?" -> POST /api/storage/profile-system/prospects
- "List all prospects?" -> GET /api/storage/profile-system/prospects
- "List all unmask?" -> GET /api/storage/profile-system/prospects/unmask
- "Get prospect details?" -> GET /api/storage/profile-system/prospects/{prospectId}
- "Partially update a prospect?" -> PATCH /api/storage/profile-system/prospects/{prospectId}
- "Delete a prospect?" -> DELETE /api/storage/profile-system/prospects/{prospectId}
- "List all unmask?" -> GET /api/storage/profile-system/prospects/{prospectId}/unmask
- "Create a purchase-info?" -> POST /api/storage/profile-system/profiles/{profileId}/purchase-info
- "List all purchase-info?" -> GET /api/storage/profile-system/profiles/{profileId}/purchase-info
- "List all unmask?" -> GET /api/storage/profile-system/profiles/{profileId}/purchase-info/unmask
- "List all profileSystem?" -> GET /api/storage/profile-system/schemas/profileSystem
- "List all custom?" -> GET /api/storage/profile-system/schemas/profileSystem/custom
- "How to authenticate?" -> See Auth section

## Response Tips
- Check response schemas in references/api-spec.lap for field details
- Create/update endpoints typically return the created/updated object

## CLI

```bash
# Update this spec to the latest version
npx @lap-platform/lapsh get profile-system-pii-data-architecture -o references/api-spec.lap

# Search for related APIs
npx @lap-platform/lapsh search profile-system-pii-data-architecture
```

## References
- Full spec: See references/api-spec.lap for complete endpoint details, parameter tables, and response schemas

> Generated from the official API spec by [LAP](https://lap.sh)