Vtex Profile System - PII data architecture
Browse all Vtex APIsCRMContact ManagementapiKey31 EndpointsREST
For Agents
Programmatically create client profile, get profile. Covers 31 operations with apiKey authentication.
Use for: I need to client profile, I want to profile, Search for client profile, Find all client profile
Not supported: Does not handle payments, communications, or developer tools - use for crm only.
>⚠️ 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 . The API exposes 31 endpoints secured with apiKey authentication.
Install Jentic One Beta
Connect the Profile System - PII data architecture to your agent
Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the Profile System - PII data architecture, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.
Two steps, two machines. Install the instance in a safe environment, then register your agent from wherever it runs.
1
Step 1: Jentic One Host machine
# On the machine that will host your Jentic One instance:
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Fvtex.local%2Fprofile-system---pii-data-architecture" | sh2
Step 2: Agent machine
# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Fvtex.local%2Fprofile-system---pii-data-architecture" | sh
jentic register # connects your agent to your Jentic One instanceJentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.
Capabilities
What an agent can do with Profile System - PII data architecture API.
Create client profile
Get profile
Update client profile
Delete client profile
Monitor Profile System - PII data architecture operational status and events
Use Cases
Patterns agents use Profile System - PII data architecture API for, with concrete tasks.
★ CRM Operations
Use the Profile System - PII data architecture to perform crm operations programmatically. The API provides 31 endpoints covering core functionality including create client profile, get profile, update client profile.
Call POST /api/storage/profile-system/profiles to create client profile
Automated Profiles Management
Automate profiles operations by combining multiple Profile System - PII data architecture endpoints. Agents can get profile and then update client profile in a single workflow.
Call GET /api/storage/profile-system/profiles/{profileId} to get profile, then verify the result
AI Agent Integration via Jentic
AI agents discover and call Profile System - PII data architecture endpoints through Jentic without managing credentials directly. An agent searches for the required operation by intent, receives the matching endpoint schema, and executes the call with Jentic-managed authentication. This eliminates the need to read API documentation or handle apiKey tokens manually.
Search Jentic for 'create client profile', load the operation schema, and execute with Jentic-managed credentials
Key Endpoints
31 endpoints — >⚠️ the profile system is only compatible with stores using the pii data architecture from [data protection plus](https://developers.
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
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
Why Jentic?
What agents get from Jentic-routed access to this vendor.
Setup
Wiring the VTEX Profile System by hand means pairing an App Key with an App Token in the X-VTEX-API-AppKey and X-VTEX-API-AppToken headers, and templating the {accountName} and {environment} host into every call. Through Jentic you install once, import the Profile System from the API Directory, store the App Key and App Token once, and your agent calls it.
Permission scoping
The Profile System puts the profile id in the URL path (/api/storage/profile-system/profiles/{profileId}), so a rule can pin your agent to one profile and its addresses and versions. You choose the operations it may call, so sensitive ones like unmasking PII or deleting a profile are not included unless you add them.
Credential isolation
Your VTEX App Key and App Token are stored once, encrypted, by your own Jentic One instance and injected at execution time. They never enter the agent's prompt, logs, or context.
Intent-based discovery
Agents search Jentic by intent such as 'create a client profile' or 'get a profile's addresses', and Jentic returns the matching Profile System operation with its input schema so the agent calls the right endpoint without browsing the reference docs.
Related APIs
Alternatives and complements available in the Jentic catalogue.
FAQs
Specific to using Profile System - PII data architecture API through Jentic.
What authentication does the Profile System - PII data architecture use?
The Profile System - PII data architecture uses an API key passed in the `X-VTEX-API-AppKey` header. Through Jentic, these credentials are stored encrypted in your Jentic One instance and injected at execution time, so raw secrets never enter the agent context.
Can I create client profile with the Profile System - PII data architecture?
Yes. Use the POST /api/storage/profile-system/profiles endpoint. The API returns structured JSON responses that agents can parse and act on directly.
What are the rate limits for the Profile System - PII data architecture?
Rate limits are not specified in the OpenAPI spec. Check the vendor documentation for current limits. Through Jentic, rate limiting is handled automatically with retry logic built into the execution layer.
How do I create client profile through Jentic?
Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'create client profile'. Jentic returns the matching Profile System - PII data architecture operation with its input schema. Load the schema and execute the call - credentials are injected automatically.
How many endpoints does the Profile System - PII data architecture have?
The Profile System - PII data architecture exposes 31 endpoints covering profiles, addresses, prospects operations.
Can I limit what my agent is allowed to do with the VTEX Profile System API?
Yes. Because Jentic One is self-hosted, your own rules decide which Profile System operations and credentials the agent may use. Since the profile id sits in the URL path, you can pin the agent to a single profile and its addresses and versions, and you choose exactly which operations it may call. Sensitive calls like unmasking PII or deleting a profile stay off the list unless you explicitly add them.
GET STARTED