identityfront-scanner v0.0.1
IdentityFront Capturing WebComponent
The IdentityFront Capture WebComponent was created to make it easy to embed the IdentityFront capture experience into your web applications. This component captures video and photos of individuals, the associated biometric features as well as identity documents and their features.
Additionally, when these identity documents contain machine-readable zones such as barcodes and MRZs it is able to extract the encoded information such as legal name, document id, country, and birthday making it easy to pre-fill forms based on this data. The component works 100% client side however for access to the videos and photos, rich text extraction or analysis of the captured data you need to use the IdentityFront service.
There are a number of benefits gained by performing all capture locally and having the ability to do extraction without the involvement of the IdentityFront service. First, you can help reduce user input errors by leveraging the their own identity documents while speeding up filling out the associated forms. Secondly the by performing the capture associated computer vision and machine learning on the client side we can deliver a fast and fluid user experience and reduce user input errors relating to low quality captures while performing basic verification that the documents submitted meet the associated requirements.
Quick example embed web component in to you application
<if-id-scanner
id="if-capturing-wc"
evidences="id-card"
/>
Then in js you can access to component lifecycle events
const IFCapture = document.getElementById('if-capturing-wc');
IFCapture.addEventListener('onCaptureSuccess', (result) => {
console.log(result)
});
IFCapture.addEventListener('onCaptureFail', (error) => {
console.log(error)
});
Example success response
{
"evidences": [
{
"type": "id-card",
"side": "front",
"features": [
{
"type": "face",
"confidence": 89,
"image": "base64_str"
}
]
}, {
"type": "id-card",
"side": "back",
"features": [
{
"type": "mrz",
"confidence": 91,
"image": "base64_str",
"parsed": "parsed_mrz_object"
}
]
}
]
}
Features Description
- Capturing identity document
- Localization of Face, MRZ on identity document
- Capture face
API Description
Properties
Name | Type | Description | Default |
---|---|---|---|
evidences | string | This property allow to limit a type of evidences to be captured, for example if you need capture only passport you can use passport , or you may allow both passport and id card with passport, id-card | passport, id-card, selfie, id-document |
timeout | number | If user doesn't provide an evidence along to timeout of we can't localize it by some reason like webcam quality problem or low light environment then capturing flow will failed with TimeoutError | 30 |
documentMRZ | boolean | Enable detecting and extracting MRZ | false |
Events
Name | Description |
---|---|
onCaptureStart | Fires once user start capturing |
onCaptureSuccess | Fires if capturing flow completed successfully and we able to find evidences on video |
onCaptureFail | Fires if at least one of required evidences was failed to detect |
onEvidenceSuccess | Fires once user successfully captured one of required evidence |
onEvidenceFail | Fires due to timeout or we can't find evidences on a video. |
Roadmap
- Encrypt evidence prior to sending to service
- Bank check scanning
- Localization of another identity document features such us (Signature, Text fields, Barcodes, Country)
- Parsing of barcodes
- Liveness detection
4 years ago