> ## Documentation Index
> Fetch the complete documentation index at: https://developers.hubspot.de/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Generate a visitor identification token

> Generieren Sie ein Identifizierungstoken für einen Website-Besucher, der über Ihr eigenes System authentifiziert wurde. Ein von dieser API zurückgegebenes Identifizierungstoken kann verwendet werden, um Informationen über Ihren bereits authentifizierten Besucher an das Chat-Widget weiterzugeben, sodass dieses den Besucher als bekannten Kontakt behandelt. Auf diese Weise können Supportmitarbeiter den Besucher besser erkennen und effektiver unterstützen.

> [accordion] Supported products

> [accordion] Required Scopes


## OpenAPI

````yaml specs/legacy/v3/conversations-visitor-identification-v3.json POST /visitor-identification/v3/tokens/create
openapi: 3.0.1
info:
  title: Conversations Visitor Identification
  description: Basepom for all HubSpot Projects
  version: v3
  x-hubspot-product-tier-requirements:
    marketing: PROFESSIONAL
    sales: PROFESSIONAL
    service: PROFESSIONAL
    cms: PROFESSIONAL
    commerce: PROFESSIONAL
    crmHub: PROFESSIONAL
    dataHub: PROFESSIONAL
  x-hubspot-related-documentation:
    - name: 'Visitor Identification Guide '
      url: >-
        https://developers.hubspot.com/docs/guides/api/conversations/visitor-identification
servers:
  - url: https://api.hubapi.com
security: []
tags:
  - name: Basic
paths:
  /visitor-identification/v3/tokens/create:
    post:
      tags:
        - Basic
      summary: Besucher-Token generieren
      description: >-
        Generieren Sie ein Identifizierungstoken für einen Website-Besucher, der
        über Ihr eigenes System authentifiziert wurde. Ein von dieser API
        zurückgegebenes Identifizierungstoken kann verwendet werden, um
        Informationen über Ihren bereits authentifizierten Besucher an das
        Chat-Widget weiterzugeben, sodass dieses den Besucher als bekannten
        Kontakt behandelt. Auf diese Weise können Supportmitarbeiter den
        Besucher besser erkennen und effektiver unterstützen.
      operationId: post-/visitor-identification/v3/tokens/create_generateToken
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/IdentificationTokenGenerationRequest'
        required: true
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IdentificationTokenResponse'
        default:
          $ref: '#/components/responses/Error'
          description: ''
      security:
        - oauth2:
            - conversations.visitor_identification.tokens.create
components:
  schemas:
    IdentificationTokenGenerationRequest:
      required:
        - email
        - hsCustomerAgentContext
      type: object
      properties:
        email:
          type: string
          description: Die E-Mail des Besuchers, den Sie identifizieren möchten
        firstName:
          type: string
          description: >-
            Der Vorname des Besuchers, den Sie identifizieren möchten. Dieser
            Wert wird in HubSpot nur für neue Kontakte und vorhandene Kontakte
            mit unbekanntem Vornamen festgelegt. Optional.
        hsCustomerAgentContext:
          type: object
          additionalProperties:
            type: string
        lastName:
          type: string
          description: >-
            Der Nachname des Besuchers, den Sie identifizieren möchten. Dieser
            Wert wird in HubSpot nur für neue Kontakte und vorhandene Kontakte
            mit unbekanntem Nachnamen festgelegt. Optional.
    IdentificationTokenResponse:
      required:
        - token
      type: object
      properties:
        token:
          type: string
          description: >-
            Ein Identifizierungstoken, mit dem der Besucher als bekannter
            Kontakt behandelt werden kann.
    Error:
      required:
        - category
        - correlationId
        - message
      type: object
      properties:
        category:
          type: string
          description: Die Fehlerkategorie
        context:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
          description: Kontext zur Fehlerbedingung
          example: >-
            {invalidPropertyName=[propertyValue], missingScopes=[scope1,
            scope2]}
        correlationId:
          type: string
          description: >-
            Eine eindeutige ID für die Anfrage. Berücksichtigen Sie diesen Wert
            in Fehlerberichten oder Support-Tickets.
          format: uuid
          example: aeb5f871-7f07-4993-9211-075dc63e7cbf
        errors:
          type: array
          description: Weitere Informationen zum Fehler
          items:
            $ref: '#/components/schemas/ErrorDetail'
        links:
          type: object
          additionalProperties:
            type: string
          description: >-
            Eine Zuordnung der Namen von Links zu zugeordneten URIs mit einer
            Dokumentation zum Fehler oder empfohlenen Abhilfemaßnahmen
        message:
          type: string
          description: >-
            Eine für Menschen lesbare Nachricht mit einer Beschreibung des
            Fehlers und ggf. Abhilfemaßnahmen
          example: An error occurred
        subCategory:
          type: string
          description: Eine spezifische Kategorie, die genauere Details zum Fehler enthält
      description: >-
        Stellt eine Fehlerantwort dar, die von der API zurückgegeben wird, wenn
        ein Vorgang fehlschlägt. Diese Komponente wird in verschiedenen
        Endpunkten verwendet, um detaillierte Informationen über den
        aufgetretenen Fehler bereitzustellen.
      example:
        message: Invalid input (details will vary based on the error)
        correlationId: aeb5f871-7f07-4993-9211-075dc63e7cbf
        category: VALIDATION_ERROR
        links:
          knowledge-base: https://www.hubspot.com/products/service/knowledge-base
    ErrorDetail:
      required:
        - message
      type: object
      properties:
        code:
          type: string
          description: Der Statuscode, der dem Fehlerdetail zugeordnet ist
        context:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
          description: Kontext zur Fehlerbedingung
          example: '{missingScopes=[scope1, scope2]}'
        in:
          type: string
          description: >-
            Der Name des Felds oder Parameters, in dem der Fehler gefunden
            wurde.
        message:
          type: string
          description: >-
            Eine für Menschen lesbare Nachricht mit einer Beschreibung des
            Fehlers und ggf. Abhilfemaßnahmen
        subCategory:
          type: string
          description: Eine spezifische Kategorie, die genauere Details zum Fehler enthält
      description: >-
        Stellt detaillierte Informationen zu einem in der API aufgetretenen
        Fehler dar. Diese Komponente wird verwendet, um zusätzlichen Kontext und
        spezifische Details zu Fehlern bereitzustellen, typischerweise als Teil
        einer Fehlerantwort.
  responses:
    Error:
      description: An error occurred.
      content:
        '*/*':
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    oauth2:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://app.hubspot.com/oauth/authorize
          tokenUrl: https://api.hubapi.com/oauth/v1/token
          scopes:
            conversations.visitor_identification.tokens.create: ''

````