Regula Document Reader Web API (6.3.0)

Documents recognition as easy as reading two bytes.

Clients:

  • JavaScript client for the browser and node.js based on axios
  • Java client compatible with jvm and android
  • Python 3.5+ client
  • C# client for .NET & .NET Core

process

Everything about perfoming request and parsing response

Process list of documents images and return extracted data

Request Body schema: application/json
tag
string

session id

required
object (ProcessParams)
Array of objects (ProcessRequestImage) [ items ]
object (ContainerList)

List with various objects, containing processing results

object (ProcessSystemInfo)
object

Free-form object to be included in response. Must be object, not list or simple value. Do not affect document processing. Use it freely to pass your app params. Stored in process logs.

Responses

Response Schema: application/json
ChipPage
integer (RfidLocation)
Enum: 0 1 2

Determines the presence and location of an RFID chip in a document. 0 - no rfid chip; 1 - chip is located in the document data page; 2 - chip is located in the back page or inlay of the document

ProcessingFinished
required
integer (ProcessingStatus)
Enum: 0 1 2
required
object (ContainerList)

List with various objects, containing processing results

required
object (TransactionInfo)
log
string

Base64 encoded transaction processing log

object

Free-form object provided in request. See passBackObject property of ProcessRequest.

morePagesAvailable
integer

Request samples

Content type
application/json
{
  • "tag": "string",
  • "processParam": {
    • "scenario": "Mrz",
    • "resultTypeOutput": [
      • 1
      ],
    • "doublePageSpread": true,
    • "generateDoublePageSpreadImage": true,
    • "fieldTypesFilter": [
      • 0
      ],
    • "dateFormat": "MM/dd/yyyy",
    • "measureSystem": 0,
    • "imageDpiOutMax": 0,
    • "alreadyCropped": true,
    • "customParams": { },
    • "config": [
      • {
        • "docID": [
          • 0
          ],
        • "excludeAuthChecks": 2
        }
      ],
    • "log": true,
    • "logLevel": "FatalError",
    • "forceDocID": 0,
    • "matchTextFieldMask": true,
    • "fastDocDetect": true,
    • "updateOCRValidityByGlare": true,
    • "checkRequiredTextFields": true,
    • "returnCroppedBarcode": true,
    • "imageQa": {
      • "dpiThreshold": 0,
      • "angleThreshold": 0,
      • "focusCheck": true,
      • "glaresCheck": true,
      • "colornessCheck": true,
      • "moireCheck": true
      },
    • "respectImageQuality": true,
    • "forceDocFormat": 0,
    • "noGraphics": true,
    • "documentAreaMin": 0,
    • "depersonalizeLog": true,
    • "multiDocOnImage": true,
    • "shiftExpiryDate": 0,
    • "minimalHolderAge": 0,
    • "returnUncroppedImage": true,
    • "mrzFormatsFilter": [
      • "1x30"
      ],
    • "forceReadMrzBeforeLocate": true,
    • "parseBarcodes": true,
    • "convertCase": 0,
    • "splitNames": true,
    • "disablePerforationOCR": true,
    • "documentGroupFilter": [
      • 0
      ]
    },
  • "List": [
    • {
      • "light": 6,
      • "page_idx": 0,
      • "ImageData": {
        • "image": "<base64 image>"
        }
      }
    ],
  • "ContainerList": {
    • "Count": 0,
    • "List": [
      • {
        • "Status": {
          • "overallStatus": 0,
          • "optical": 0,
          • "portrait": 0,
          • "rfid": 0,
          • "stopList": 0,
          • "detailsRFID": {
            },
          • "detailsOptical": {
            }
          },
        • "buf_length": 0,
        • "light": 0,
        • "list_idx": 0,
        • "page_idx": 0,
        • "result_type": 0
        }
      ]
    },
  • "systemInfo": {
    • "license": "string",
    • "recaptcha_token": "string"
    },
  • "passBackObject": { }
}

Response samples

Content type
application/json
{
  • "ChipPage": 0,
  • "ProcessingFinished": 0,
  • "ContainerList": {
    • "Count": 0,
    • "List": [
      • {
        • "Status": {
          • "overallStatus": 0,
          • "optical": 0,
          • "portrait": 0,
          • "rfid": 0,
          • "stopList": 0,
          • "detailsRFID": {
            },
          • "detailsOptical": {
            }
          },
        • "buf_length": 0,
        • "light": 0,
        • "list_idx": 0,
        • "page_idx": 0,
        • "result_type": 0
        }
      ]
    },
  • "TransactionInfo": {
    • "ComputerName": "7cded6852d20",
    • "DateTime": "2020-05-27T08:17:03.247Z",
    • "TransactionID": "dc5eb444-ad6e-4ebc-8102-d62d5bb56a4e",
    • "UserName": "user"
    },
  • "log": "string",
  • "passBackObject": { },
  • "morePagesAvailable": 0
}

Status Model

overallStatus
required
integer (CheckResult)
Enum: 0 1 2

0 - result is negative; 1 - result is positive; 2 - сheck was not performed

optical
required
integer (CheckResult)
Enum: 0 1 2

0 - result is negative; 1 - result is positive; 2 - сheck was not performed

portrait
integer (CheckResult)
Enum: 0 1 2

0 - result is negative; 1 - result is positive; 2 - сheck was not performed

rfid
integer (CheckResult)
Enum: 0 1 2

0 - result is negative; 1 - result is positive; 2 - сheck was not performed

stopList
integer (CheckResult)
Enum: 0 1 2

0 - result is negative; 1 - result is positive; 2 - сheck was not performed

