OCR Template Creator Instructions
This guide discusses the FaceTec OCR Template Creator and associated features.
Overview
The OCR Template Creator allows you to extract the text fields from an image of any type of Identity Document or Corroborating Document.
Once you create an ID Template, you can download and install the ID Template into your FaceTec Server instance.
ID Holder Privacy & PII
- The ID Template Creator is a web tool that allows Customers & Partners to upload images of real ID Documents to your FaceTec Developer Account and mark them up for OCR support.
- FaceTec will never sell or share the Document Image Data you upload with any 3rd party.
- The OCR Templates created can be downloaded and installed in your FaceTec Server, which runs on Your Servers, not FaceTec's.
- These OCR Templates you download DO NOT contain ANY Image Data or PII.
- The Images you upload may be viewed by FaceTec staff and will be used to improve the OCR system or create Official OCR Templates.
- By using the Template Creator you agree to all of the above terms, the Terms & Conditions, Site Privacy Policy, SDK Privacy Policy, and the Template Creator Privacy Policy.
Instructions For Using Official Templates
The FaceTec Server ships with 2,300+ Official Templates that are all enabled by default.
If you would like to utilize a subset of the Official Template, follow these instructions:
Decide which ID Documents you would like to support for OCR.
If FaceTec has an Official Template in the FaceTec Server for these IDs, just gather these Template Files, and delete the unused ones.
You can also find and download OCR Templates by using the Template Creator and using the right-most dropdown box, which contains the latest Official Templates.
Gather your Downloaded Templates.
To install templates into the FaceTec Server, place all Templates in a folder, and update the config.yaml file to specify a valid and reachable
ocrTemplatesRootDirectorywhere the templates should be loaded from.
Important Note: OCR is enabled by default and is using the 2,300+ Official Templates supported by FaceTec.
If the ID Type you would Like to Scan is not listed in our Official OCR Templates list, you can use the OCR Template Creator to Create a New Template. You can either Create a New Template from scratch, or load an existing template, and use it as a starting point to update or improve your template.
Settings
Passport - Toggle this if the OCR Template is for a Passport with an MRZ.
Enable NFC (All Documents except Passport) - Toggle this if the Template is for a Document with an MRZ and an RFID chip that can be scanned via NFC.
Disable NFC (Passport Only) - Toggle this if the Template is for a Passport, but the MRZ or RFID chip is missing or cannot be scanned via NFC.
Vertical ID - Toggle this if the ID you are using is a Vertical ID.
Non-ID Document - Toggle this if the OCR Template is for a Non-ID Document (e.g. Utility Bill, Tax Documentation, Birth Certificate, etc.).
Optimizing Performance
- Field Content Rects are required to specify what text fields exist where on the document.
- For optimal performance specify exact Field Data Type Formats. This helps the FaceTec OCR Engine achieve better success when OCRing data from your document.
- For optimal performance, mark BOTH the Field Label AND the Field Designator. This helps the FaceTec OCR Engine better understand where the field is on the document.
- The FaceTec Server ships with all 500+ Templates and enables them by default. While you will get good performance on all Document Types with this, you can further tune performance by ONLY enabling the Templates that you are going to accept. For instance, if you are only going to accept 5 different ID Types, you will achieve better performance installing ONLY those Templates as this will inform the FaceTec OCR Engine that there is a smaller set of possibilities that an incoming ID Scan can be.
Known Behaviors and Caveats
- In future releases of the FaceTec SDK, we will be improving all Algorithms involved in the ID Scan & OCR process. This may require you to re-download Templates in future versions of the FaceTec Server. You WILL NOT have to recreate your templates. We understand that this could require effort on your part during upgrades, and we are working on ways that Templates can be updated and installed automatically, as well as a UI that will allow you to Download more than one Template at a time.
Document Upload Requirements
- Uploaded ID Text MUST be upright. Uploading IDs in sideways orientation is not supported (sideways orientation means the text is not readable and is at a 90/180/270-degree rotation).
- Uploaded IDs MUST have all 4 corners of the ID visible in the image.
Future Features & Performance Improvements
We are working on the features below and they will be coming soon:
- Specifying multiple templates to Download and install at once, rather than searching
- Specifying customer rules like requiring certain text to be present, or rejecting if certain text is present.
- Ability to load multiple images per ID Type, which will improve the accuracy of the ID Type detection.
- Barcode Scan
- Passport NFC Chip Scan
- Photo ID Anti-Tampering/Editing AI
- Much More!
Example OCR Results
Below is an example of the ocrResults object, accessible to you inside the FaceTec Server, and exposed in the Photo ID Match section of the FaceTec Server Dashboard. Please note: The groups and fields returned are determined by the Template scanned. Templates that include more or fewer fields will have different JSON properties that can be gathered.
{
"ocrResults": {
"templateName": "United States (California) - Driver License",
"templateType": "Driver License",
"scanned": {
"groups": [
{
"fields": [
{
"fieldKey": "firstName",
"value": "JANE"
},
{
"fieldKey": "lastName",
"value": "DOE"
},
{
"fieldKey": "dateOfBirth",
"value": "01/07/1990"
}
],
"groupFriendlyName": "Your Information",
"groupKey": "userInfo"
},
{
"fields": [
{
"fieldKey": "dateOfExpiration",
"value": "01/07/2024"
},
{
"fieldKey": "dateOfIssue",
"value": "12/71/2019"
},
{
"fieldKey": "idNumber",
"value": "Y0001337"
}
],
"groupFriendlyName": "Photo ID Details",
"groupKey": "idInfo"
},
{
"fields": [
{
"fieldKey": "address1",
"value": "1337 RIVIERA DR"
},
{
"fieldKey": "address2",
"value": "SAN DIEGO. CA 92109"
}
],
"groupFriendlyName": "Your Address",
"groupKey": "addressInfo"
}
]
},
"userConfirmed": {
"groups": [
{
"fields": [
{
"fieldKey": "firstName",
"value": "JANE"
},
{
"fieldKey": "lastName",
"value": "DOE"
},
{
"fieldKey": "dateOfBirth",
"value": "01/07/1990"
}
],
"groupFriendlyName": "Your Information",
"groupKey": "userInfo"
},
{
"fields": [
{
"fieldKey": "dateOfExpiration",
"value": "01/07/2024"
},
{
"fieldKey": "dateOfIssue",
"value": "12/71/2019"
},
{
"fieldKey": "idNumber",
"value": "Y0001337"
}
],
"groupFriendlyName": "Photo ID Details",
"groupKey": "idInfo"
},
{
"fields": [
{
"fieldKey": "address1",
"value": "1337 RIVIERA DR"
},
{
"fieldKey": "address2",
"value": "SAN DIEGO. CA 92109"
}
],
"groupFriendlyName": "Your Address",
"groupKey": "addressInfo"
}
]
}
}
}