> ## Documentation index > Fetch the complete documentation index at: https://developer.rhombus.com/llms.txt > Use it to discover all available pages before exploring further. # Update face event > Update face event. ```http POST https://api2.rhombussystems.com/api/faceRecognition/faceEvent/updateFaceEvent ``` EU organizations send the same request to `https://api2.eu.rhombussystems.com`. ## Authentication and parameters - `x-auth-apikey` (header, required): Your Rhombus API key. Must be accompanied by the `x-auth-scheme` header set to `api-token` (or `partner-api-token` for partner endpoints). - `Authorization` (header): instead of an API key, an OAuth access token (`Bearer `) with the `write` scope. - `x-auth-scheme` (header, string, default: `api-token`): Authentication scheme identifier. Use `api-token` or `partner-api-token` with the `x-auth-apikey` header, `api` or `partner-api` with `x-auth-apikey` plus a client certificate, `api-oauth-token` or `partner-api-oauth-token` with `x-auth-access-token`, and `federated-token` with `x-auth-ft`. A request with `Authorization: Bearer ` and no `x-auth-scheme` is treated as OAuth, and `federated-token` may also be sent as the `x-auth-scheme` and `x-auth-ft` query parameters. One of: `api-token`, `api`, `api-oauth-token`, `federated-token`, `partner-api-token`, `partner-api`, `partner-api-oauth-token`. - `x-auth-org` (header, string): Client organization UUID (22-character RUUID), for partner credentials only. With it the call runs in that client organization with the partner support authority's role. Without it a partner credential runs as the partner organization, which outside the partner endpoints is deprecated (responses carry `Deprecation` and `Sunset: Tue, 05 Jan 2027 00:00:00 GMT`). A malformed value returns 400 `INVALID_AUTH_ORG`; a client organization the partner cannot access returns 403 `PARTNER_CLIENT_ACCESS_DENIED`. ## Request body Content type: `application/json`. Request object for updating a face event with person association information. - `eventUuid` (string | null): base 64 (url-safe) uuid string - `personName` (string | null): Name of the person associated with the face event. Ignored if person UUID matches to one of the top person matches. - `personUuid` (string | null): base 64 (url-safe) uuid string ## Response 200 OK. Content type: `application/json` - `faceEvent` (object): External face event object containing face recognition data with person matches, embeddings, and metadata. ## Errors Also 400, 401, 403, 429, 500, 503 with the standard error body (`errorCode`, `errorMsg`): https://developer.rhombus.com/errors ## OpenAPI ````yaml openapi: 3.0.1 info: title: Rhombus API version: "1.0" servers: - description: Production Server url: https://api2.rhombussystems.com security: - ApiKeyAuth: [] paths: /api/faceRecognition/faceEvent/updateFaceEvent: post: description: Update face event. operationId: updateFaceEvent parameters: - description: "Authentication scheme identifier. Use `api-token` or `partner-api-token` with the `x-auth-apikey` header, `api` or `partner-api` with `x-auth-apikey` plus a client certificate, `api-oauth-token` or `partner-api-oauth-token` with `x-auth-access-token`, and `federated-token` with `x-auth-ft`. A request with `Authorization: Bearer ` and no `x-auth-scheme` is treated as OAuth, and `federated-token` may also be sent as the `x-auth-scheme` and `x-auth-ft` query parameters." example: api-token in: header name: x-auth-scheme required: false schema: default: api-token enum: - api-token - api - api-oauth-token - federated-token - partner-api-token - partner-api - partner-api-oauth-token type: string - description: "Client organization UUID (22-character RUUID), for partner credentials only. With it the call runs in that client organization with the partner support authority's role. Without it a partner credential runs as the partner organization, which outside the partner endpoints is deprecated (responses carry `Deprecation` and `Sunset: Tue, 05 Jan 2027 00:00:00 GMT`). A malformed value returns 400 `INVALID_AUTH_ORG`; a client organization the partner cannot access returns 403 `PARTNER_CLIENT_ACCESS_DENIED`." in: header name: x-auth-org required: false schema: format: RUUID maxLength: 22 minLength: 22 type: string 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 "400": $ref: "#/components/responses/BadRequest" "401": $ref: "#/components/responses/Unauthorized" "403": $ref: "#/components/responses/Forbidden" "429": $ref: "#/components/responses/TooManyRequests" "500": $ref: "#/components/responses/InternalServerError" "503": $ref: "#/components/responses/ServiceUnavailable" security: - ApiKeyAuth: [] - oauth2: - write summary: Update face event tags: - Face Recognition Event Webservice components: schemas: Facerecognition_faceevent_UpdateFaceEventWSRequest: description: Request object for updating a face event with person association information. properties: eventUuid: description: base 64 (url-safe) uuid string example: AAAAAAAAAAAAAAAAAAAAAA format: RUUID nullable: true type: string personName: description: Name of the person associated with the face event. Ignored if person UUID matches to one of the top person matches. nullable: true type: string personUuid: description: base 64 (url-safe) uuid string example: AAAAAAAAAAAAAAAAAAAAAA format: RUUID nullable: true type: string type: object Facerecognition_faceevent_UpdateFaceEventWSResponse: description: Response object for updating a face event. properties: faceEvent: $ref: "#/components/schemas/Facerecognition_faceevent_ExternalFaceEvent" type: object Facerecognition_faceevent_ExternalFaceEvent: description: External face event object containing face recognition data with person matches, embeddings, and metadata. properties: detectionConfidence: description: Confidence value indicating the likelihood that the detected image is a face example: 0.98 format: float nullable: true type: number deviceUuid: description: RUUID with optional appended facet information example: AAAAAAAAAAAAAAAAAAAAAA.v0 format: DeviceFacetUuid nullable: true type: string embeddingConfidence: description: Confidence value associated with the embedding generated for the face image example: 0.95 format: float nullable: true type: number eventTimestamp: description: Timestamp when the face event occurred example: 1640995200000 format: int64 nullable: true type: integer faceName: 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 type: string hasEmbedding: description: Whether the face event has an embedding example: true nullable: true type: boolean imageS3Key: description: S3 key for the face event image example: face-events/images/event_123.jpg nullable: true type: string locationUuid: description: base 64 (url-safe) uuid string example: AAAAAAAAAAAAAAAAAAAAAA format: RUUID nullable: true type: string orgUuid: description: base 64 (url-safe) uuid string example: AAAAAAAAAAAAAAAAAAAAAA format: RUUID nullable: true type: string personUuid: description: base 64 (url-safe) uuid string example: AAAAAAAAAAAAAAAAAAAAAA format: RUUID nullable: true type: string selectedPersonMatch: $ref: "#/components/schemas/Facerecognition_faceevent_ExternalPersonMatch" subLocationsHierarchyKey: description: | A sequence of one or more base 64 (url-safe) uuid substrings. These substrings are separated by dots (.). example: AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA format: SubLocationsHierarchyKey nullable: true pattern: ^([A-Za-z0-9\-_]{22})([.][A-Za-z0-9\-_]{22})*$ type: string thumbnailS3Key: description: S3 key for the face event thumbnail example: face-events/thumbnails/event_123.jpg nullable: true type: string topPersonMatches: description: Top person matches found for the face image. items: $ref: "#/components/schemas/Facerecognition_faceevent_ExternalPersonMatch" nullable: true type: array uuid: description: base 64 (url-safe) uuid string example: AAAAAAAAAAAAAAAAAAAAAA format: RUUID nullable: true type: string type: object Facerecognition_faceevent_ExternalPersonMatch: description: Person match information for face recognition events with confidence scoring. properties: confidence: description: Match confidence level expressed as a value in range[0,1] example: 0.95 format: float nullable: true type: number faceId: description: Face ID associated with the person match example: face_12345 nullable: true type: string name: description: Name of the person matched example: John Doe nullable: true type: string uuid: description: base 64 (url-safe) uuid string example: AAAAAAAAAAAAAAAAAAAAAA format: RUUID nullable: true type: string type: object 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 oauth2: description: 'OAuth 2.0 authorization code flow with PKCE (`S256`). Send the access token as `Authorization: Bearer `. Each operation lists the scopes it requires; a token without them is refused 403 with `WWW-Authenticate: Bearer error="insufficient_scope"`.' flows: authorizationCode: authorizationUrl: https://console.rhombus.com/oauth/authorize refreshUrl: https://auth-web.rhombussystems.com/oauth/token scopes: physical: Unlock doors and elevators, lockdown, alarms, speakers and robots read: View cameras, footage and settings write: Change settings and data tokenUrl: https://auth-web.rhombussystems.com/oauth/token type: oauth2 ````