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

# Update face event

> Update face event.



## OpenAPI

````yaml https://api2.rhombussystems.com/api/openapi/public.json post /api/faceRecognition/faceEvent/updateFaceEvent
openapi: 3.0.1
info:
  contact:
    email: developer@rhombussystems.com
  description: >-
    This API is for use by Rhombus customers and partners.


    ## Authentication


    All requests require two headers:

    - `x-auth-scheme` — The authentication scheme identifier. Use `api-token`
    for standard API key auth, or `partner-api-token` for partner API auth.

    - `x-auth-apikey` — Your Rhombus API key.


    Example:

    ```

    POST /api/camera/getMinimalCameraStateList

    x-auth-scheme: api-token

    x-auth-apikey: YOUR_API_KEY

    Content-Type: application/json

    ```
  title: Rhombus API
  version: '1.0'
servers:
  - description: Production Server
    url: https://api2.rhombussystems.com
security:
  - ApiKeyAuth: []
paths:
  /api/faceRecognition/faceEvent/updateFaceEvent:
    post:
      tags:
        - Face Recognition Event Webservice
      summary: Update face event
      description: Update face event.
      operationId: updateFaceEvent
      parameters:
        - description: >-
            Authentication scheme identifier. Use `api-token` for standard API
            key authentication, `partner-api-token` for partner API key
            authentication. Must be paired with the `x-auth-apikey` header
            containing your API key.
          example: api-token
          in: header
          name: x-auth-scheme
          required: true
          schema:
            type: string
            default: api-token
            enum:
              - api-token
              - api
              - partner-api-token
              - partner-api
      requestBody:
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/Facerecognition_faceevent_UpdateFaceEventWSRequest
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/Facerecognition_faceevent_UpdateFaceEventWSResponse
          description: OK
components:
  schemas:
    Facerecognition_faceevent_UpdateFaceEventWSRequest:
      type: object
      description: >-
        Request object for updating a face event with person association
        information.
      properties:
        eventUuid:
          type: string
          format: RUUID
          description: base 64 (url-safe) uuid string
          example: AAAAAAAAAAAAAAAAAAAAAA
          nullable: true
        personName:
          type: string
          description: >-
            Name of the person associated with the face event. Ignored if person
            UUID matches to one of the top person matches.
          nullable: true
        personUuid:
          type: string
          format: RUUID
          description: base 64 (url-safe) uuid string
          example: AAAAAAAAAAAAAAAAAAAAAA
          nullable: true
    Facerecognition_faceevent_UpdateFaceEventWSResponse:
      type: object
      description: Response object for updating a face event.
      properties:
        faceEvent:
          $ref: '#/components/schemas/Facerecognition_faceevent_ExternalFaceEvent'
    Facerecognition_faceevent_ExternalFaceEvent:
      type: object
      description: >-
        External face event object containing face recognition data with person
        matches, embeddings, and metadata.
      properties:
        detectionConfidence:
          type: number
          format: float
          description: >-
            Confidence value indicating the likelihood that the detected image
            is a face
          example: 0.98
          nullable: true
        deviceUuid:
          type: string
          format: DeviceFacetUuid
          description: RUUID with optional appended facet information
          example: AAAAAAAAAAAAAAAAAAAAAA.v0
          nullable: true
        embeddingConfidence:
          type: number
          format: float
          description: >-
            Confidence value associated with the embedding generated for the
            face image
          example: 0.95
          nullable: true
        eventTimestamp:
          type: integer
          format: int64
          description: Timestamp when the face event occurred
          example: 1640995200000
          nullable: true
        faceName:
          type: string
          description: >-
            Name of the person that matched the face image. If
            selectedPersonMatch is not null, faceName will be equal to the name
            field of selectedPersonMatch.
          nullable: true
        hasEmbedding:
          type: boolean
          description: Whether the face event has an embedding
          example: true
          nullable: true
        imageS3Key:
          type: string
          description: S3 key for the face event image
          example: face-events/images/event_123.jpg
          nullable: true
        locationUuid:
          type: string
          format: RUUID
          description: base 64 (url-safe) uuid string
          example: AAAAAAAAAAAAAAAAAAAAAA
          nullable: true
        orgUuid:
          type: string
          format: RUUID
          description: base 64 (url-safe) uuid string
          example: AAAAAAAAAAAAAAAAAAAAAA
          nullable: true
        personUuid:
          type: string
          format: RUUID
          description: base 64 (url-safe) uuid string
          example: AAAAAAAAAAAAAAAAAAAAAA
          nullable: true
        selectedPersonMatch:
          $ref: '#/components/schemas/Facerecognition_faceevent_ExternalPersonMatch'
        subLocationsHierarchyKey:
          type: string
          format: SubLocationsHierarchyKey
          description: |
            A sequence of one or more base 64 (url-safe) uuid substrings.
            These substrings are separated by dots (.).
          example: AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA
          nullable: true
          pattern: ^([A-Za-z0-9\-_]{22})([.][A-Za-z0-9\-_]{22})*$
        thumbnailS3Key:
          type: string
          description: S3 key for the face event thumbnail
          example: face-events/thumbnails/event_123.jpg
          nullable: true
        topPersonMatches:
          type: array
          description: Top person matches found for the face image.
          items:
            $ref: '#/components/schemas/Facerecognition_faceevent_ExternalPersonMatch'
          nullable: true
        uuid:
          type: string
          format: RUUID
          description: base 64 (url-safe) uuid string
          example: AAAAAAAAAAAAAAAAAAAAAA
          nullable: true
    Facerecognition_faceevent_ExternalPersonMatch:
      type: object
      description: >-
        Person match information for face recognition events with confidence
        scoring.
      properties:
        confidence:
          type: number
          format: float
          description: Match confidence level expressed as a value in range[0,1]
          example: 0.95
          nullable: true
        faceId:
          type: string
          description: Face ID associated with the person match
          example: face_12345
          nullable: true
        name:
          type: string
          description: Name of the person matched
          example: John Doe
          nullable: true
        uuid:
          type: string
          format: RUUID
          description: base 64 (url-safe) uuid string
          example: AAAAAAAAAAAAAAAAAAAAAA
          nullable: true
  securitySchemes:
    ApiKeyAuth:
      description: >-
        Your Rhombus API key. Must be accompanied by the `x-auth-scheme` header
        set to `api-token` (or `partner-api-token` for partner endpoints).
      in: header
      name: x-auth-apikey
      type: apiKey

````