VTEX Prospects API

openapi: 3.0.0
info:
  title: VTex Anti-fraud Provider Account Prospects API
  description: ">ℹ️ Onboarding guide\r\n>\r\n> Check the new [Payments onboarding guide](https://developers.vtex.com/docs/guides/payments-overview). We created this guide to improve the onboarding experience for developers at VTEX. It assembles all documentation on our Developer Portal about Payments and is organized by focusing on the developer's journey.\r\n\r\nThe Anti-fraud Provider Protocol is a set of definitions to help you integrate your anti-fraud service API into VTEX platform.\r\n\r\nTo achieve this, you need to implement a web API (REST) following the specifications described in this documentation.\r\n\r\n>⚠️ You can also access our [template on GitHub](https://github.com/vtex-apps/antifraud-provider-example) to help you quickly develop your anti-fraud connector using the Anti-fraud Provider Protocol and VTEX IO.\r\n\r\nTo learn more about the Anti-fraud Provider Protocol, check our [developer guide](https://developers.vtex.com/docs/guides/how-the-integration-protocol-between-vtex-and-antifraud-companies-works).\r\n\r\n## Anti-fraud Provider API Index\r\n\r\n### Anti-fraud  Flow\r\n\r\n- `POST` [Send Anti-fraud Pre-Analysis Data (optional)](https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol#post-/pre-analysis)\r\n- `POST` [Send Anti-fraud Data](https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol#post-/transactions)\r\n- `PUT` [Update Anti-fraud Transactions (optional)](https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol#put-/transactions/-transactionId-)\r\n- `GET` [List Anti-fraud Provider Manifest](https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol#get-/manifest)\r\n- `GET` [Get Anti-fraud Status](https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol#get-/transactions/-transactions.id-)\r\n- `DELETE` [Stop Anti-fraud Analysis (optional)](https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol#delete-/transactions/-transactions.Id-)\r\n\r\n### OAuth Flow\r\n\r\n1. `POST` [Retrieve Token](https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol#post-/authorization/token)\r\n2. `GET` [Redirect](https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol#get-/redirect)\r\n3. `GET` [Return to VTEX](https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol#get-/authorizationCode)\r\n4. `GET` [Get Credentials](https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol#get-/authorization/credentials)"
  version: '1.0'
servers:
- url: https://{providerApiEndpoint}
  description: Anti-fraud provider endpoint URL.
  variables:
    providerApiEndpoint:
      description: Anti-fraud provider endpoint URL.
      default: '{providerApiEndpoint}'
