regulaforensics / DocumentReader-web-openapi

OpenAPI definitions of Regula Document Reader web application

Home Page:https://dev.regulaforensics.com/DocumentReader-web-openapi

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

process input params

ikliashchou opened this issue · comments

"processParam":{

"scenario":"FullProcess"
"doublePageSpread":true
"fieldTypesFilter":[8, 5] // surname & DOB
"multipageProcessing":true
"log":true
"dateFormat":"MM/dd/yyyy"
"documentIdList":[2146864762]
"resultTypeOutput":[1,15]
"disableFocusingCheck":true
"alreadyCropped":true
"imageDpiOutMax":200
}

еще могут быть

"customParams":{"ocrFree":{"mask":"DDDD DDDD DDDD","lcid":0}}}})"

"faceMetadata":[{"ID":0,"bounds":{"height":327,"width":327,"x":123,"y":218},"rollAngle":89}

"imageInputParam":{"frameBottom":1072,"frameLeft":113,"frameRight":1806,"frameTop":7,"height":1080.0,"type":254,"width":1920.0}

"recpassParam":{"docIdFilter":"-318410998"},

ProcessRequest\processParam\disableFocusingCheck

This option applies only to mobile SDK use case, in service single image processing mode it is not active, thus not described.

ProcessRequest\processParam\alreadyCropped

This option can be set to true if you know for sure that the image you provide contains already cropped document by its edges. this was designed to process on the server side images captured and cropped on mobile. false by default.

ProcessRequest\processParam\doublePageSpread

This option can be set to true if the image you provide contains double page spread of the passport and you want to process both pages in one go. It makes sense to use it for documents that have meaningful information on both pages, like Russian domestic passport, or Uzbekistan passport, or some others. false by default.

ProcessRequest\processParam\dateFormat

This option allows you to set dates format so that solution will return dates in this format. For example, if you supply "MM/DD/YYYY", and document have printed date "09 JUL 2020" for the date os issue, you will get "07/09/2020" as a result. By default it is set to system locale default (where the service is running).

closed by #11