Face Monitor Status

You can use the Check Face Status API to verify if a specific individual (identified by their externalId) is currently being monitored in the system. This helps ensure that a person's monitoring status is active, or to confirm their removal.

API Endpoint

• HTTP Method: GET
• Endpoint: /api/v1/faces/monitor/{externalId}
• Private Server Base URL: https://10.0.0.123:5022
• Cloud Server Base URL: https://customername.econnectcloud.com/eventsbridge

Authentication

This API call requires authentication with a JWT token, which must be passed in the header of the request.

Path Parameter

• externalId: The unique ID assigned to the person during the enrollment process. This value is case sensitive.

Code Examples

C#

using eConnect.EventsBridge.Sdk;

// Assuming sdk is already initialized with authentication
// Define the externalId
string externalId = "12345";

// Check enrollment status
var status = await sdk.FaceMonitorStatusCheckAsync(externalId);

// Process the result
Console.WriteLine($"Face with External ID {externalId} is {(status.Enrolled ? "enrolled" : "not enrolled")}.");

Curl

# Define variables
API_URL="https://your-domain.com/eventsbridge"
TOKEN="your_token"
EXTERNAL_ID="12345"

# Check enrollment status
curl -X GET "$API_URL/api/v1/faces/monitor/$EXTERNAL_ID" \
  -H "Authorization: Bearer $TOKEN"

PowerShell

# Define variables
$API_URL = "https://your-domain.com/eventsbridge"
$TOKEN = "your_token"
$EXTERNAL_ID = "12345"

# Check enrollment status
$statusResponse = Invoke-RestMethod -Uri "$API_URL/api/v1/faces/monitor/$EXTERNAL_ID" -Method Get -Headers @{ "Authorization" = "Bearer $TOKEN" }

# Process the result
Write-Output "Face with External ID $EXTERNAL_ID is $($statusResponse.enrolled ? 'enrolled' : 'not enrolled')."

Raw Sample

Here's an example of how to use the GET method to check if a face is being monitored:

Request

GET https://10.0.0.123:5022/api/v1/faces/monitor/12345
Authorization: Bearer <your_jwt_token>
Content-Type: application/json

Response

• 200 OK: The monitoring status was retrieved.
• 401 Unauthorized: Missing or invalid JWT token.
• 500 Internal Server Error: An issue occurred on the server side.

Example Response

{
  "enrolled": true
}

Field Descriptions

• enrolled (Boolean): Whether the face is currently monitored.
  • true: the face is monitored on every connected Facial Recognition server.
  • false: the face is missing from at least one of them.

false does not mean "not enrolled anywhere"

This flag is an AND across all connected FR servers. If several are behind Events Bridge and the subject is enrolled on some but not all, this returns false even though detections may still be reported from the servers that do have them.

To see the per-server breakdown, use Get All Monitored, which reports enrolled and expected counts along with a status entry for each server.

Additional Notes

• Make sure to use the same externalId that was supplied during enrollment. It is case sensitive.
• The externalId provided in the URL must match an existing enrollment to return accurate results.