Guidelines

System Messages

These messages are posted via postMessage to the parent of the SDK iframe. The best practice to classify these messages are only through subject of each message.

Camera.NotFound

This message will be posted when the browser doesn't detect any video input.

{
  "subject": "Camera.NotFound",
  "data": {
    "message": "Camera not Found"
  }
}

Camera.PermissionDenied

This message will be posted when the user denies a camera permission request.

{
  "subject": "Camera.PermissionDenied",
  "data": {
    "message": "Please allow camera permission to continue the process."
  }
}

Internal.*

This message will be posted when there is any exception thrown internally by the SDK.

{
  "subject": "Internal.${EXCEPTION_NAME}",
  "data": {
    "message": EXCEPTION_MESSAGE
  }
}

📘

Note

  • ${EXCEPTION_NAME} is the exception name thrown internally.
  • EXCEPTION_MESSAGE is the exception message thrown internally.

LicenseVerification.Undefined

This message will be posted when SDK built with wrong License ID or Public Key or without License ID or Public Key.

{
  "subject": "LicenseVerification.Undefined",
  "data": {
    "message": "SDK is built with wrong ${license} or without ${license}"
  }
}

📘

Note

The ${license} is either license ID or public key.

LicenseVerification.Error

This message will be posted when license service failed to validate license.

{
  "subject": "LicenseVerification.Error",
  "data": {
    "message": "License service error"
  }
}

LicenseVerification.Invalid

This message will be posted when license does not match with response from license service. License may already expired or wrong license type. 

{
  "subject": "LicenseVerification.Invalid",
  "data": {
    "message": "License does not matched. License may already expired or wrong license type."
  }
}

LicenseVerification.Success

This message will be posted when license verification success.

{
  "subject": "LicenseVerification.Success",
  "data": {
    "message": "License verification success."
  }
}

OCR.Cancelled

This message will be posted when OCR process cancelled by user.

{
  "subject": "OCR.Cancelled",
  "data": {
    "message": "User cancelled the OCR process."
  }
}

OCR.OutOfChance

This message will be posted when OCR process reached maximum amount of attempt.

{
  "subject": "OCR.OutOfChance",
  "data": {
    "message": "User reached the maximum amount of attempt."
  }
}

Verification.Success

This message will be posted when the whole liveness process is finished.

{
  "subject": "Verification.Success",
  "data": {
    "image": {
      "url": string,
    },
    "city": string,
    "nik": string,
    "full_name": string,
    "place_of_birth": string,
    "date_of_birth": string,
    "gender": string,
    "blood_type": string,
    "religion": string,
    "address": string,
    "rt_rw": string,
    "district": string,
    "administrative_village": string,
    "marital_status": string,
    "occupation": string,
    "nationality": string,
    "province": string,
  }
}

Updated 5 months ago