Sample OCR Data v3.0 JSON
📘 Sample OCR Data v3.0 JSON
📄 Document Scan Sample JSON v3.0
{
"version": "3.0",
"document_info": {
"document_type_code": [12],
"document_type": ["Identity Card"],
"document_names": ["Latvia - Id Card (2012) #2"],
"field_sources": ["M", "B", "V"],
"field_locales": {
"0": "Latin",
"1062": "Latvian"
},
"field_count": 1,
"field_list": {
"0": "Document class code"
},
"document_images": {
"front_page": "<Base64 Image String>",
"back_page": "<Base64 Image String>",
"signature_image": "<Base64 Image String>",
"portrait_image": "<Base64 Image String>",
"portrait_image_source": "V",
"ghostportrait_image": "<Base64 Image String>",
"visualportrait_image": "<Base64 Image String>"
}
},
"document_status": {
"error_list": ["Expired Document"],
"warning_list": ["NFC scan cancelled by the user."],
"is_nfc_document": true,
"nfc_scan_status": "NFC SCAN BYPASSED",
"nfc_scan_status_reason": "NFC scan cancelled by the user.",
"checks_performed": [
{
"check_category": "Data Validation",
"check_name": "Mandatory Data",
"check_detail": [
{
"element": "Document class code",
"status": "OK",
"detail": "Success"
}
],
"check_status": "OK"
},
{
"check_category": "Data Compliance",
"check_name": "Date of Expiry Validation",
"check_detail": [
{
"element": "Date of expiry",
"lcidName": "Latin",
"source": "MRZ",
"status": "ERROR",
"detail": "Validity failed for Date of expiry with source type MRZ."
}
],
"check_status": "ERROR"
},
{
"check_category": "Document Authenticity",
"check_name": "Data Consistency",
"check_detail": [
{
"element": "Document number",
"lcidName": "Latin",
"source1": "VISUAL",
"source2": "BARCODE",
"status": "OK",
"detail": "Success"
}
],
"check_status": "OK"
},
{
"check_category": "Document Authenticity",
"check_name": "Hologram",
"check_detail": [
{
"element": "Photo element",
"etalon_image": "",
"actual_image": "",
"match_percentage": "0",
"status": "NOT DONE",
"detail": "Document verification timeout has expired"
}
],
"check_status": "NOT DONE"
},
{
"check_category": "Document Authenticity",
"check_name": "Barcode",
"check_detail": [
{
"element": "Barcode",
"status": "OK",
"detail": "No errors"
}
],
"check_status": "OK"
},
{
"check_category": "Document Authenticity",
"check_name": "Image Pattern",
"check_detail": [
{
"element": "Blank element",
"etalon_image": "<Base64 Image String>",
"actual_image": "<Base64 Image String>",
"match_percentage": "97",
"status": "OK",
"detail": "No errors"
}
],
"check_status": "OK"
}
],
"overall_document_status": "ERROR"
},
"identity_data": {
"Document class code": "I"
},
"identity_data_details": {
"0": [
{
"field_name": "Document class code",
"field_details": {
"field_value": "I",
"field_status": "OK",
"field_source_and_values": {
"M": "I"
}
}
}
],
"1062": [
{
"field_name": "Document class code",
"field_details": {
"field_value": "es",
"field_status": "OK",
"field_source_and_values": {
"V": "es"
}
}
}
]
},
"raw_data": null
}
📋 12.7.2 Sample JSON v3.0 – Field Details
Field | Type | Description |
---|---|---|
version | string | IDV JSON version. Always "3.0" in this context. |
document_info | object | Metadata about the scanned document. |
document_type_code | array | Internal numeric codes indicating type and pages of document. |
field_sources | array | Sources like M (MRZ), B (Barcode), V (Visual). |
field_locales | object | Language locale codes and names. E.g., "1062": "Latvian" . |
document_images | object | Base64-encoded document images (front, back, selfie, etc.). |
document_status | object | Result of scan, errors, NFC details, and validation checks. |
error_list / warning_list | array | Errors/warnings encountered during scan. |
is_nfc_document | boolean | Whether document has an NFC chip. |
nfc_scan_status | string | NFC scan result (e.g., "NFC SCAN UNSUPPORTED BY DEVICE" ). |
checks_performed | array | Checks like "Mandatory Data", "Hologram", etc., with statuses. |
overall_document_status | string | "OK" , "WARNING" , or "ERROR" – final document scan result. |
identity_data | object | Flattened, key-value extracted data. |
identity_data_details | object | Locale-wise detailed extraction with per-field source and status. |
Updated 3 months ago