Events

Available types:

• WebSockets

• Webhooks

WebSockets

In order to connect to a WebSocket, a account or user token is needed.

Authentication

// WebSocket url connection
ws://biometrid.com/ws?token=...

In the above code block, the domain (biometrid.com) is the only reference that can change.

Channels

To send and receive messages, we must join a channel.

Channel	Token Type
process:processId	Account
account:accountId	User

Webhooks

In order to receive some webhooks events, go to your flow and configure the required messages.

Messages

Account

Event	Data	Description
process:created	{id, flowId}	Process created
process:status	{id, flowId, status}	Process status changed
process:updated	{id, flowId, stepId}	Process has been updated
process:face_compare_2d2d_processed	{status}	Face compare 2d2d has ended
process:face_liveness_3d_processed	{status}	Liveness 2d validation has ended
process:document_ocr_processed	{status, data}	IDCard validation has ended
process:users_processed	{allChildsFinished}	Users has ended
videoconference:start	{room, token, url, id }	Videoconference has been initiated by the user (agent)
videoconference:otp_request	{id}	Videoconference otp request
videoconference:otp_validation	{id, verified}	Videoconference otp validation
videoconference:scheduled	{id, date}	Videoconference has been rescheduled
videoconference:end	{id}	Videoconference has ended