logo
API docs by Redocly

Regula Document Reader Web API (9.5.895)

Fast and reliable identity document verification for on-premises installation or cloud integration.

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

Documentation

Go to Regula Developer Documentation to read the technologies description, licensing information, release notes, and instructions on the integration, installation, migration, etc.

Technical Support

To submit a request to the Support Team, visit Regula Help Center.

Business Enquiries

To discuss business opportunities, fill the Enquiry Form and specify your scenarios, applications, and technical requirements.

process

Everything about performing request and parsing response

Process list of documents images and return extracted data

header Parameters
X-RequestID
string

It allows the client and server to correlate each HTTP request. HTTP requests with an identifier are sent from the client to the server and back again.

Request Body schema: application/json
required
object (ProcessParams)
Array of objects (ProcessRequestImage)
tag
string

Session ID

tenant
string

Customer name

env
string

Environment type

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.

dtc
string

Digital Travel Credential (DTC-VC) data in base64 format for processing

ImageUrls
Array of strings

URLs to the document images for processing.

Responses

Response Schema: application/json
ChipPage
required
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

CoreLibResultCode
integer
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
required
integer
elapsedTime
required
integer

Time the document processing has taken, ms.

object

Request samples

Content type
application/json
{
  • "processParam": {
    • "generateDTCVC": true,
    • "lcidFilter": [
      • 0
      ],
    • "lcidIgnoreFilter": [
      • 0
      ],
    • "oneShotIdentification": true,
    • "useFaceApi": true,
    • "faceApi": {
      • "url": "https://faceapi.regulaforensics.com",
      • "mode": "match",
      • "search": {
        • "limit": 0,
        • "threshold": 0,
        • "group_ids": [
          • "string"
          ]
        },
      • "threshold": 75,
      • "serviceTimeout": 3000,
      • "proxy": "http://localhost:8080",
      • "proxy_userpwd": "user:pass",
      • "proxy_type": 0,
      • "childAgeThreshold": 13,
      • "childDocValidityYears": 5
      },
    • "doDetectCan": true,
    • "imageOutputMaxHeight": 0,
    • "imageOutputMaxWidth": 0,
    • "scenario": "Mrz",
    • "resultTypeOutput": [
      • 1
      ],
    • "doublePageSpread": true,
    • "generateDoublePageSpreadImage": true,
    • "fieldTypesFilter": [
      • 0
      ],
    • "fieldTypesIgnoreFilter": [
      • 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,
      • "expectedPass": [
        • "glaresCheck"
        ],
      • "glaresCheckParams": {
        • "imgMarginPart": 0.35,
        • "maxGlaringPart": 0
        }
      },
    • "strictImageQuality": true,
    • "respectImageQuality": true,
    • "forceDocFormat": -1,
    • "noGraphics": true,
    • "depersonalizeLog": true,
    • "multiDocOnImage": true,
    • "shiftExpiryDate": 0,
    • "minimalHolderAge": 0,
    • "returnUncroppedImage": true,
    • "mrzFormatsFilter": [
      • "1x30"
      ],
    • "parseBarcodes": true,
    • "convertCase": 0,
    • "splitNames": true,
    • "disablePerforationOCR": true,
    • "documentGroupFilter": [
      • 0
      ],
    • "processAuth": 0,
    • "deviceId": 0,
    • "deviceType": 0,
    • "deviceTypeHex": "string",
    • "ignoreDeviceIdFromImage": true,
    • "documentIdList": [
      • 0
      ],
    • "rfid": {
      • "paIgnoreNotificationCodes": [
        • 2415919105
        ]
      },
    • "checkAuth": true,
    • "authParams": {
      • "checkLiveness": true,
      • "livenessParams": {
        • "checkOVI": true,
        • "checkMLI": true,
        • "checkHolo": true,
        • "checkED": true,
        • "checkBlackAndWhiteCopy": true,
        • "checkDynaprint": true,
        • "checkGeometry": true,
        • "checkBarcodeBackground": 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,
      • "checkSecurityText": true,
      • "checkProperties": true,
      • "propertiesParams": {
        • "checkHoldersSignature": true
        }
      },
    • "mrzDetectMode": 0,
    • "generateNumericCodes": true,
    • "strictBarcodeDigitalSignatureCheck": true,
    • "selectLongestNames": true,
    • "doBarcodes": [
      • "bct_unknown"
      ],
    • "strictDLCategoryExpiry": true,
    • "generateAlpha2Codes": true,
    • "pdfPagesLimit": 0,
    • "disableAuthResolutionFilter": true,
    • "strictSecurityChecks": true,
    • "returnTransliteratedFields": true,
    • "bsiTr03135": {
      • "generateResult": true
      },
    • "strictExpiryDate": true,
    • "checkVDS": true,
    • "strictAgeCheck": true
    },
  • "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": [
      • {
        • "buf_length": 0,
        • "light": 0,
        • "list_idx": 0,
        • "page_idx": 0,
        • "result_type": 1,
        • "Status": {
          • "overallStatus": 0,
          • "optical": 0,
          • "portrait": 0,
          • "rfid": 0,
          • "stopList": 0,
          • "detailsRFID": {
            },
          • "detailsOptical": {
            },
          • "age": 0,
          • "detailsAge": {
            },
          • "mDL": 0
          }
        }
      ]
    },
  • "systemInfo": {
    • "license": "string",
    • "recaptcha_token": "string"
    },
  • "passBackObject": { },
  • "dtc": "string",
  • "ImageUrls": [
    • "string"
    ]
}

