Skip to main content

Type of Logs

IDNotDetected

Description:

This event is called if the ID is not detected.

Payload: The payload is going to be an empty object

Example:

{
type: 'IDNotDetected',
payload: {
message: 'Couldn\'t capture.'
}
}

nothingHappened

Description:

This event is called when nothing is detected within 5 seconds.

Payload:

NameTypeDescription
messageStringError message

Example:

{
type: 'nothingHappened',
payload: {
message: "Couldn't capture. Try moving somewhere else."
}
}

manualCaptureOn

Description:

This event is called if the timeout for autodetect is over and manual capture is needed.

Example:

{
type: 'manualCaptureOn',
payload: {}
}

noAttemps

Description:

This event is called if the user has no more attempts to upload the ID.

Payload:

NameTypeDescription
responseObjectServer response
messageStringError message

Example:

{
type: 'noAttemps',
payload: {
response: {},
message: "No attempt left",
}
}

successCapture

Description:

This event is called if the capture of the ID was successful. The payload will contain the server response.

Payload:

NameTypeDescription
responseObjectServer response

Example:

{
type: 'successCapture',
payload: {
response: {}
}
}

attemptFailed

Description:

This event is called when the upload of the ID has failed.

Payload:

NameTypeDescription
responseObjectServer response
messageStringError message
reasonStringA key for the error. It can be: `'classificationFailed''lowSharpness''glareDetected'`
attemptNumberNumber of the attempt

Example:

{
type: 'attemptFailed',
payload: {
response: {},
message: "Classification failed",
reason: "classificationFailed",
attemp: 1
}
}

selfieTimeout

Description:

This event is called when the timeout for a selfie is over.

Payload:

NameTypeDescription
messageStringError message

Example:

{
type: 'selfieTimeout',
payload: {
message: 'No face found'
}
}

faceNotDetected

Description:

This event is called if no face is detected while capturing the image for selfie.

Payload:

NameTypeDescription
messageStringError message

Example:

{
type: 'selfieTimeout',
payload: {
message: 'Face was not found'
}
}

multipleFacesDetected

Description:

This event is called if more than one face is detected in the image capture for selfie.

Payload:

NameTypeDescription
messageStringError message

Example:

{
type: 'multipleFacesDetected',
payload: {
message: 'More than one face detected'
}
}

cropTooSmall

Description:

This event is called if the crop of the face is too small in the image capture for selfie.

Payload:

NameTypeDescription
messageStringError message

Example:

{
type: 'cropTooSmall',
payload: {
message: 'Crop is too small'
}
}

imageNotPortrait

Description:

This event is called if the width of the captured image for selfie is greater than its heigth.

Payload:

NameTypeDescription
messageStringError message

Example:

{
type: 'imageNotPortrait',
payload: {
message: 'Image is not portrait'
}
}

InternalServerError

Description:

This event is called if there is an internal server error.

Payload:

NameTypeDescription
messageStringError message

Example:

{
type: 'InternalServerError',
payload: {
message: 'Error. Try again.'
}
}

skip

Description:

This event is called if there is an internal server error.

Payload:

NameTypeDescription
existingUserBooleanIndicates if the user already exists
livenessNumberLiveness value
faceMatchBooleanIndicates if the faces match
imageBase64StringImage

Example:

{
type: 'skip',
payload: {
existingUser: true,
liveness: 0,
faceMatch: true,
imageBase64: ''
}
}

spoofAttempt

Description:

This event is called when there is an image of a person in the image capture.

Payload:

NameTypeDescription
responseObjectServer response
messageStringError message

Example:

{
type: 'spoofAttempt',
payload: {
message: "Spoof attempt detected",
}
}

success

Description:

This event is called when an image uploads succesfully.

Payload:

NameTypeDescription
responseObjectServer response
messageStringError message

Example:

{
type: 'success',
payload: {
message: "Selfie uploaded successfully",
}
}

tooFar

Description:

This event is called if the user is too far away from the camera.

Payload:

NameTypeDescription
messageStringInfo message

Example:

{
type: 'tooFar',
payload: {
message: "Move closer",
}
}

dontMove

Description:

This event is called when a face is detected while photo is being taken.

Payload:

NameTypeDescription
messageStringInfo message

Example:

{
type: 'dontMove',
payload: {
message: "Don't move!",
}
}

permissionDenied

Description:

This event is called when the user denies access permission for the camera.

Payload:

NameTypeDescription
messageStringInfo message

Example:

{
type: 'permissionDenied',
payload: {
message: "User denied to use camera.",
}
}