tags:
- name: Prospects
paths:
  /api/storage/profile-system/prospects:
    post:
      tags:
      - Prospects
      summary: VTex Create prospect
      description: "Creates new prospect.\n\r\n\r> The `id` field returned by this request is the `prospectId` used to retrieve information on a specific prospect later.\n\r\n\rLearn more about the [Profile System](https://developers.vtex.com/vtex-rest-api/docs/profile-system) and its other API endpoints.\r\n\r\n>⚠️ 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.\r\n>\r\n> 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/).\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-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:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Profile System | Documents | **Get Item** |\r\n| Profile System | Documents | **Save and Update Item** |\r\n| Profile System | Documents | **Delete Item** |\r\n\r\nThere 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).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing app keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations."
      operationId: CreateProspect
      parameters:
      - $ref: '#/components/parameters/Content-Type'
      - $ref: '#/components/parameters/Accept'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Prospect'
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnmaskedProspectResponse'
              example:
                id: 98478f6b-d025-4f35-a560-dd1ee7a6f26e
                document:
                  availableAddresses:
                  - disposable: true
                    userId: 98478f6b-d025-4f35-a560-dd1ee7a6f26e
                    addressName: customerAddressId
                    addressType: residential
                    postalCode: '32137'
                    city: Palm Coast
                    country: USA
                    street: Fifth St.
                    number: '9538'
                    complement: ''
                    receiverName: Jane Doe
                    geoCoordinate: []
                  paymentData:
                    availableAccounts: []
                    availableTokens: []
                    transactions: null
                    giftCards: []
                    giftCardMessages: []
                    numberOfPaymentErrors: 0
                    numberOfDeniedTransactions: 0
                    lastDeniedTransaction: null
                  contacts:
                  - contactId: '0'
                    email: ''
                    firstName: Jane
                    lastName: Doe
                    phone: ''
                    document: ''
                    documentType: ''
                  invoiceSubject:
                    invoiceSubjectId: '0'
                    email: jane@mail.com
                    firstName: Jane
                    lastName: Doe
                    phone: '12345678910'
                  email: jane@mail.com
                  firstName: Jane
                  lastName: Doe
                  document: 5397eefef23741d4976ebdf772cc42e0
                  cellPhone: '12345678910'
                  isPJ: false
                  customerCode: 5397eefe-f237-41d4-976e-bdf772cc42e0
                meta:
                  version: af9117e9-4169-46ee-ab4b-d4b17b881488
                  author: d6d8269f-e7cc-4e4b-8b89-3b46a1407937
                  creationDate: '2023-10-25T13:59:52.7633627+00:00'
                  lastUpdateDate: '2023-10-25T14:02:45.7277154+00:00'
                  expirationDate: null
      deprecated: false
    get:
      tags:
      - Prospects
      summary: VTex Get prospects
      description: "Retrieves information of all prospects.\n\r\n\r> For security and privacy reasons, this request returns masked prospect data. For unmasked information, see [Get unmasked prospects](https://developers.vtex.com/docs/api-reference/profile-system#get-/api/storage/profile-system/prospects/unmask).\n\r\n\rLearn more about the [Profile System](https://developers.vtex.com/vtex-rest-api/docs/profile-system) and its other API endpoints.\r\n\r\n>⚠️ 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.\r\n>\r\n> 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/). \r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-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:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Profile System | Documents | **Get Item** |\r\n| Profile System | Documents | **Save and Update Item** |\r\n| Profile System | Documents | **Delete Item** |\r\n\r\nThere 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).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing app keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations."
      operationId: GetProspects
      parameters:
      - $ref: '#/components/parameters/Content-Type'
      - $ref: '#/components/parameters/Accept'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                description: List of masked prospects.
                items:
                  $ref: '#/components/schemas/MaskedProspectResponse'
              example:
              - id: 98478f6b-d025-4f35-a560-dd1ee7a6f26e
                document:
                  availableAddresses:
                  - disposable: true
                    userId: 98478f6b-d025-4f35-a560-dd1ee7a6f26e
                    addressName: customerAddressId
                    addressType: residential
                    postalCode: 3*****
                    city: P*****
                    country: USA
                    street: F*****
                    number: 9****
                    complement: ''
                    receiverName: J*** D**
                    geoCoordinate: []
                  paymentData:
                    availableAccounts: []
                    availableTokens: []
                    transactions: null
                    giftCards: []
                    giftCardMessages: []
                    numberOfPaymentErrors: 0
                    numberOfDeniedTransactions: 0
                    lastDeniedTransaction: null
                  contacts:
                  - contactId: '0'
                    email: ''
                    firstName: J***
                    lastName: D**
                    phone: ''
                    document: ''
                    documentType: ''
                  invoiceSubject:
                    invoiceSubjectId: '0'
                    email: j***@m***.c**
                    firstName: J***
                    lastName: D**
                    phone: 1**********
                  email: j***@m***.c**
                  firstName: J***
                  lastName: D**
                  document: 1**********
                  cellPhone: 1**********
                  isPJ: false
                  customerCode: 5397eefe-f237-41d4-976e-bdf772cc42e0
                meta:
                  version: af9117e9-4169-46ee-ab4b-d4b17b881488
                  author: d6d8269f-e7cc-4e4b-8b89-3b46a1407937
                  creationDate: '2023-10-25T13:59:52.7633627+00:00'
                  lastUpdateDate: '2023-10-25T14:02:45.7277154+00:00'
                  expirationDate: null
      deprecated: false
  /api/storage/profile-system/prospects/unmask:
    get:
      tags:
      - Prospects
      summary: VTex Get unmasked prospects
      description: "Retrieves unmasked information of all prospects.\n\r\n\rLearn more about the [Profile System](https://developers.vtex.com/vtex-rest-api/docs/profile-system) and its other API endpoints.\r\n\r\n>⚠️ 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.\r\n>\r\n> 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/). \r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-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:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Profile System | Documents | **Get Item** |\r\n| Profile System | Documents | **Save and Update Item** |\r\n| Profile System | Documents | **Delete Item** |\r\n\r\nThere 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).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing app keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations."
      operationId: GetUnmaskedProspects
      parameters:
      - $ref: '#/components/parameters/Content-Type'
      - $ref: '#/components/parameters/Accept'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                description: List of prospects.
                items:
                  $ref: '#/components/schemas/UnmaskedProspectResponse'
              example:
              - id: 98478f6b-d025-4f35-a560-dd1ee7a6f26e
                document:
                  availableAddresses:
                  - disposable: true
                    userId: 98478f6b-d025-4f35-a560-dd1ee7a6f26e
                    addressName: customerAddressId
                    addressType: residential
                    postalCode: '32137'
                    city: Palm Coast
                    country: USA
                    street: Fifth St.
                    number: '9538'
                    complement: ''
                    receiverName: Jane Doe
                    geoCoordinate: []
                  paymentData:
                    availableAccounts: []
                    availableTokens: []
                    transactions: null
                    giftCards: []
                    giftCardMessages: []
                    numberOfPaymentErrors: 0
                    numberOfDeniedTransactions: 0
                    lastDeniedTransaction: null
                  contacts:
                  - contactId: '0'
                    email: ''
                    firstName: Jane
                    lastName: Doe
                    phone: ''
                    document: ''
                    documentType: ''
                  invoiceSubject:
                    invoiceSubjectId: '0'
                    email: jane@mail.com
                    firstName: Jane
                    lastName: Doe
                    phone: '12345678910'
                  email: jane@mail.com
                  firstName: Jane
                  lastName: Doe
                  document: 5397eefef23741d4976ebdf772cc42e0
                  cellPhone: '12345678910'
                  isPJ: false
                  customerCode: 5397eefe-f237-41d4-976e-bdf772cc42e0
                meta:
                  version: af9117e9-4169-46ee-ab4b-d4b17b881488
                  author: d6d8269f-e7cc-4e4b-8b89-3b46a1407937
                  creationDate: '2023-10-25T13:59:52.7633627+00:00'
                  lastUpdateDate: '2023-10-25T14:02:45.7277154+00:00'
                  expirationDate: null
      deprecated: false
  /api/storage/profile-system/prospects/{prospectId}:
    get:
      tags:
      - Prospects
      summary: VTex Get prospect
      description: "Retrieves the information of a specific prospect, by its `prospectId`.\n\r\n\r> For security and privacy reasons, this request returns masked prospect data. For unmasked information, see [Get unmasked prospect](https://developers.vtex.com/docs/api-reference/profile-system#get-/api/storage/profile-system/prospects/-prospectId-/unmask).\n\r\n\rLearn more about the [Profile System](https://developers.vtex.com/vtex-rest-api/docs/profile-system) and its other API endpoints.\r\n\r\n>⚠️ 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.\r\n>\r\n> 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/).\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-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:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Profile System | Documents | **Get Item** |\r\n| Profile System | Documents | **Save and Update Item** |\r\n| Profile System | Documents | **Delete Item** |\r\n\r\nThere 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).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing app keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations."
      operationId: GetProspect
      parameters:
      - $ref: '#/components/parameters/Content-Type'
      - $ref: '#/components/parameters/Accept'
      - $ref: '#/components/parameters/prospectId'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MaskedProspectResponse'
              example:
                id: 98478f6b-d025-4f35-a560-dd1ee7a6f26e
                document:
                  availableAddresses:
                  - disposable: true
                    userId: 98478f6b-d025-4f35-a560-dd1ee7a6f26e
                    addressName: customerAddressId
                    addressType: residential
                    postalCode: 3*****
                    city: P*****
                    country: USA
                    street: F*****
                    number: 9****
                    complement: ''
                    receiverName: J*** D**
                    geoCoordinate: []
                  paymentData:
                    availableAccounts: []
                    availableTokens: []
                    transactions: null
                    giftCards: []
                    giftCardMessages: []
                    numberOfPaymentErrors: 0
                    numberOfDeniedTransactions: 0
                    lastDeniedTransaction: null
                  contacts:
                  - contactId: '0'
                    email: ''
                    firstName: J***
                    lastName: D**
                    phone: ''
                    document: ''
                    documentType: ''
                  invoiceSubject:
                    invoiceSubjectId: '0'
                    email: j***@m***.c**
                    firstName: J***
                    lastName: D**
                    phone: 1**********
                  email: j***@m***.c**
                  firstName: J***
                  lastName: D**
                  document: 1**********
                  cellPhone: 1**********
                  isPJ: false
                  customerCode: 5397eefe-f237-41d4-976e-bdf772cc42e0
                meta:
                  version: af9117e9-4169-46ee-ab4b-d4b17b881488
                  author: d6d8269f-e7cc-4e4b-8b89-3b46a1407937
                  creationDate: '2023-10-25T13:59:52.7633627+00:00'
                  lastUpdateDate: '2023-10-25T14:02:45.7277154+00:00'
                  expirationDate: null
      deprecated: false
    patch:
      tags:
      - Prospects
      summary: VTex Update prospect
      description: "Updates one or more fields of an existing prospect.\n\r\n\rLearn more about the [Profile System](https://developers.vtex.com/vtex-rest-api/docs/profile-system) and its other API endpoints.\r\n\r\n>⚠️ 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.\r\n>\r\n> 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/).\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-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:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Profile System | Documents | **Get Item** |\r\n| Profile System | Documents | **Save and Update Item** |\r\n| Profile System | Documents | **Delete Item** |\r\n\r\nThere 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).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing app keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations."
      operationId: UpdateProspect
      parameters:
      - $ref: '#/components/parameters/Content-Type'
      - $ref: '#/components/parameters/Accept'
      - $ref: '#/components/parameters/prospectId'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Prospect'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnmaskedProspectResponse'
              example:
                id: c2cbebba-214e-40b2-b68f-98f862e755d5
                document:
                  availableAddresses:
                  - disposable: true
                    userId: 98478f6b-d025-4f35-a560-dd1ee7a6f26e
                    addressName: Home
                    addressType: residential
                    postalCode: '32137'
                    city: Palm Coast
                    country: USA
                    street: Fifth St.
                    number: '9538'
                    complement: Apartment 2B
                    geoCoordinate:
                    - string
                  paymentData:
                    availableAccounts:
                    - accountId: D09F5E3F01054C959CFC4CB357961ADE
                      paymentSystem: '2'
                      paymentSystemName: Visa
                      cardNumber: '************1111'
                      bin: '44443334'
                      availableAddresses:
                      - db267dcc53c14fb2b9a985532dd287bc
                      expirationDate: 01/2032
                      isExpired: false
                      accountStatus: null
                    availableTokens:
                    - '12345'
                    transactions:
                    - isActive: true
                      transactionId: 418213DE29634837A63DD693A937A696
                      merchantName: luxstore
                      payments:
                      - id: D3DEECAB3C6C4B9EAF8EF4C1FE062FF3
                        paymentSystem: '6'
                        paymentSystemName: Boleto Bancário
                        value: 4450
                        installments: 1
                        referenceValue: 4450
                        cardHolder: null
                        cardNumber: null
                        firstDigits: null
                        lastDigits: null
                        cvv2: null
                        expireMonth: null
                        expireYear: null
                        url: https://luxstore.vtexpayments.com.br:443/BankIssuedInvoice/Transaction/418213DE29634837A63DD693A937A696/Payment/D3DEECAB3C6C4B9EAF8EF4C1FE062FF3/Installment/{Installment}
                        giftCardId: null
                        giftCardName: null
                        giftCardCaption: null
                        redemptionCode: null
                        group: bankInvoice
                        tid: null
                        dueDate: '2019-02-02'
                        connectorResponses: {}
                    giftCards:
                    - '12345'
                    giftCardMessages:
                    - Message.
                    numberOfPaymentErrors: 0
                    numberOfDeniedTransactions: 0
                    lastDeniedTransaction: null
                  contacts:
                  - contactId: '0'
                    email: jane@mail.com
                    firstName: Jane
                    lastName: Doe
                    phone: '12345678910'
                    document: '12345678910'
                  invoiceSubject:
                    invoiceSubjectId: '0'
                    email: jane@mail.com
                    firstName: Jane
                    lastName: Doe
                    phone: '12345678910'
                  email: jane@mail.com
                  firstName: Jane
                  lastName: Doe
                  document: 5397eefef23741d4976ebdf772cc42e0
                  cellPhone: '12345678910'
                  isPJ: false
                  customerCode: 5397eefe-f237-41d4-976e-bdf772cc42e0
                meta:
                  version: 27112371-a71b-45d6-b3bc-93436a3a0b4f
                  author: 82a2b53d-39be-4f49-bb7c-8971b58cb7dc
                  creationDate: '2022-01-05T15:41:37.5009471+00:00'
                  lastUpdateDate: '2022-01-05T15:41:37.5009471+00:00'
                  expirationDate: '2022-01-05T15:41:37.5009471+00:00'
      deprecated: false
    delete:
      tags:
      - Prospects
      summary: VTex Delete prospect
      description: "Deletes a prospect by `prospectId`.\n\r\n\rLearn more about the [Profile System](https://developers.vtex.com/vtex-rest-api/docs/profile-system) and its other API endpoints.\r\n\r\n>⚠️ 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.\r\n>\r\n> 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/).\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-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:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Profile System | Docume

# --- truncated at 32 KB (53 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/vtex/refs/heads/main/openapi/vtex-prospects-api-openapi.yml