Response samples

Content type
application/json
{
  • "ChipPage": 0,
  • "CoreLibResultCode": 0,
  • "ProcessingFinished": 0,
  • "ContainerList": {
    • "Count": 0,
    • "List": [
      • {
        • "buf_length": 0,
        • "light": 0,
        • "list_idx": 0,
        • "page_idx": 0,
        • "result_type": 1,
        • "Status": {
          • "overallStatus": 0,
          • "optical": 0,
          • "portrait": 0,
          • "rfid": 0,
          • "stopList": 0,
          • "detailsRFID": {
            },
          • "detailsOptical": {
            },
          • "age": 0,
          • "detailsAge": {
            },
          • "mDL": 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,
  • "metadata": { }
}

transaction

Reprocess

path Parameters
transactionId
required
string <uuid>

Transaction id

query Parameters
useCache
boolean
Default: false

Get processed values from storage in case transaction has already processed.

Request Body schema: application/json
required
object (ProcessParams)
Array of objects (ProcessRequestImage)
tag
string

Session ID

tenant
string

Customer name

env
string

Environment type

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.

dtc
string

Digital Travel Credential (DTC-VC) data in base64 format for processing

Responses

Response Schema: application/json
object (OutData)
object (InData)
tag
string
transactionId
string <uuid>

Request samples

Content type
application/json
{
  • "processParam": {
    • "generateDTCVC": true,
    • "lcidFilter": [
      • 0
      ],
    • "lcidIgnoreFilter": [
      • 0
      ],
    • "oneShotIdentification": true,
    • "useFaceApi": true,
    • "faceApi": {
      • "url": "https://faceapi.regulaforensics.com",
      • "mode": "match",
      • "search": {
        • "limit": 0,
        • "threshold": 0,
        • "group_ids": [
          • "string"
          ]
        },
      • "threshold": 75,
      • "serviceTimeout": 3000,
      • "proxy": "http://localhost:8080",
      • "proxy_userpwd": "user:pass",
      • "proxy_type": 0,
      • "childAgeThreshold": 13,
      • "childDocValidityYears": 5
      },
    • "doDetectCan": true,
    • "imageOutputMaxHeight": 0,
    • "imageOutputMaxWidth": 0,
    • "scenario": "Mrz",
    • "resultTypeOutput": [
      • 1
      ],
    • "doublePageSpread": true,
    • "generateDoublePageSpreadImage": true,
    • "fieldTypesFilter": [
      • 0
      ],
    • "fieldTypesIgnoreFilter": [
      • 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,
      • "expectedPass": [
        • "glaresCheck"
        ],
      • "glaresCheckParams": {
        • "imgMarginPart": 0.35,
        • "maxGlaringPart": 0
        }
      },
    • "strictImageQuality": true,
    • "respectImageQuality": true,
    • "forceDocFormat": -1,
    • "noGraphics": true,
    • "depersonalizeLog": true,
    • "multiDocOnImage": true,
    • "shiftExpiryDate": 0,
    • "minimalHolderAge": 0,
    • "returnUncroppedImage": true,
    • "mrzFormatsFilter": [
      • "1x30"
      ],
    • "parseBarcodes": true,
    • "convertCase": 0,
    • "splitNames": true,
    • "disablePerforationOCR": true,
    • "documentGroupFilter": [
      • 0
      ],
    • "processAuth": 0,
    • "deviceId": 0,
    • "deviceType": 0,
    • "deviceTypeHex": "string",
    • "ignoreDeviceIdFromImage": true,
    • "documentIdList": [
      • 0
      ],
    • "rfid": {
      • "paIgnoreNotificationCodes": [
        • 2415919105
        ]
      },
    • "checkAuth": true,
    • "authParams": {
      • "checkLiveness": true,
      • "livenessParams": {
        • "checkOVI": true,
        • "checkMLI": true,
        • "checkHolo": true,
        • "checkED": true,
        • "checkBlackAndWhiteCopy": true,
        • "checkDynaprint": true,
        • "checkGeometry": true,
        • "checkBarcodeBackground": 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,
      • "checkSecurityText": true,
      • "checkProperties": true,
      • "propertiesParams": {
        • "checkHoldersSignature": true
        }
      },
    • "mrzDetectMode": 0,
    • "generateNumericCodes": true,
    • "strictBarcodeDigitalSignatureCheck": true,
    • "selectLongestNames": true,
    • "doBarcodes": [
      • "bct_unknown"
      ],
    • "strictDLCategoryExpiry": true,
    • "generateAlpha2Codes": true,
    • "pdfPagesLimit": 0,
    • "disableAuthResolutionFilter": true,
    • "strictSecurityChecks": true,
    • "returnTransliteratedFields": true,
    • "bsiTr03135": {
      • "generateResult": true
      },
    • "strictExpiryDate": true,
    • "checkVDS": true,
    • "strictAgeCheck": true
    },
  • "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": [
      • {
        • "buf_length": 0,
        • "light": 0,
        • "list_idx": 0,
        • "page_idx": 0,
        • "result_type": 1,
        • "Status": {
          • "overallStatus": 0,
          • "optical": 0,
          • "portrait": 0,
          • "rfid": 0,
          • "stopList": 0,
          • "detailsRFID": {
            },
          • "detailsOptical": {
            },
          • "age": 0,
          • "detailsAge": {
            },
          • "mDL": 0
          }
        }
      ]
    },
  • "systemInfo": {
    • "license": "string",
    • "recaptcha_token": "string"
    },
  • "passBackObject": { },
  • "dtc": "string"
}

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
string <uuid>

Transaction id

Responses

Response Schema: application/json
transactionId
string <uuid>
tag
string
object (OutData)
object (InData)

Response samples

Content type
application/json
{
  • "transactionId": "75906707-8c31-479c-b354-aa805c4cefbc",
  • "tag": "string",
  • "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"
        }
      ]
    }
}

Get Reprocess transaction result

path Parameters
transactionId
required
string <uuid>

Transaction id

query Parameters
withImages
boolean

With base64 images or url

Responses

Response Schema: application/json
ChipPage
required
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

CoreLibResultCode
integer
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
required
integer
elapsedTime
required
integer

Time the document processing has taken, ms.

object

Response samples

Content type
application/json
{
  • "ChipPage": 0,
  • "CoreLibResultCode": 0,
  • "ProcessingFinished": 0,
  • "ContainerList": {
    • "Count": 0,
    • "List": [
      • {
        • "buf_length": 0,
        • "light": 0,
        • "list_idx": 0,
        • "page_idx": 0,
        • "result_type": 1,
        • "Status": {
          • "overallStatus": 0,
          • "optical": 0,
          • "portrait": 0,
          • "rfid": 0,
          • "stopList": 0,
          • "detailsRFID": {
            },
          • "detailsOptical": {
            },
          • "age": 0,
          • "detailsAge": {
            },
          • "mDL": 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,
  • "metadata": { }
}

Get Reprocess transaction file

path Parameters
transactionId
required
string <uuid>

Transaction id

query Parameters
name
required
string

File name

Responses

Response Schema: application/octet-stream
string <binary>

Delete Reprocess transactions by tag

path Parameters
tagId
required
string <uuid>

Tag id

Responses

Response Schema: application/json
any

Response samples

Content type
application/json
null

Get transactions by tag

path Parameters
tagId
required
string

Tag id

Responses

Response Schema: application/json
Array of objects (GetTransactionsByTagResponse)
object

Response samples

Content type
application/json
{
  • "items": [
    • {
      • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      • "state": 0,
      • "updatedAt": "2019-08-24T14:15:22Z"
      }
    ],
  • "metadata": { }
}

healthcheck

Server health check Deprecated

header Parameters
X-RequestID
string

It allows the client and server to correlate each HTTP request. HTTP requests with an identifier are sent from the client to the server and back again.

Responses

Response Schema: application/json
app-name
string

Application name.

version
string

Product version.

license-id
string

Unique license identifier.

license-serial
string

License serial number.

license-type
string
valid-until
string <date-time>

License validity date.

server-time
string
supported-scenarios
Array of strings

List of supported scenarios.

object
object

Database information.

Response samples

Content type
application/json
{
  • "app-name": "Regula Process Manager Service",
  • "version": "5.3.104980.123",
  • "license-id": "4d43a2af-e321-496c-9a4e-5a8f3d26df0e",
  • "license-serial": "OL70786",
  • "valid-until": "9999-12-31T23:59:59Z",
  • "server-time": "2020-10-16 09:42:08.080713+00:00"
}

Server health check

header Parameters
X-RequestID
string

It allows the client and server to correlate each HTTP request. HTTP requests with an identifier are sent from the client to the server and back again.

Responses

Response Schema: application/json
app
required
string

Application name.

licenseId
required
string or null

Unique license identifier.

licenseType
required
string or null

License type.

licenseSerial
required
string or null

License serial number.

licenseValidUntil
required
string or null <date-time>

License validity date.

scenarios
required
Array of strings or null

List of supported scenarios.

version
required
string or null

Product version.

object
object

Database information.

Response samples

Content type
application/json
{
  • "app": "Regula Document Reader Web API",
  • "licenseId": "4D43A2AF-E321-496C-9A4E-5A8F3D26DF0E",
  • "licenseType": "Transactional",
  • "licenseSerial": "OL70786",
  • "licenseValidUntil": "9999-12-31T23:59:59Z",
  • "scenarios": [
    • "Mrz",
    • "Barcode",
    • "Locate"
    ],
  • "version": "7.5.297907.1721",
  • "documentsDatabase": {
    • "id": "FullAuth",
    • "version": "800111",
    • "exportDate": "2024-11-11",
    • "description": "FullAuth: All documents"
    }
}

License health check

header Parameters
X-RequestID
string

It allows the client and server to correlate each HTTP request. HTTP requests with an identifier are sent from the client to the server and back again.

Responses

resources

Returns the list of documents stored in the database that the Web Service API is running with.

Responses

Response Schema: application/json
required
Array of objects (DatabaseDocument)

The list of documents stored in the database.

Array
barcode_fields
required
boolean

Whether the document has a barcode.

country
required
string

Country name.

created
required
string

Date when the document description was created in the database.

doc_type
required
integer (DocumentType)
Enum: 0 11 12 13 14 … 225 more

Possible values for document types

document
required
string

Document name.

graphic_fields
required
boolean

The presence of graphic fields in the document.

id
required
integer

Document code.

mrz
required
boolean

The document has an MRZ.

region
string

Country region.

rfid_chip
required
boolean

The document has an RFID chip.

text_fields
required
boolean

The presence of text fields in the document.

updated
required
string

Date when the document description was updated in the database.

year
string

The year when the document was issued.

sovereignty
string

Guardian country.

deprecated
boolean

Whether the document is no longer in circulation.

icao_code
string

ICAO country code.

doc_codes
string

Document codes.

Response samples

Content type
application/json
{
  • "items": [
    • {
      • "barcode_fields": true,
      • "country": "string",
      • "created": "string",
      • "doc_type": 0,
      • "document": "string",
      • "graphic_fields": true,
      • "id": 0,
      • "mrz": true,
      • "region": "string",
      • "rfid_chip": true,
      • "text_fields": true,
      • "updated": "string",
      • "year": "string",
      • "sovereignty": "string",
      • "deprecated": true,
      • "icao_code": "string",
      • "doc_codes": "string"
      }
    ]
}