diff --git a/index.html b/index.html index 9e7b954..dcc1bf3 100644 --- a/index.html +++ b/index.html @@ -2231,8 +2231,7 @@
https://api.regulaforensics.com/api/process

Nightly Regula document reader demo endpoint

https://nightly-api.regulaforensics.com/api/process

Local on-premise installation

http://localhost:8080/api/process

Request samples

Content type
application/json
{
  • "processParam": {
    • "lcidFilter": [ ],
    • "lcidIgnoreFilter": [ ],
    • "oneShotIdentification": true,
    • "useFaceApi": true,
    • "faceApi": {},
    • "doDetectCan": true,
    • "imageOutputMaxHeight": 0,
    • "imageOutputMaxWidth": 0,
    • "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": {
      • "brightnessThreshold": 0,
      • "dpiThreshold": 0,
      • "angleThreshold": 0,
      • "focusCheck": true,
      • "glaresCheck": true,
      • "colornessCheck": true,
      • "moireCheck": true,
      • "documentPositionIndent": 0
      },
    • "respectImageQuality": true,
    • "forceDocFormat": 0,
    • "noGraphics": true,
    • "depersonalizeLog": true,
    • "multiDocOnImage": true,
    • "shiftExpiryDate": 0,
    • "minimalHolderAge": 0,
    • "returnUncroppedImage": true,
    • "mrzFormatsFilter": [
      • "1x30"
      ],
    • "forceReadMrzBeforeLocate": true,
    • "parseBarcodes": true,
    • "convertCase": 0,
    • "splitNames": true,
    • "disablePerforationOCR": true,
    • "documentGroupFilter": [
      • 0
      ],
    • "processAuth": 0,
    • "deviceId": 0,
    • "deviceType": 0,
    • "deviceTypeHex": "string",
    • "ignoreDeviceIdFromImage": true,
    • "documentIdList": [
      • 0
      ],
    • "rfid": {
      • "paSensitiveCodesDisable": [
        • -1879048191
        ]
      },
    • "checkAuth": true,
    • "authParams": {
      • "checkLiveness": true,
      • "livenessParams": {
        • "checkOVI": true,
        • "checkMLI": true,
        • "checkHolo": true,
        • "checkED": true
        },
      • "checkUVLuminiscence": true,
      • "checkIRB900": true,
      • "checkImagePatterns": true,
      • "checkFibers": true,
      • "checkExtMRZ": true,
      • "checkExtOCR": true,
      • "checkAxial": true,
      • "checkBarcodeFormat": true,
      • "checkIRVisibility": true,
      • "checkIPI": true,
      • "checkPhotoEmbedding": true,
      • "checkPhotoComparison": true,
      • "checkLetterScreen": true
      },
    • "mrzDetectMode": 0
    },
  • "List": [
    • {
      • "light": 6,
      • "page_idx": 0,
      • "ImageData": {
        • "image": "<base64 image>"
        }
      }
    ],
  • "tag": "string",
  • "tenant": "string",
  • "env": "string",
  • "livePortrait": "Base64 encoded data",
  • "extPortrait": "Base64 encoded data",
  • "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,
  • "elapsedTime": 0
}

transaction

Reprocess

path Parameters
transactionId
required
integer <uuid>

Transaction id

-
Request Body schema: application/json
tag
string

session id

-
required
object (ProcessParams)
Array of objects (ProcessRequestImage)
livePortrait
string <base64>

Live portrait photo

+
Request Body schema: application/json
required
object (ProcessParams)
Array of objects (ProcessRequestImage)
livePortrait
string <base64>

Live portrait photo

extPortrait
string <base64>

Portrait photo from an external source

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.

@@ -2242,7 +2241,7 @@

Request samples