object (detailsRFID)
required
object (detailsOptical)
{
  • "overallStatus": 0,
  • "optical": 0,
  • "portrait": 0,
  • "rfid": 0,
  • "stopList": 0,
  • "detailsRFID": {
    • "overallStatus": 0,
    • "AA": 0,
    • "BAC": 0,
    • "CA": 0,
    • "PA": 0,
    • "PACE": 0,
    • "TA": 0
    },
  • "detailsOptical": {
    • "overallStatus": 0,
    • "docType": 0,
    • "expiry": 0,
    • "imageQA": 0,
    • "mrz": 0,
    • "pagesCount": 0,
    • "security": 0,
    • "text": 0
    }
}

Text Model

status
required
integer (CheckResult)
Enum: 0 1 2

0 - result is negative; 1 - result is positive; 2 - сheck was not performed

validityStatus
required
integer (CheckResult)
Enum: 0 1 2

0 - result is negative; 1 - result is positive; 2 - сheck was not performed

comparisonStatus
required
integer (CheckResult)
Enum: 0 1 2

0 - result is negative; 1 - result is positive; 2 - сheck was not performed

required
Array of objects (TextField) [ items ]
required
Array of objects (TextAvailableSource) [ items ]
{
  • "status": 0,
  • "validityStatus": 0,
  • "comparisonStatus": 0,
  • "fieldList": [
    • {
      • "fieldType": 0,
      • "fieldName": "string",
      • "lcid": 0,
      • "status": 0,
      • "validityStatus": 0,
      • "comparisonStatus": 0,
      • "value": "string",
      • "valueList": [
        • {
          • "source": "MRZ",
          • "value": "string",
          • "originalValue": "string",
          • "originalSymbols": [
            ],
          • "pageIndex": 0,
          • "probability": 100,
          • "fieldRect": {
            },
          • "rfidOrigin": {
            }
          }
        ],
      • "validityList": [
        • {
          • "source": "MRZ",
          • "status": 0
          }
        ],
      • "comparisonList": [
        • {
          • "sourceLeft": "MRZ",
          • "sourceRight": "MRZ",
          • "status": 0
          }
        ]
      }
    ],
  • "availableSourceList": [
    • {
      • "source": "MRZ",
      • "validityStatus": 0,
      • "containerType": 0
      }
    ]
}

Images Model

Images model:

required
Array of objects (ImagesAvailableSource) [ items ]
required
Array of objects (ImagesField) [ items ]
{
  • "availableSourceList": [
    • {
      • "containerType": 0,
      • "source": "MRZ"
      }
    ],
  • "fieldList": [
    • {
      • "fieldName": "string",
      • "fieldType": 201,
      • "valueList": [
        • {
          • "source": "MRZ",
          • "value": "Base64 encoded image",
          • "originalValue": "Base64 encoded image",
          • "pageIndex": 0,
          • "lightIndex": 0,
          • "containerType": 0,
          • "fieldRect": {
            },
          • "rfidOrigin": {
            }
          }
        ]
      }
    ]
}

Document image model:

object DocumentImage Recursive
{
  • "image": "Base64 encoded image"
}

Document Model

Choosen Document model:

object ChosenDocumentType Recursive
{
  • "DocumentName": "string",
  • "ID": 0,
  • "P": 0.9913095831871032,
  • "RFID_Presence": 0,
  • "FDSIDList": {
    • "ICAOCode": "str",
    • "List": [
      • 0
      ],
    • "dType": 0,
    • "dFormat": 0,
    • "dMRZ": true,
    • "dDescription": "string",
    • "dYear": "string",
    • "dCountryName": "string",
    • "dStateCode": "string",
    • "dStateName": "string"
    },
  • "NecessaryLights": 0,
  • "CheckAuthenticity": 0,
  • "UVExp": 0,
  • "AuthenticityNecessaryLights": 0
}

Candidates model:

object DocumentTypesCandidates Recursive
{
  • "RecResult": 0,
  • "Candidates": [
    • {
      • "DocumentName": "string",
      • "ID": 0,
      • "P": 0.9913095831871032,
      • "RFID_Presence": 0,
      • "FDSIDList": {
        • "ICAOCode": "str",
        • "List": [
          • 0
          ],
        • "dType": 0,
        • "dFormat": 0,
        • "dMRZ": true,
        • "dDescription": "string",
        • "dYear": "string",
        • "dCountryName": "string",
        • "dStateCode": "string",
        • "dStateName": "string"
        },
      • "NecessaryLights": 0,
      • "CheckAuthenticity": 0,
      • "UVExp": 0,
      • "AuthenticityNecessaryLights": 0
      }
    ]
}

Authenticity Model

Type
required
integer (AuthenticityResultType)
Enum: 1 2 4 8 16 32 64 128 512 4096 8192 32768 65536 131072 262144

Enumeration describes available authenticity checks

Result
required
integer (CheckResult)
Enum: 0 1 2

0 - result is negative; 1 - result is positive; 2 - сheck was not performed

required
Array of Security Feature Check (object) or Ident Check (object) or Fibers Check (object) or OCR Security Text Check (object) or Photo Ident Check (object)[ items ]
{
  • "Type": 1,
  • "Result": 0,
  • "List": [
    • {
      • "Type": 0,
      • "ElementResult": 0,
      • "ElementDiagnose": 0,
      • "ElementType": 0,
      • "ElementRect": {
        • "left": 0,
        • "top": 0,
        • "right": 0,
        • "bottom": 0
        },
      • "Visibility": 0,
      • "CriticalFlag": 0,
      • "AreaList": [
        • {
          • "Count": 0,
          • "List": [
            ],
          • "Points": [
            ]
          }
        ],
      • "Reserved2": 0
      }
    ]
}