Unmonitoring a Face

In cases where a person no longer needs to be monitored, you can use the Unmonitor Face API to remove them from the monitoring system. This process is done using the unique externalId provided by the partner during enrollment. Once removed, the system will no longer track or report detections for this individual.

API Endpoint

• HTTP Method: DELETE
• 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 for the person to be removed from monitoring, as provided 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";

// Unmonitor the face
await sdk.FaceUnMonitorAsync(externalId);

Curl

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

# Unmonitor the face
curl -X DELETE "$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"

# Unmonitor the face
Invoke-RestMethod -Uri "$API_URL/api/v1/faces/monitor/$EXTERNAL_ID" -Method Delete -Headers @{ "Authorization" = "Bearer $TOKEN" }

Raw Sample

Here's an example of how to use the DELETE method to unmonitor a face:

Request

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

Response

• 200 OK: The face was successfully unmonitored.
• 401 Unauthorized: Missing or invalid JWT token.
• 500 Internal Server Error: An issue occurred on the server side. The reason is returned in the problem details body.

Example Response

{}

The success response body is an empty object by design — FaceUnmonitorResponse carries no fields. Treat the 200 status code as the result, and do not expect any properties to read.

Additional Notes

• Ensure that the externalId provided in the URL matches the one used during the initial enrollment. This is a case sensitive call.
• The system will return a 200 OK if the face was successfully unmonitored, or a 500 Internal Server Error if there were any issues processing the request.
• To confirm the removal, follow up with Face Monitor Status.