Face biometric events

Face biometric events notify you when face biometrics are created. When a face biometric event is triggered, IDaaS sends an HTTP POST request to your configured webhook URL with a JSON payload containing the event details.

Payload structure

Every face biometric event payload has this structure:

{
  "id": "019cf825-3f2b-738d-8a72-73512b91d3ae",
  "type": "face.biometric.created",
  "accountId": "fba02d5c-2f79-4cfd-91f5-6bd454e97ab3",
  "eventTime": "2026-03-16T19:35:16Z",
  "data": {
    // Event-specific data here
  }
}

The data object contains event-specific fields. See the event examples later on this page for the full data object for each event type.

Top-level fields

Field	Type	Description
id	string	Unique identifier for this webhook delivery
type	string	The event that occurred (for example, face.biometric.created)
accountId	string	Your account identifier
eventTime	string	When the event occurred (ISO 8601 format)
data	object	Details about what happened (varies by event type)

Event types

face.biometric.created

Triggered when a face biometric is created.

Example payload:

{
  "id": "019cf825-3f2b-738d-8a72-73512b91d3ae",
  "type": "face.biometric.created",
  "accountId": "fba02d5c-2f79-4cfd-91f5-6bd454e97ab3",
  "eventTime": "2026-03-16T19:35:16Z",
  "data": {
    "subject": "062e8a87-0e86-482a-a0ab-c6429fb599b9",
    "subjectName": "john",
    "subjectType": "USER",
    "resourceName": "Administration Portal",
    "sourceIp": "104.30.161.19",
    "subscriberAdminRoleName": "Super Administrator",
    "entityType": "FACE",
    "entityId": "d2b7e02f-9978-4091-aaa0-ae72f96e1415",
    "entityName": "19196-24946",
    "entityAttributes": {
      "userId": "john",
      "status": "ACTIVATING"
    }
  }
}

The data object includes the following fields:

Field	Description
subject	ID of the user associated with the face biometric
subjectName	Username of the user associated with the face biometric
subjectType	Always USER
resourceName	Where the face biometric was created (for example, Administration Portal)
sourceIp	IP address from which the face biometric was created
subscriberAdminRoleName	Administrator role used to create the face biometric, when applicable
entityType	Always FACE for face biometric events
entityId	ID of the created face biometric
entityName	Face biometric identifier
entityAttributes	Details about the created face biometric (see below)

The entityAttributes object includes these fields:

• userId - Username of the user who has this face biometric
• status - Current status of the face biometric