Skip to content

Find similar face events

Find face events for an organization that are similar to a specified face event. The events are returned in reverse chronological order, with the latest events appearing first.

POST/api/faceRecognition/faceEvent/findSimilarFaceEvents

Authorizations

x-auth-apikeystringheaderrequired

Your Rhombus API key. Must be accompanied by the x-auth-scheme header set to api-token (or partner-api-token for partner endpoints).

Authorizationstringheader

Instead of an API key, an OAuth access token: Bearer <token>, with the read scope.

OAuth explains tokens and scopes.

Headers

x-auth-schemeenum<string>headerdefault: 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 <token> 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.

Available options: api-token, api, api-oauth-token, federated-token, partner-api-token, partner-api, partner-api-oauth-token

x-auth-orgstring<RUUID>header

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.

Length: 22 to 22

Body

application/json · object

Request object for finding face events similar to a specified face event with search filtering and pagination.

faceEventUuidstring<RUUID> | nullbody

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

pageRequestobjectbody

Pagination request for retrieving policy alerts. Page size must be between 1 and 1000.

Show child attributes
lastEvaluatedKeystring | nullbody
maxPageSizeinteger<int32> | nullbody
searchFilterobjectbody

Search filter for finding similar face events with similarity thresholds and confidence settings.

Show child attributes
deviceUuidsstring<DeviceFacetUuid>[] | nullbody

Optional filter by a set of devices.

embeddingConfidenceThresholdnumber<float> | nullbody

Optional face embedding confidence threshold used to filter out face events with embeddingconfidence values less than the specified threshold. Valid range [0,1].

Range: 0 to 1

faceMatchDistanceThresholdnumber<float> | nullbody

Optional face match distance threshold used to compare face event images. Defaults to 0.7.Valid range [0,1].

Range: 0 to 1

faceNameContainsstring | nullbody

Optional filter by name. Matching is case-insensitive: the value is resolved against the org's registered people by substring and the face events of the matching people are returned; if no registered person matches, the face event is a match if its face name contains the value ignoring case. Set fuzzyNameMatch to also tolerate small spelling differences. The search will only be performed if the provided value is at least 3 characters long after trimming leading and trailing spaces. If both faceNameContains and faceNames are specified, faceNameContains takes a precedence.

faceNamesstring[] | nullbody

Optional filter by people names.

fuzzyNameMatchboolean | nullbody

When true, faceNameContains also tolerates small spelling differences against the org's registered people; default false. Matching is case-insensitive either way.

hasNameboolean | nullbody

Optional filter by the presence or absence of a person name.

labelsstring[] | nullbody

Optional filter by labels.

locationUuidsstring<RUUID>[] | nullbody

Optional filter by a set of locations.

personUuidsstring<RUUID>[] | nullbody

Optional filter by a set of people.

timestampFilterobjectbody

Optional filter by an event timestamp. If not specified, the filter defaults to the last 7 days.

Show child attributes
rangeEndstring<date-time> | nullbody

End of the date range (inclusive).

rangeStartstring<date-time> | nullbody

Start of the date range (inclusive).

Response

200 OK

application/json · object

Response object containing face events similar to a specified face event with pagination information.

faceEventsobject[] | null

List of face events similar to the specified face event

Show child attributes
detectionConfidencenumber<float> | null

Confidence value indicating the likelihood that the detected image is a face

Example: 0.98

deviceUuidstring<DeviceFacetUuid> | null

RUUID with optional appended facet information

Example: "AAAAAAAAAAAAAAAAAAAAAA.v0"

embeddingConfidencenumber<float> | null

Confidence value associated with the embedding generated for the face image

Example: 0.95

eventTimestampinteger<int64> | null

Timestamp when the face event occurred

Example: 1640995200000

faceNamestring | null

Name of the person that matched the face image. If selectedPersonMatch is not null, faceName will be equal to the name field of selectedPersonMatch.

hasEmbeddingboolean | null

Whether the face event has an embedding

Example: true

imageS3Keystring | null

S3 key for the face event image

Example: "face-events/images/event_123.jpg"

locationUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

orgUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

personUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

selectedPersonMatchobject

Person match information for face recognition events with confidence scoring.

Show child attributes
confidencenumber<float> | null

Match confidence level expressed as a value in range[0,1]

Example: 0.95

faceIdstring | null

Face ID associated with the person match

Example: "face_12345"

namestring | null

Name of the person matched

Example: "John Doe"

uuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

subLocationsHierarchyKeystring<SubLocationsHierarchyKey> | null

A sequence of one or more base 64 (url-safe) uuid substrings. These substrings are separated by dots (.).

Pattern: ^([A-Za-z0-9\-_]{22})([.][A-Za-z0-9\-_]{22})*$

Example: "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA"

thumbnailS3Keystring | null

S3 key for the face event thumbnail

Example: "face-events/thumbnails/event_123.jpg"

topPersonMatchesobject[] | null

Top person matches found for the face image.

Show child attributes
confidencenumber<float> | null

Match confidence level expressed as a value in range[0,1]

Example: 0.95

faceIdstring | null

Face ID associated with the person match

Example: "face_12345"

namestring | null

Name of the person matched

Example: "John Doe"

uuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

uuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

lastEvaluatedKeystring | null

Pagination key for retrieving the next page of similar face events

Example: "next_page_key_123"

Errors

Like every operation, this one can also answer with the standard error body (errorCode, errorMsg). Errors explains each status and how to retry.

  • 400 Bad Request. errorCode is one of: BAD_REQUEST, VALIDATION_FAILED, MISSING_REQUIRED_FIELD, INVALID_JSON, INVALID_REQUEST_BODY, FEATURE_NOT_ENABLED, INVALID_AUTH_ORG, LOCATION_NOT_FOUND, SELF_PROVISIONING_DISABLED, SKU_NOT_ALLOWED, QUANTITY_INVALID, AUTO_RENEW_REQUIRED, PROVISION_CAP_EXCEEDED, ACKNOWLEDGEMENT_REQUIRED, SIGNATURE_REQUIRED, APEX_VALIDATION, SKU_NOT_IN_PRICEBOOK.
  • 401 Unauthorized. errorCode is one of: UNAUTHENTICATED, INVALID_CREDENTIAL, CREDENTIAL_EXPIRED, CREDENTIAL_REVOKED, CERTIFICATE_MISMATCH.
  • 403 Forbidden. errorCode is one of: FORBIDDEN, DOMAIN_NOT_ALLOWED, DEVICE_SCOPE_MISMATCH, ROLE_NOT_PERMITTED, FUNCTIONALITY_REQUIRED, PARTNER_FUNCTIONALITY_REQUIRED, PERMISSION_REQUIRED, PARTNER_CLIENT_ACCESS_DENIED, HARDWARE_NOT_AVAILABLE, HARDWARE_ALREADY_REGISTERED, PARTNER_PORTAL_NOT_ENABLED, MANAGED_BY_MSP, SUPER_ADMIN_RESTRICTED_BY_MSP, MSP_DESIGNATION_INVALID, NOT_MANAGED_CLIENT, NOT_VERIFIED_MSP, ORDER_NOT_YOURS.
  • 429 Too Many Requests. errorCode is one of: RATE_LIMITED, QUOTE_RATE_LIMITED.
  • 500 Internal Server Error. errorCode is one of: INTERNAL_ERROR.
  • 503 Service Unavailable. errorCode is one of: SERVICE_UNAVAILABLE, SALESFORCE_UNAVAILABLE.