Content type
application/json
{
  • "tag": "string",
  • "processParam": {
    • "lcidFilter": [ ],
    • "lcidIgnoreFilter": [ ],
    • "oneShotIdentification": true,
    • "useFaceApi": true,
    • "faceApi": {},
    • "doDetectCan": true,
    • "imageOutputMaxHeight": 0,
    • "imageOutputMaxWidth": 0,
    • "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": {
      • "brightnessThreshold": 0,
      • "dpiThreshold": 0,
      • "angleThreshold": 0,
      • "focusCheck": true,
      • "glaresCheck": true,
      • "colornessCheck": true,
      • "moireCheck": true,
      • "documentPositionIndent": 0
      },
    • "respectImageQuality": true,
    • "forceDocFormat": 0,
    • "noGraphics": true,
    • "depersonalizeLog": true,
    • "multiDocOnImage": true,
    • "shiftExpiryDate": 0,
    • "minimalHolderAge": 0,
    • "returnUncroppedImage": true,
    • "mrzFormatsFilter": [
      • "1x30"
      ],
    • "forceReadMrzBeforeLocate": true,
    • "parseBarcodes": true,
    • "convertCase": 0,
    • "splitNames": true,
    • "disablePerforationOCR": true,
    • "documentGroupFilter": [
      • 0
      ],
    • "processAuth": 0,
    • "deviceId": 0,
    • "deviceType": 0,
    • "deviceTypeHex": "string",
    • "ignoreDeviceIdFromImage": true,
    • "documentIdList": [
      • 0
      ],
    • "rfid": {
      • "paSensitiveCodesDisable": [
        • -1879048191
        ]
      },
    • "checkAuth": true,
    • "authParams": {
      • "checkLiveness": true,
      • "livenessParams": {
        • "checkOVI": true,
        • "checkMLI": true,
        • "checkHolo": true,
        • "checkED": true
        },
      • "checkUVLuminiscence": true,
      • "checkIRB900": true,
      • "checkImagePatterns": true,
      • "checkFibers": true,
      • "checkExtMRZ": true,
      • "checkExtOCR": true,
      • "checkAxial": true,
      • "checkBarcodeFormat": true,
      • "checkIRVisibility": true,
      • "checkIPI": true,
      • "checkPhotoEmbedding": true,
      • "checkPhotoComparison": true,
      • "checkLetterScreen": true
      },
    • "mrzDetectMode": 0
    },
  • "List": [
    • {
      • "light": 6,
      • "page_idx": 0,
      • "ImageData": {
        • "image": "<base64 image>"
        }
      }
    ],
  • "livePortrait": "Base64 encoded data",
  • "extPortrait": "Base64 encoded data",
  • "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
{
  • "OutData": {
    • "url": "string",
    • "images": [
      • {
        • "fieldType": 201,
        • "light": 0,
        • "listIdx": 0,
        • "pageIdx": 0,
        • "url": "string"
        }
      ]
    },
  • "InData": {
    • "video": {
      • "metadata": { },
      • "url": "string"
      },
    • "images": [
      • {
        • "light": 0,
        • "listIdx": 0,
        • "pageIdx": 0,
        • "url": "string"
        }
      ]
    },
  • "tag": "string",
  • "transactionId": "75906707-8c31-479c-b354-aa805c4cefbc"
}

Get Reprocess transaction data

path Parameters
transactionId
required
integer <uuid>

Transaction id

+
http://localhost:8080/api/v2/transaction/{transactionId}/process

Request samples

Content type
application/json
{
  • "processParam": {
    • "lcidFilter": [ ],
    • "lcidIgnoreFilter": [ ],
    • "oneShotIdentification": true,
    • "useFaceApi": true,
    • "faceApi": {},
    • "doDetectCan": true,
    • "imageOutputMaxHeight": 0,
    • "imageOutputMaxWidth": 0,
    • "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": {
      • "brightnessThreshold": 0,
      • "dpiThreshold": 0,
      • "angleThreshold": 0,
      • "focusCheck": true,
      • "glaresCheck": true,
      • "colornessCheck": true,
      • "moireCheck": true,
      • "documentPositionIndent": 0
      },
    • "respectImageQuality": true,
    • "forceDocFormat": 0,
    • "noGraphics": true,
    • "depersonalizeLog": true,
    • "multiDocOnImage": true,
    • "shiftExpiryDate": 0,
    • "minimalHolderAge": 0,
    • "returnUncroppedImage": true,
    • "mrzFormatsFilter": [
      • "1x30"
      ],
    • "forceReadMrzBeforeLocate": true,
    • "parseBarcodes": true,
    • "convertCase": 0,
    • "splitNames": true,
    • "disablePerforationOCR": true,
    • "documentGroupFilter": [
      • 0
      ],
    • "processAuth": 0,
    • "deviceId": 0,
    • "deviceType": 0,
    • "deviceTypeHex": "string",
    • "ignoreDeviceIdFromImage": true,
    • "documentIdList": [
      • 0
      ],
    • "rfid": {
      • "paSensitiveCodesDisable": [
        • -1879048191
        ]
      },
    • "checkAuth": true,
    • "authParams": {
      • "checkLiveness": true,
      • "livenessParams": {
        • "checkOVI": true,
        • "checkMLI": true,
        • "checkHolo": true,
        • "checkED": true
        },
      • "checkUVLuminiscence": true,
      • "checkIRB900": true,
      • "checkImagePatterns": true,
      • "checkFibers": true,
      • "checkExtMRZ": true,
      • "checkExtOCR": true,
      • "checkAxial": true,
      • "checkBarcodeFormat": true,
      • "checkIRVisibility": true,
      • "checkIPI": true,
      • "checkPhotoEmbedding": true,
      • "checkPhotoComparison": true,
      • "checkLetterScreen": true
      },
    • "mrzDetectMode": 0
    },
  • "List": [
    • {
      • "light": 6,
      • "page_idx": 0,
      • "ImageData": {
        • "image": "<base64 image>"
        }
      }
    ],
  • "livePortrait": "Base64 encoded data",
  • "extPortrait": "Base64 encoded data",
  • "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
{
  • "OutData": {
    • "url": "string",
    • "images": [
      • {
        • "fieldType": 201,
        • "light": 0,
        • "listIdx": 0,
        • "pageIdx": 0,
        • "url": "string"
        }
      ]
    },
  • "InData": {
    • "video": {
      • "metadata": { },
      • "url": "string"
      },
    • "images": [
      • {
        • "light": 0,
        • "listIdx": 0,
        • "pageIdx": 0,
        • "url": "string"
        }
      ]
    },
  • "tag": "string",
  • "transactionId": "75906707-8c31-479c-b354-aa805c4cefbc"
}

Get Reprocess transaction data

path Parameters
transactionId
required
integer <uuid>

Transaction id

Responses

Response Schema: application/json
transactionId
integer <uuid>
tag
string
object (OutData)
object (InData)
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)
{
  • "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
      }
    ]
}