OCR Module

ready os emitted when the OCR is successfully mounted.

To listen to this event, use:

1
ocr.on('ready', () => {
2
  console.log('idv component is ready')
3
}); 

The OCR component emits a detection_complete event when it successfully detects a customer’s information. The component emits this event immediately before results. To listen to this event, use:

1
  ocr.on('detection_complete', () => {
2
    // programatically unmount your component
3
    setMounted(false);
4
  })

The component is submitting the end-user data during this event. To listen to this event, use:

1
ocr.on('success', 
2
  (checkStatus, document, entityId) => {
3
    // you can extract information emitted from success event
4
    // and use it to your own use
5
  }
6
)

where the data types for the parameters are:

1
  checkStatus: 'COMPLETE' | 'FAILED',
2
  document: Object
3
  entityId: string

checkStatus will consist of either COMPLETE or FAILED, where

• “COMPLETE”: The process and the check results are ready.
• ”FAILED”: The process completed but failed to validate the captured ID and face.

document: the document object generated after the OCR extract

entityId: FrankieOne’s internal reference for the individual

The component has run unsuccessfully. You can use custom loading spinners or additional styles to handle this event gracefully. To listen to this event, use:

1
ocr.on('detection_failed', () => {
2
// programatically unmount your component
3
setMounted(false);
4
})

1
To listen to this event, use:
2
ocr.on('input_required', (information, checkStatus) => {
3
if (checkStatus === 'WAITING_SELFIE_UPLOAD') {
4
  console.log("waiting for selfie capture")
5
}
6
})

input_required will emit the entityId and the current status of the process, such as:

• Waiting for Document upload WAITING_DOC_UPLOAD
• Waiting for selfie upload WAITING_SELFIE_UPLOAD
• Uploaded document has invalid type AWAITING_DOCUMENT_UPLOAD_INVALID_TYPE
• The process is either incomplete or interrupted INCOMPLETE / INTERRUPTED.

On error, we throw all events from the vendor back to you. To listen to this event, use:

1
ocr.on('error', (e) => {
2
console.log(e.message, e.payload)
3
})