OSVersionNotSupported

Description:

This event is called if OS version is too old or not supported.

Payload:

NameTypeDescription
messageStringInfo message

Example:

{
type: 'OSVersionNotSupported',
payload: {
message: "OS version is not supported.",
}
}

browserNotSupported

Description:

This event is called if the browser is not supported.

Payload:

NameTypeDescription
messageStringInfo message

Example:

{
type: 'browserNotSupported',
payload: {
message: "Browser is not supported.",
}
}

otpSuccess

Description:

This event is called if the user enters the correct OTP.

Payload:

NameTypeDescription
messageStringInfo message

Example:

{
type: 'otpSuccess',
payload: {
message: "Correct OTP.",
}
}

otpFailure

Description:

This event is called if the user enters the incorrect OTP 3 times.

Payload:

NameTypeDescription
messageStringInfo message

Example:

{
type: 'otpFailure',
payload: {
message: "Invalid OTP.",
}
}

conferenceSuccess

Description:

This event is called when conference host approves, denies or closes the conference.

Payload:

NameTypeDescription
messageStringInfo message. Can be approved | denied | closed

Example:

{
type: 'conferenceSuccess',
payload: {
message: "denied",
}
}

conferenceClosed

Description:

This event is called when the conference is closed from the client side.

Payload:

NameTypeDescription
messageStringInfo message. Can be finished | error. Studying more cases.

Example:

{
type: 'conferenceClosed',
payload: {
sessionFinishedReason: {
selectedOption: {
label: 'Interview completed',
selected: true,
}
},
dataConfirmation: {
name: true,
birthDate: true,
gender: false,
},
captureChecks: {
selfie: true,
}
}
}

conferenceFailed

Description:

This event is called if no connection could be established.

Payload:

NameTypeDescription
messageStringInfo message.

Example:

{
type: 'conferenceFailed',
payload: {
message: "No connection could be established.",
}
}

clientDisconnected

Description:

This event is called if the client clicks the disconnect button in the waiting room.

Payload:

NameTypeDescription
messageStringInfo message.

Example:

{
type: 'clientDisconnected',
payload: {
message: "Client clicked disconnect in waiting room",
}
}

clientClickedDisconnect

Description:

This event is called when the client clicks the disconnect button after the executive accepts the video conference.

Payload:

NameTypeDescription
messageStringInfo message.

Example:

{
type: 'clientClickedDisconnect',
payload: {
message: "Client clicked disconnect after executive accepted videoconference",
}
}

conferenceSignalFailed

Description:

This event is called if the signal session fails to connect.

Payload:

NameTypeDescription
messageStringInfo message.

Example:

{
type: 'conferenceSignalFailed',
payload: {
message: "Failed to connect singal session",
}
}

signal-connect

Description:

This event is called if the signal session fails to connect.

Payload:

NameTypeDescription
messageStringSuccess.

Example:

{
type: 'signal-connect',
payload: {
success: true,
}
}

clientClickedConnect

Description:

This event is called if the signal session fails to connect.

Payload:

NameTypeDescription
messageStringInfo message.

Example:

{
type: 'clientClickedConnect',
payload: {
message: "Client clicked connect after executive accepted videoconference",
}
}

executiveDisconnected

Description:

This event is called if the executive disconnects for any unhandled reason.

Payload:

NameTypeDescription
messageStringInfo message.

Example:

{
type: 'executiveDisconnected',
payload: {
message: "Executive disconnected",
}
}

networkTest-failedTests

Description:

This event is called if the network tests fail.

Payload:

NameTypeDescription
messageStringInfo message.

Example:

{
type: 'networkTest-failedTests',
payload: {
reason: "User has no device available to connect",
}
}

executiveReady

Description:

This event is called if the executive accepts the call and is ready for the conference.

Payload:

NameTypeDescription
messageStringInfo message.

Example:

{
type: 'executiveReady',
payload: {
message: "Executive is ready to take videocall",
}
}

conferenceConnected

Description:

This event is called when the conference connects successfully.

Payload:

NameTypeDescription
messageStringInfo message.

Example:

{
type: 'conferenceConnected',
payload: {
message: "Conference successfully connected",
}
}

clientClickedDisconnectOnSupport

Description:

This event is called when the client clicks disconnect while in the conference.

Payload:

NameTypeDescription
messageStringInfo message.

Example:

{
type: 'clientClickedDisconnectOnSupport',
payload: {
message: "Client clicked disconnects while being in conference",
}
}