@regulaforensics/document-reader-webclient
Version:
Regula Document Reader js client for the browser and node.js based on axios
2,114 lines • 406 kB
TypeScript
import { AxiosInstance, AxiosResponse } from "axios";
/**
* Regula Document Reader Web API
* Documents recognition as easy as reading two bytes. # Clients: * [JavaScript](https://github.com/regulaforensics/DocumentReader-web-js-client) client for the browser and node.js based on axios * [Java](https://github.com/regulaforensics/DocumentReader-web-java-client) client compatible with jvm and android * [Python](https://github.com/regulaforensics/DocumentReader-web-python-client) 3.5+ client * [C#](https://github.com/regulaforensics/DocumentReader-web-csharp-client) client for .NET & .NET Core
*
* The version of the OpenAPI document: 8.1.0
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
export interface ConfigurationParameters {
apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
username?: string;
password?: string;
accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
basePath?: string;
serverIndex?: number;
baseOptions?: any;
formDataCtor?: new () => any;
}
export class Configuration {
/**
* parameter for apiKey security
* @param name security name
* @memberof Configuration
*/
apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
/**
* parameter for basic security
*
* @type {string}
* @memberof Configuration
*/
username?: string;
/**
* parameter for basic security
*
* @type {string}
* @memberof Configuration
*/
password?: string;
/**
* parameter for oauth2 security
* @param name security name
* @param scopes oauth2 scope
* @memberof Configuration
*/
accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
/**
* override base path
*
* @type {string}
* @memberof Configuration
*/
basePath?: string;
/**
* override server index
*
* @type {number}
* @memberof Configuration
*/
serverIndex?: number;
/**
* base options for axios calls
*
* @type {any}
* @memberof Configuration
*/
baseOptions?: any;
/**
* The FormData constructor that will be used to create multipart form data
* requests. You can inject this here so that execution environments that
* do not support the FormData class can still run the generated client.
*
* @type {new () => FormData}
*/
formDataCtor?: new () => any;
constructor(param?: ConfigurationParameters);
/**
* Check if the given MIME is a JSON MIME.
* JSON MIME examples:
* application/json
* application/json; charset=UTF8
* APPLICATION/JSON
* application/vnd.company+json
* @param mime - MIME (Multipurpose Internet Mail Extensions)
* @return True if the given MIME is JSON, false otherwise.
*/
isJsonMime(mime: string): boolean;
}
/**
* Regula Document Reader Web API
* Documents recognition as easy as reading two bytes. # Clients: * [JavaScript](https://github.com/regulaforensics/DocumentReader-web-js-client) client for the browser and node.js based on axios * [Java](https://github.com/regulaforensics/DocumentReader-web-java-client) client compatible with jvm and android * [Python](https://github.com/regulaforensics/DocumentReader-web-python-client) 3.5+ client * [C#](https://github.com/regulaforensics/DocumentReader-web-csharp-client) client for .NET & .NET Core
*
* The version of the OpenAPI document: 8.1.0
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
/**
*
* @export
* @interface Point
*/
export interface Point {
/**
*
* @type {number}
* @memberof Point
*/
'x': number;
/**
*
* @type {number}
* @memberof Point
*/
'y': number;
}
/**
*
* @export
* @interface PointArray
*/
export interface PointArray {
/**
*
* @type {Array<Point>}
* @memberof PointArray
*/
'PointsList': Array<Point>;
}
/**
* Regula Document Reader Web API
* Documents recognition as easy as reading two bytes. # Clients: * [JavaScript](https://github.com/regulaforensics/DocumentReader-web-js-client) client for the browser and node.js based on axios * [Java](https://github.com/regulaforensics/DocumentReader-web-java-client) client compatible with jvm and android * [Python](https://github.com/regulaforensics/DocumentReader-web-python-client) 3.5+ client * [C#](https://github.com/regulaforensics/DocumentReader-web-csharp-client) client for .NET & .NET Core
*
* The version of the OpenAPI document: 8.1.0
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
/**
* Coordinates of the rectangle region on a document image(result type 1). Represented by two points - (left, top) + (right, bottom)
* @export
* @interface RectangleCoordinates
*/
export interface RectangleCoordinates {
/**
*
* @type {number}
* @memberof RectangleCoordinates
*/
'left': number;
/**
*
* @type {number}
* @memberof RectangleCoordinates
*/
'top': number;
/**
*
* @type {number}
* @memberof RectangleCoordinates
*/
'right': number;
/**
*
* @type {number}
* @memberof RectangleCoordinates
*/
'bottom': number;
}
/**
*
* @export
* @interface AreaArray
*/
export interface AreaArray {
/**
* Number of elements in List and Points
* @type {number}
* @memberof AreaArray
*/
'Count': number;
/**
*
* @type {Array<RectangleCoordinates>}
* @memberof AreaArray
*/
'List': Array<RectangleCoordinates>;
/**
*
* @type {Array<PointArray>}
* @memberof AreaArray
*/
'Points': Array<PointArray>;
}
/**
*
* @export
* @interface PointsContainer
*/
export interface PointsContainer {
/**
*
* @type {number}
* @memberof PointsContainer
*/
'PointCount'?: number;
/**
*
* @type {Array<Point>}
* @memberof PointsContainer
*/
'PointsList': Array<Point>;
}
/**
* Checked fragment coordinates
* @export
* @interface AreaContainer
*/
export interface AreaContainer {
/**
*
* @type {number}
* @memberof AreaContainer
*/
'Count': number;
/**
*
* @type {Array<RectangleCoordinates>}
* @memberof AreaContainer
*/
'List': Array<RectangleCoordinates>;
/**
*
* @type {Array<PointsContainer>}
* @memberof AreaContainer
*/
'Points': Array<PointsContainer>;
}
/**
* Regula Document Reader Web API
* Documents recognition as easy as reading two bytes. # Clients: * [JavaScript](https://github.com/regulaforensics/DocumentReader-web-js-client) client for the browser and node.js based on axios * [Java](https://github.com/regulaforensics/DocumentReader-web-java-client) client compatible with jvm and android * [Python](https://github.com/regulaforensics/DocumentReader-web-python-client) 3.5+ client * [C#](https://github.com/regulaforensics/DocumentReader-web-csharp-client) client for .NET & .NET Core
*
* The version of the OpenAPI document: 8.1.0
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
/**
*
* @export
* @interface LivenessParams
*/
export interface LivenessParams {
/**
* This parameter is used to enable OVI check
* @type {boolean}
* @memberof LivenessParams
*/
'checkOVI'?: boolean;
/**
* This parameter is used to enable MLI check
* @type {boolean}
* @memberof LivenessParams
*/
'checkMLI'?: boolean;
/**
* This parameter is used to enable Hologram detection
* @type {boolean}
* @memberof LivenessParams
*/
'checkHolo'?: boolean;
/**
* This parameter is used to enable Electronic device detection
* @type {boolean}
* @memberof LivenessParams
*/
'checkED'?: boolean;
/**
* This parameter is used to enable Black and white copy check
* @type {boolean}
* @memberof LivenessParams
*/
'checkBlackAndWhiteCopy'?: boolean;
/**
* This parameter is used to enable Dynaprint check
* @type {boolean}
* @memberof LivenessParams
*/
'checkDynaprint'?: boolean;
/**
* This parameter is used to enable Geometry check
* @type {boolean}
* @memberof LivenessParams
*/
'checkGeometry'?: boolean;
}
/**
*
* @export
* @interface AuthParams
*/
export interface AuthParams {
/**
* This parameter is used to enable document liveness check
* @type {boolean}
* @memberof AuthParams
*/
'checkLiveness'?: boolean;
/**
*
* @type {LivenessParams}
* @memberof AuthParams
*/
'livenessParams'?: LivenessParams;
/**
* This parameter is used to enable Document luminescence check in UV light
* @type {boolean}
* @memberof AuthParams
*/
'checkUVLuminiscence'?: boolean;
/**
* This parameter is used to enable B900 ink MRZ contrast check in IR light
* @type {boolean}
* @memberof AuthParams
*/
'checkIRB900'?: boolean;
/**
* This parameter is used to enable Image patterns presence/absence check (position, shape, color)
* @type {boolean}
* @memberof AuthParams
*/
'checkImagePatterns'?: boolean;
/**
* This parameter is used to enable Fibers detection
* @type {boolean}
* @memberof AuthParams
*/
'checkFibers'?: boolean;
/**
* This parameter is used to enable Extended MRZ Check
* @type {boolean}
* @memberof AuthParams
*/
'checkExtMRZ'?: boolean;
/**
* This parameter is used to enable Extended OCR Check
* @type {boolean}
* @memberof AuthParams
*/
'checkExtOCR'?: boolean;
/**
* This parameter is used to enable laminate integrity check in axial light
* @type {boolean}
* @memberof AuthParams
*/
'checkAxial'?: boolean;
/**
* This parameter is used to enable Barcode format check (code metadata, data format, contents format, etc.)
* @type {boolean}
* @memberof AuthParams
*/
'checkBarcodeFormat'?: boolean;
/**
* This parameter is used to enable Document elements visibility check in IR light
* @type {boolean}
* @memberof AuthParams
*/
'checkIRVisibility'?: boolean;
/**
* This parameter is used to enable Invisible Personal Information (IPI) check
* @type {boolean}
* @memberof AuthParams
*/
'checkIPI'?: boolean;
/**
* This parameter is used to enable Owner\'s photo embedding check (is photo printed or sticked)
* @type {boolean}
* @memberof AuthParams
*/
'checkPhotoEmbedding'?: boolean;
/**
* This parameter is used to enable Portrait comparison check
* @type {boolean}
* @memberof AuthParams
*/
'checkPhotoComparison'?: boolean;
/**
* This parameter is used to enable LetterScreen check
* @type {boolean}
* @memberof AuthParams
*/
'checkLetterScreen'?: boolean;
/**
* This parameter is used to enable Security text check
* @type {boolean}
* @memberof AuthParams
*/
'checkSecurityText'?: boolean;
}
/**
* Regula Document Reader Web API
* Documents recognition as easy as reading two bytes. # Clients: * [JavaScript](https://github.com/regulaforensics/DocumentReader-web-js-client) client for the browser and node.js based on axios * [Java](https://github.com/regulaforensics/DocumentReader-web-java-client) client compatible with jvm and android * [Python](https://github.com/regulaforensics/DocumentReader-web-python-client) 3.5+ client * [C#](https://github.com/regulaforensics/DocumentReader-web-csharp-client) client for .NET & .NET Core
*
* The version of the OpenAPI document: 8.1.0
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
/**
* Enumeration describes available authenticity checks: https://docs.regulaforensics.com/develop/doc-reader-sdk/web-service/development/enums/authenticity-result-type/.
* @export
* @enum {number}
*/
export enum AuthenticityResultType {
/**
* Document luminescence check in UV light
*/
UV_LUMINESCENCE = 1,
/**
* B900 ink MRZ contrast check in IR light
*/
IR_B900 = 2,
/**
* Image patterns presence/absence check (position, shape, color)
*/
IMAGE_PATTERN = 4,
/**
* Confirm laminate integrity check in axial light
*/
AXIAL_PROTECTION = 8,
/**
* Protection fibers presence check (color, density) in UV light
*/
UV_FIBERS = 16,
/**
* Document elements visibility check in IR light
*/
IR_VISIBILITY = 32,
/**
* OCR for the text field in UV light comparison with other text sources check
*/
OCR_SECURITY_TEXT = 64,
/**
* Invisible Personal Information (IPI) visualization
*/
IPI = 128,
/**
* Owner's photo embedding check (is photo printed or sticked)
*/
PHOTO_EMBED_TYPE = 512,
/**
* OVI check. Deprecated, use Document liveness check instead
*/
OVI = 1024,
/**
* Hologram presence check. Deprecated
*/
HOLOGRAMS = 4096,
/**
* Owner's photo area advanced check (photo shape, size, position, etc.)
*/
PHOTO_AREA = 8192,
/**
* Portrait comparison check (document printed vs chip vs live)
*/
PORTRAIT_COMPARISON = 32768,
/**
* Barcode format check (code metadata, data format, contents format, etc.)
*/
BARCODE_FORMAT_CHECK = 65536,
/**
* Kinegram check
*/
KINEGRAM = 131072,
/**
* LetterScreen check
*/
LETTER_SCREEN = 262144,
/**
* Hologram detection and validation check
*/
HOLOGRAM_DETECTION = 524288,
/**
* Fingerprint comparison check
*/
FINGERPRINT_COMPARISON = 1048576,
/**
* Document liveness check
*/
LIVENESS = 2097152,
/**
* Extended OCR Check
*/
EXTENDED_OCR_CHECK = 4194304,
/**
* Extended MRZ check
*/
EXTENDED_MRZ_CHECK = 8388608,
/**
* Encrypted IPI
*/
ENCRYPTED_IPI = 16777216
}
/**
* Regula Document Reader Web API
* Documents recognition as easy as reading two bytes. # Clients: * [JavaScript](https://github.com/regulaforensics/DocumentReader-web-js-client) client for the browser and node.js based on axios * [Java](https://github.com/regulaforensics/DocumentReader-web-java-client) client compatible with jvm and android * [Python](https://github.com/regulaforensics/DocumentReader-web-python-client) 3.5+ client * [C#](https://github.com/regulaforensics/DocumentReader-web-csharp-client) client for .NET & .NET Core
*
* The version of the OpenAPI document: 8.1.0
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
/**
* Enumeration contains identifiers which determinate the single document element authenticity check outcome reason: https://docs.regulaforensics.com/develop/doc-reader-sdk/web-service/development/enums/check-diagnose/
* @export
* @enum {number}
*/
export enum CheckDiagnose {
UNKNOWN = 0,
PASS = 1,
INVALID_INPUT_DATA = 2,
INTERNAL_ERROR = 3,
EXCEPTION_IN_MODULE = 4,
UNCERTAIN_VERIFICATION = 5,
NECESSARY_IMAGE_NOT_FOUND = 7,
PHOTO_SIDES_NOT_FOUND = 8,
INVALID_CHECKSUM = 10,
SYNTAX_ERROR = 11,
LOGIC_ERROR = 12,
SOURCES_COMPARISON_ERROR = 13,
FIELDS_COMPARISON_LOGIC_ERROR = 14,
INVALID_FIELD_FORMAT = 15,
TRUE_LUMINESCENCE_ERROR = 20,
FALSE_LUMINESCENCE_ERROR = 21,
FIXED_PATTERN_ERROR = 22,
LOW_CONTRAST_IN_IR_LIGHT = 23,
INCORRECT_BACKGROUND_LIGHT = 24,
BACKGROUND_COMPARISON_ERROR = 25,
INCORRECT_TEXT_COLOR = 26,
PHOTO_FALSE_LUMINESCENCE = 27,
TOO_MUCH_SHIFT = 28,
CONTACT_CHIP_TYPE_MISMATCH = 29,
FIBERS_NOT_FOUND = 30,
TOO_MANY_OBJECTS = 31,
SPECKS_IN_UV = 33,
TOO_LOW_RESOLUTION = 34,
INVISIBLE_ELEMENT_PRESENT = 40,
VISIBLE_ELEMENT_ABSENT = 41,
ELEMENT_SHOULD_BE_COLORED = 42,
ELEMENT_SHOULD_BE_GRAYSCALE = 43,
PHOTO_WHITE_IR_DONT_MATCH = 44,
UV_DULL_PAPER_MRZ = 50,
FALSE_LUMINESCENCE_IN_MRZ = 51,
UV_DULL_PAPER_PHOTO = 52,
UV_DULL_PAPER_BLANK = 53,
UV_DULL_PAPER_ERROR = 54,
FALSE_LUMINESCENCE_IN_BLANK = 55,
BAD_AREA_IN_AXIAL = 60,
FALSE_IPI_PARAMETERS = 65,
ENCRYPTED_IPI_NOT_FOUND = 66,
ENCRYPTED_IPI_DATA_DONT_MATCH = 67,
FIELD_POS_CORRECTOR_HIGHLIGHT_IR = 80,
FIELD_POS_CORRECTOR_GLARES_IN_PHOTO_AREA = 81,
FIELD_POS_CORRECTOR_PHOTO_REPLACED = 82,
FIELD_POS_CORRECTOR_LANDMARKS_CHECK_ERROR = 83,
FIELD_POS_CORRECTOR_FACE_PRESENCE_CHECK_ERROR = 84,
FIELD_POS_CORRECTOR_FACE_ABSENCE_CHECK_ERROR = 85,
FIELD_POS_CORRECTOR_INCORRECT_HEAD_POSITION = 86,
OVI_IR_INVISIBLE = 90,
OVI_INSUFFICIENT_AREA = 91,
OVI_COLOR_INVARIABLE = 92,
OVI_BAD_COLOR_FRONT = 93,
OVI_BAD_COLOR_SIDE = 94,
OVI_WIDE_COLOR_SPREAD = 95,
OVI_BAD_COLOR_PERCENT = 96,
HOLOGRAM_ELEMENT_ABSENT = 100,
HOLOGRAM_SIDE_TOP_IMAGES_ABSENT = 101,
HOLOGRAM_ELEMENT_PRESENT = 102,
HOLOGRAM_FRAMES_IS_ABSENT = 103,
HOLOGRAM_HOLO_FIELD_IS_ABSENT = 104,
PHOTO_PATTERN_INTERRUPTED = 110,
PHOTO_PATTERN_SHIFTED = 111,
PHOTO_PATTERN_DIFFERENT_COLORS = 112,
PHOTO_PATTERN_IR_VISIBLE = 113,
PHOTO_PATTERN_NOT_INTERSECT = 114,
PHOTO_SIZE_IS_WRONG = 115,
PHOTO_PATTERN_INVALID_COLOR = 116,
PHOTO_PATTERN_SHIFTED_VERT = 117,
PHOTO_PATTERN_PATTERN_NOT_FOUND = 118,
PHOTO_PATTERN_DIFFERENT_LINES_THICKNESS = 119,
PHOTO_IS_NOT_RECTANGLE = 120,
PHOTO_CORNERS_IS_WRONG = 121,
DOCUMENT_IS_CANCELLING = 122,
TEXT_COLOR_SHOULD_BE_BLUE = 130,
TEXT_COLOR_SHOULD_BE_GREEN = 131,
TEXT_COLOR_SHOULD_BE_RED = 132,
TEXT_SHOULD_BE_BLACK = 133,
BARCODE_WAS_READ_WITH_ERRORS = 140,
BARCODE_DATA_FORMAT_ERROR = 141,
BARCODE_SIZE_PARAMS_ERROR = 142,
NOT_ALL_BARCODES_READ = 143,
GLARES_IN_BARCODE_AREA = 144,
NO_CERTIFICATE_FOR_DIGITAL_SIGNATURE_CHECK = 145,
PORTRAIT_COMPARISON_PORTRAITS_DIFFER = 150,
PORTRAIT_COMPARISON_NO_SERVICE_REPLY = 151,
PORTRAIT_COMPARISON_SERVICE_ERROR = 152,
PORTRAIT_COMPARISON_NOT_ENOUGH_IMAGES = 153,
PORTRAIT_COMPARISON_NO_LIVE_PHOTO = 154,
PORTRAIT_COMPARISON_NO_SERVICE_LICENSE = 155,
PORTRAIT_COMPARISON_NO_PORTRAIT_DETECTED = 156,
MOBILE_IMAGES_UNSUITABLE_LIGHT_CONDITIONS = 160,
MOBILE_IMAGES_WHITE_UV_NO_DIFFERENCE = 161,
FINGERPRINTS_COMPARISON_MISMATCH = 170,
HOLO_PHOTO_FACE_NOT_DETECTED = 180,
HOLO_PHOTO_FACE_COMPARISON_FAILED = 181,
HOLO_PHOTO_GLARE_IN_CENTER_ABSENT = 182,
HOLO_PHOTO_HOLO_ELEMENT_SHAPE_ERROR = 183,
HOLO_PHOTO_ALGORITHMS_STEPS_ERROR = 184,
HOLO_PHOTO_HOLO_AREAS_NOT_LOADED = 185,
HOLO_PHOTO_FINISHED_BY_TIMEOUT = 186,
HOLO_PHOTO_DOCUMENT_OUTSIDE_FRAME = 187,
LIVENESS_DEPTH_CHECK_FAILED = 190,
MRZ_QUALITY_WRONG_SYMBOL_POSITION = 200,
MRZ_QUALITY_WRONG_BACKGROUND = 201,
MRZ_QUALITY_WRONG_MRZ_WIDTH = 202,
MRZ_QUALITY_WRONG_MRZ_HEIGHT = 203,
MRZ_QUALITY_WRONG_LINE_POSITION = 204,
MRZ_QUALITY_WRONG_FONT_TYPE = 205,
OCR_QUALITY_TEXT_POSITION = 220,
OCR_QUALITY_INVALID_FONT = 221,
OCR_QUALITY_INVALID_BACKGROUND = 222,
LASINK_INVALID_LINES_FREQUENCY = 230,
DOC_LIVENESS_DOCUMENT_NOT_LIVE = 238,
DOC_LIVENESS_BLACK_AND_WHITE_COPY_DETECTED = 239,
DOC_LIVENESS_ELECTRONIC_DEVICE_DETECTED = 240,
DOC_LIVENESS_INVALID_BARCODE_BACKGROUND = 241,
CHD_ICAO_IDB_BASE32_ERROR = 243,
CHD_ICAO_IDB_ZIPPED_ERROR = 244,
CHD_ICAO_IDB_MESSAGE_ZONE_EMPTY = 245,
CHD_ICAO_IDB_SIGNATURE_MUST_BE_PRESENT = 246,
CHD_ICAO_IDB_SIGNATURE_MUST_NOT_BE_PRESENT = 247,
CHD_ICAO_IDB_CERTIFICATE_MUST_NOT_BE_PRESENT = 248,
CHD_INCORRECT_OBJECT_COLOR = 250
}
/**
* Regula Document Reader Web API
* Documents recognition as easy as reading two bytes. # Clients: * [JavaScript](https://github.com/regulaforensics/DocumentReader-web-js-client) client for the browser and node.js based on axios * [Java](https://github.com/regulaforensics/DocumentReader-web-java-client) client compatible with jvm and android * [Python](https://github.com/regulaforensics/DocumentReader-web-python-client) 3.5+ client * [C#](https://github.com/regulaforensics/DocumentReader-web-csharp-client) client for .NET & .NET Core
*
* The version of the OpenAPI document: 8.1.0
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
/**
* 0 - result is negative; 1 - result is positive; 2 - сheck was not performed
* @export
* @enum {number}
*/
export enum CheckResult {
/**
* Check was performed and result is NEGATIVE
*/
ERROR = 0,
/**
* Check was performed and result is POSITIVE
*/
OK = 1,
/**
* Check was NOT PERFORMED
*/
WAS_NOT_DONE = 2
}
/**
* Regula Document Reader Web API
* Documents recognition as easy as reading two bytes. # Clients: * [JavaScript](https://github.com/regulaforensics/DocumentReader-web-js-client) client for the browser and node.js based on axios * [Java](https://github.com/regulaforensics/DocumentReader-web-java-client) client compatible with jvm and android * [Python](https://github.com/regulaforensics/DocumentReader-web-python-client) 3.5+ client * [C#](https://github.com/regulaforensics/DocumentReader-web-csharp-client) client for .NET & .NET Core
*
* The version of the OpenAPI document: 8.1.0
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
/**
* Enumeration contains identifiers determining the criticality of the security element
* @export
* @enum {number}
*/
export enum Critical {
/**
* Security element may be absent in a valid document
*/
NOT_CRITICAL = 0,
/**
* Security element must be present in a valid document
*/
CRITICAL = 1
}
/**
* Common fields for all authenticity result objects
* @export
* @interface AuthenticityCheckResultItem
*/
export interface AuthenticityCheckResultItem {
/**
*
* @type {AuthenticityResultType}
* @memberof AuthenticityCheckResultItem
*/
'Type': AuthenticityResultType;
/**
*
* @type {CheckResult}
* @memberof AuthenticityCheckResultItem
*/
'ElementResult'?: CheckResult;
/**
*
* @type {CheckDiagnose}
* @memberof AuthenticityCheckResultItem
*/
'ElementDiagnose'?: CheckDiagnose;
/**
*
* @type {number}
* @memberof AuthenticityCheckResultItem
*/
'PercentValue'?: number;
}
/**
* Regula Document Reader Web API
* Documents recognition as easy as reading two bytes. # Clients: * [JavaScript](https://github.com/regulaforensics/DocumentReader-web-js-client) client for the browser and node.js based on axios * [Java](https://github.com/regulaforensics/DocumentReader-web-java-client) client compatible with jvm and android * [Python](https://github.com/regulaforensics/DocumentReader-web-python-client) 3.5+ client * [C#](https://github.com/regulaforensics/DocumentReader-web-csharp-client) client for .NET & .NET Core
*
* The version of the OpenAPI document: 8.1.0
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
/**
* Image light index
* @export
* @enum {number}
*/
export enum Light {
/**
* No Light
*/
OFF = 0,
/**
* Upper/lower white
*/
WHITE_TOP = 2,
/**
* Side white
*/
WHITE_SIDE = 4,
/**
* White
*/
WHITE = 6,
/**
* Infrared
*/
IR = 24,
/**
* Ultraviolet
*/
UV = 128,
/**
* Axial white
*/
AXIAL_WHITE = 3072
}
/**
*
* @export
* @interface FiberItem
*/
export interface FiberItem {
/**
* For UV_Fibers authenticity result type
* @type {number}
* @memberof FiberItem
*/
'RectCount': number;
/**
* Expected fibers number. For UV_Fibers authentication result type
* @type {number}
* @memberof FiberItem
*/
'ExpectedCount': number;
/**
*
* @type {Light}
* @memberof FiberItem
*/
'LightValue'?: Light;
/**
* For UV_Background authentication result type
* @type {number}
* @memberof FiberItem
*/
'LightDisp'?: number;
/**
* Coordinates of located areas for defined fibers type
* @type {Array<RectangleCoordinates>}
* @memberof FiberItem
*/
'RectArray': Array<RectangleCoordinates>;
/**
* Fibers width value for located areas (in pixels)
* @type {Array<number>}
* @memberof FiberItem
*/
'Width': Array<number>;
/**
* Fibers length value for located areas (in pixels)
* @type {Array<number>}
* @memberof FiberItem
*/
'Length': Array<number>;
/**
* Fibers value for areas (in pixels)
* @type {Array<number>}
* @memberof FiberItem
*/
'Area': Array<number>;
/**
* Fibers color value
* @type {Array<number>}
* @memberof FiberItem
*/
'ColorValues': Array<number>;
}
/**
* @type FiberResult
* @export
*/
export type FiberResult = AuthenticityCheckResultItem & FiberItem;
/**
* Regula Document Reader Web API
* Documents recognition as easy as reading two bytes. # Clients: * [JavaScript](https://github.com/regulaforensics/DocumentReader-web-js-client) client for the browser and node.js based on axios * [Java](https://github.com/regulaforensics/DocumentReader-web-java-client) client compatible with jvm and android * [Python](https://github.com/regulaforensics/DocumentReader-web-python-client) 3.5+ client * [C#](https://github.com/regulaforensics/DocumentReader-web-csharp-client) client for .NET & .NET Core
*
* The version of the OpenAPI document: 8.1.0
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
/**
*
* @export
* @interface ImageData
*/
export interface ImageData {
/**
* Base64 encoded image
* @type {string}
* @memberof ImageData
*/
'image'?: string;
/**
* Image format
* @type {string}
* @memberof ImageData
*/
'format'?: string;
}
/**
* Regula Document Reader Web API
* Documents recognition as easy as reading two bytes. # Clients: * [JavaScript](https://github.com/regulaforensics/DocumentReader-web-js-client) client for the browser and node.js based on axios * [Java](https://github.com/regulaforensics/DocumentReader-web-java-client) client compatible with jvm and android * [Python](https://github.com/regulaforensics/DocumentReader-web-python-client) 3.5+ client * [C#](https://github.com/regulaforensics/DocumentReader-web-csharp-client) client for .NET & .NET Core
*
* The version of the OpenAPI document: 8.1.0
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
/**
* Enumeration contains identifiers determining type of features for a document authenticity checks: https://docs.regulaforensics.com/develop/doc-reader-sdk/web-service/development/enums/security-feature-type/
* @export
* @enum {number}
*/
export enum SecurityFeatureType {
/**
* Blank element
*/
BLANK = 0,
/**
* Personalization element
*/
FILL = 1,
/**
* Photo
*/
PHOTO = 2,
/**
* MRZ
*/
MRZ = 3,
/**
* False luminescence
*/
FALSE_LUMINESCENCE = 4,
/**
* Hologram (static)
*/
HOLO_SIMPLE = 5,
/**
* Hologram (static verify)
*/
HOLO_VERIFY_STATIC = 6,
/**
* Hologram (static verify multiple)
*/
HOLO_VERIFY_MULTI_STATIC = 7,
/**
* Hologram (dynamic verify)
*/
HOLO_VERIFY_DYNAMIC = 8,
/**
* Pattern (non-interrupted)
*/
PATTERN_NOT_INTERRUPTED = 9,
/**
* Pattern (non-shifted)
*/
PATTERN_NOT_SHIFTED = 10,
/**
* Pattern (same colors)
*/
PATTERN_SAME_COLORS = 11,
/**
* Pattern (IR invisible)
*/
PATTERN_IR_INVISIBLE = 12,
/**
* Photo size
*/
PHOTO_SIZE_CHECK = 13,
/**
* Main vs ghost portrait comparison
*/
PORTRAIT_COMPARISON_VS_GHOST = 14,
/**
* Main vs RFID portrait comparison
*/
PORTRAIT_COMPARISON_VS_RFID = 15,
/**
* Main vs other page portrait comparison
*/
PORTRAIT_COMPARISON_VS_VISUAL = 16,
/**
* Barcode
*/
BARCODE = 17,
/**
* Pattern (different line thickness)
*/
PATTERN_DIFFERENT_LINES_THICKNESS = 18,
/**
* Main vs live camera portrait comparison
*/
PORTRAIT_COMPARISON_VS_CAMERA = 19,
/**
* RFID vs live camera portrait comparison
*/
PORTRAIT_COMPARISON_RFID_VS_CAMERA = 20,
/**
* Ghost photo
*/
GHOST_PHOTO = 21,
/**
* Clear ghost photo
*/
CLEAR_GHOST_PHOTO = 22,
/**
* Invisible object
*/
INVISIBLE_OBJECT = 23,
/**
* Low contrast object
*/
LOW_CONTRAST_OBJECT = 24,
/**
* Photo color check
*/
PHOTO_COLOR = 25,
/**
* Photo squareness
*/
PHOTO_SHAPE = 26,
/**
* Photo corners shape
*/
PHOTO_CORNERS = 27,
/**
* OCR
*/
OCR = 28,
/**
* External vs main portrait comparison
*/
PORTRAIT_COMPARISON_EXT_VS_VISUAL = 29,
/**
* External vs RFID portrait comparison
*/
PORTRAIT_COMPARISON_EXT_VS_RFID = 30,
/**
* External vs live camera portrait comparison
*/
PORTRAIT_COMPARISON_EXT_VS_CAMERA = 31,
/**
* Portrait Depth
*/
LIVENESS_DEPTH = 32,
/**
* Micro text
*/
MICRO_TEXT = 33,
/**
* Fluorescent Object
*/
FLUORESCENT_OBJECT = 34,
/**
* Facial landmarks check
*/
LANDMARK_CHECK = 35,
/**
* Facial image presence
*/
FACE_PRESENCE = 36,
/**
* Facial image absence
*/
FACE_ABSENCE = 38,
/**
* Liveness screen capture. Deprecated. LIVENESS_ELECTRONIC_DEVICE is used instead.
*/
LIVENESS_SCREEN_CAPTURE = 39,
/**
* Liveness electronic device
*/
LIVENESS_ELECTRONIC_DEVICE = 40,
/**
* Liveness OVI
*/
LIVENESS_OVI = 41,
/**
* Barcode size check
*/
BARCODE_SIZE_CHECK = 42,
/**
* LASINK
*/
LASINK = 43,
/**
* Liveness MLI
*/
LIVENESS_MLI = 44,
/**
* Liveness barcode background
*/
LIVENESS_BARCODE_BACKGROUND = 45,
/**
* Visual zone portrait image vs. image from barcode
*/
PORTRAIT_COMPARISON_VS_BARCODE = 46,
/**
* Image from barcode vs. image from RFID
*/
PORTRAIT_COMPARISON_RFID_VS_BARCODE = 47,
/**
* Image from barcode vs. external source image
*/
PORTRAIT_COMPARISON_EXT_VS_BARCODE = 48,
/**
* Image from barcode vs. photo from camera
*/
PORTRAIT_COMPARISON_BARCODE_VS_CAMERA = 49,
/**
* Digital signature check
*/
CHECK_DIGITAL_SIGNATURE = 50,
/**
* Contact chip check
*/
CONTACT_CHIP_CLASSIFICATION = 51,
/**
* Head position check
*/
HEAD_POSITION_CHECK = 52,
/**
* Black and white copy check
*/
LIVENESS_BLACK_AND_WHITE_COPY_CHECK = 53,
/**
* Liveness dynaprint
*/
LIVENESS_DYNAPRINT = 54,
/**
* Liveness geometry check
*/
LIVENESS_GEOMETRY_CHECK = 55
}
/**
*
* @export
* @interface IdentItem
*/
export interface IdentItem {
/**
*
* @type {SecurityFeatureType}
* @memberof IdentItem
*/
'ElementType': SecurityFeatureType;
/**
*
* @type {Light}
* @memberof IdentItem
*/
'LightIndex': Light;
/**
*
* @type {RectangleCoordinates}
* @memberof IdentItem
*/
'Area'?: RectangleCoordinates;
/**
*
* @type {ImageData}
* @memberof IdentItem
*/
'Image': ImageData;
/**
*
* @type {ImageData}
* @memberof IdentItem
*/
'EtalonImage': ImageData;
/**
*
* @type {AreaContainer}
* @memberof IdentItem
*/
'AreaList'?: AreaContainer;
/**
*
* @type {number}
* @memberof IdentItem
*/
'ElementID'?: number;
}
/**
* @type IdentResult
* @export
*/
export type IdentResult = AuthenticityCheckResultItem & IdentItem;
/**
* Regula Document Reader Web API
* Documents recognition as easy as reading two bytes. # Clients: * [JavaScript](https://github.com/regulaforensics/DocumentReader-web-js-client) client for the browser and node.js based on axios * [Java](https://github.com/regulaforensics/DocumentReader-web-java-client) client compatible with jvm and android * [Python](https://github.com/regulaforensics/DocumentReader-web-python-client) 3.5+ client * [C#](https://github.com/regulaforensics/DocumentReader-web-csharp-client) client for .NET & .NET Core
*
* The version of the OpenAPI document: 8.1.0
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
/**
*
* @export
* @enum {number}
*/
export enum TextFieldType {
/**
* Document class code
*/
DOCUMENT_CLASS_CODE = 0,
/**
* Issuing state code
*/
ISSUING_STATE_CODE = 1,
/**
* Document number
*/
DOCUMENT_NUMBER = 2,
/**
* Date of expiry
*/
DATE_OF_EXPIRY = 3,
/**
* Date of issue
*/
DATE_OF_ISSUE = 4,
/**
* Date of birth
*/
DATE_OF_BIRTH = 5,
/**
* Place of birth
*/
PLACE_OF_BIRTH = 6,
/**
* Personal number
*/
PERSONAL_NUMBER = 7,
/**
* Surname
*/
SURNAME = 8,
/**
* Given name(s)
*/
GIVEN_NAMES = 9,
/**
* Mother's name
*/
MOTHERS_NAME = 10,
/**
* Nationality
*/
NATIONALITY = 11,
/**
* Sex
*/
SEX = 12,
/**
* Height
*/
HEIGHT = 13,
/**
* Weight
*/
WEIGHT = 14,
/**
* Eyes color
*/
EYES_COLOR = 15,
/**
* Hair color
*/
HAIR_COLOR = 16,
/**
* Address
*/
ADDRESS = 17,
/**
* Donor
*/
DONOR = 18,
/**
* Social security number
*/
SOCIAL_SECURITY_NUMBER = 19,
/**
* DL class
*/
DL_CLASS = 20,
/**
* DL endorsement code
*/
DL_ENDORSED = 21,
/**
* DL restriction code
*/
DL_RESTRICTION_CODE = 22,
/**
* Date of 21st birthday
*/
DL_UNDER_21_DATE = 23,
/**
* Issuing authority
*/
AUTHORITY = 24,
/**
* Surname and given names
*/
SURNAME_AND_GIVEN_NAMES = 25,
/**
* Nationality code
*/
NATIONALITY_CODE = 26,
/**
* Passport number
*/
PASSPORT_NUMBER = 27,
/**
* Invitation number
*/
INVITATION_NUMBER = 28,
/**
* Visa ID
*/
VISA_ID = 29,
/**
* Visa class
*/
VISA_CLASS = 30,
/**
* Visa subclass
*/
VISA_SUBCLASS = 31,
/**
* MRZ type
*/
MRZ_TYPE = 35,
/**
* Optional data
*/
OPTIONAL_DATA = 36,
/**
* Document class name
*/
DOCUMENT_CLASS_NAME = 37,
/**
* Issuing state name
*/
ISSUING_STATE_NAME = 38,
/**
* Place of issue
*/
PLACE_OF_ISSUE = 39,
/**
* Document number checksum
*/
DOCUMENT_NUMBER_CHECKSUM = 40,
/**
* Date of birth checksum
*/
DATE_OF_BIRTH_CHECKSUM = 41,
/**
* Date of expiry checksum
*/
DATE_OF_EXPIRY_CHECKSUM = 42,
/**
* Personal number checksum
*/
PERSONAL_NUMBER_CHECKSUM = 43,
/**
* Final checksum
*/
FINAL_CHECKSUM = 44,
/**
* Passport number checksum
*/
PASSPORT_NUMBER_CHECKSUM = 45,
/**
* Invitation number checksum
*/
INVITATION_NUMBER_CHECKSUM = 46,
/**
* Visa ID checksum
*/
VISA_ID_CHECKSUM = 47,
/**
* Surname and given names checksum
*/
SURNAME_AND_GIVEN_NAMES_CHECKSUM = 48,
/**
* Visa valid until checksum
*/
VISA_VALID_UNTIL_CHECKSUM = 49,
/**
* Other
*/
OTHER = 50,
/**
* MRZ strings
*/
MRZ_STRINGS = 51,
/**
* Name suffix
*/
NAME_SUFFIX = 52,
/**
* Name prefix
*/
NAME_PREFIX = 53,
/**
* Date of issue checksum
*/
DATE_OF_ISSUE_CHECKSUM = 54,
/**
* Date of issue check digit
*/
DATE_OF_ISSUE_CHECK_DIGIT = 55,
/**
* Document series
*/
DOCUMENT_SERIES = 56,
/**
* Registration number
*/
REG_CERT_REG_NUMBER = 57,
/**
* Vehicle model
*/
REG_CERT_CAR_MODEL = 58,
/**
* Vehicle color
*/
REG_CERT_CAR_COLOR = 59,
/**
* Vehicle body number
*/
REG_CERT_BODY_NUMBER = 60,
/**
* Vehicle type
*/
REG_CERT_CAR_TYPE = 61,
/**
* Max permissible weight
*/
REG_CERT_MAX_WEIGHT = 62,
/**
* Unladen mass
*/
REG_CERT_WEIGHT = 63,
/**
* Address: area
*/
ADDRESS_AREA = 64,
/**
* Address: state
*/
ADDRESS_STATE = 65,
/**
* Address: building
*/
ADDRESS_BUILDING = 66,
/**
* Address: house
*/
ADDRESS_HOUSE = 67,
/**
* Address: flat
*/
ADDRESS_FLAT = 68,
/**
* Place of registration
*/
PLACE_OF_REGISTRATION = 69,
/**
* Date of registration
*/
DATE_OF_REGISTRATION = 70,
/**
* Resident from
*/
RESIDENT_FROM = 71,
/**
* Resident until
*/
RESIDENT_UNTIL = 72,
/**
* Issuing authority code
*/
AUTHORITY_CODE = 73,
/**
* Place of birth: area
*/
PLACE_OF_BIRTH_AREA = 74,
/**
* Place of birth: state code
*/
PLACE_OF_BIRTH_STATE_CODE = 75,
/**
* Address: street
*/
ADDRESS_STREET = 76,
/**
* Address: city
*/
ADDRESS_CITY = 77,
/**
* Address: jurisdiction code
*/
ADDRESS_JURISDICTION_CODE = 78,
/**
* Address: postal code
*/
ADDRESS_POSTAL_CODE = 79,
/**
* Document number check digit
*/
DOCUMENT_NUMBER_CHECK_DIGIT = 80,
/**
* Date of birth check digit
*/
DATE_OF_BIRTH_CHECK_DIGIT = 81,
/**
* Date of expiry check digit
*/
DATE_OF_EXPIRY_CHECK_DIGIT = 82,
/**
* Personal number check digit
*/
PERSONAL_NUMBER_CHECK_DIGIT = 83,
/**
* Final check digit
*/
FINAL_CHECK_DIGIT = 84,
/**
* Passport number check digit
*/
PASSPORT_NUMBER_CHECK_DIGIT = 85,
/**
* Invitation number check digit
*/
INVITATION_NUMBER_CHECK_DIGIT = 86,
/**
* Visa ID check digit
*/
VISA_ID_CHECK_DIGIT = 87,
/**
* Surname and given names check digit
*/
SURNAME_AND_GIVEN_NAMES_CHECK_DIGIT = 88,
/**
* Visa valid until check digit
*/
VISA_VALID_UNTIL_CHECK_DIGIT = 89,
/**
* Permit class
*/
PERMIT_DL_CLASS = 90,
/**
* Permit expiry date
*/
PERMIT_DATE_OF_EXPIRY = 91,
/**
* Permit identifier
*/
PERMIT_IDENTIFIER = 92,
/**
* Permit issue date
*/
PERMIT_DATE_OF_ISSUE = 93,
/**
* Permit restriction code
*/
PERMIT_RESTRICTION_CODE = 94,
/**
* Permit endorsement code
*/
PERMIT_ENDORSED = 95,
/**
* Issue timestamp
*/
ISSUE_TIMESTAMP = 96,
/**
* Number of duplicates
*/
NUMBER_OF_DUPLICATES = 97,
/**
* Medical indicator codes
*/
MEDICAL_INDICATOR_CODES = 98,
/**
* Non-resident indicator
*/
NON_RESIDENT_INDICATOR = 99,
/**
* Visa type
*/
VISA_TYPE = 100,
/**
* Visa valid from
*/
VISA_VALID_FROM = 101,
/**
* Visa valid until
*/
VISA_VALID_UNTIL = 102,
/**
* Duration of stay
*/
DURATION_OF_STAY = 103,
/**
* Number of entries
*/
NUMBER_OF_ENTRIES = 104,
/**
* Day
*/
DAY = 105,
/**
* Month
*/
MONTH = 106,
/**
* Year
*/
YEAR = 107,
/**
* Unique customer identifier
*/
UNIQUE_CUSTOMER_IDENTIFIER = 108,
/**
* Commercial vehicle code
*/
COMMERCIAL_VEHICLE_CODES = 109,
/**
* AKA: date of birth
*/
AKA_DATE_OF_BIRTH = 110,
/**
* AKA: social insurance number
*/
AKA_SOCIAL_SECURITY_NUMBER = 111,
/**
* AKA: surname
*/
AKA_SURNAME = 112,
/**
* AKA: given name(s)
*/
AKA_GIVEN_NAMES = 113,
/**
* AKA: name suffix
*/
AKA_NAME_SUFFIX = 114,
/**
* AKA: name prefix
*/
AKA_NAME_PREFIX = 115,
/**
* Mailing address: street
*/
MAILING_ADDRESS_STREET = 116,
/**
* Mailing address: city
*/
MAILING_ADDRESS_CITY = 117,
/**
* Mailing address: jurisdiction code
*/
MAILING_ADDRESS_JURISDICTION_CODE = 118,
/**
* Mailing address: postal code
*/
MAILING_ADDRESS_POSTAL_CODE = 119,
/**
* Number for validation
*/
AUDIT_INFORMATION = 120,
/**
* Inventory number
*/
INVENTORY_NUMBER = 121,
/**
* Race ethnicity
*/
RACE_ETHNICITY = 122,
/**
* Jurisdiction vehicle class
*/
JURISDICTION_VEHICLE_CLASS = 123,
/**
* Jurisdiction endorsement code
*/
JURISDICTION_ENDORSEMENT_CODE = 124,
/**
* Jurisdiction restriction code
*/
JURISDICTION_RESTRICTION_CODE = 125,
/**
* Family name
*/
FAMILY_NAME = 126,
/**
* Given name(s) (national)
*/
GIVEN_NAMES_RUS = 127,
/**
* Visa ID (national)
*/
VISA_ID_RUS = 128,
/**
* Father's name
*/
FATHERS_NAME = 129,
/**
* Father's name (national)
*/
FATHERS_NAME_RUS = 130,
/**
* Surname and given names (national)
*/
SURNAME_AND_GIVEN_NAMES_RUS = 131,
/**
* Place of birth (national)
*/
PLACE_OF_BIRTH_RUS = 132,
/**
* Issuing authority (national)
*/
AUTHORITY_RUS = 133,
/**
* Issuing state code (numeric)
*/
ISSUING_STATE_CODE_NUMERIC = 134,
/**
* Nationality code (numeric)
*/
NATIONALITY_CODE_NUMERIC = 135,
/**
* Engine power
*/
ENGINE_POWER = 136,
/**
* Engine volume
*/
ENGINE_VOLUME = 137,
/**
* Chassis number
*/
CHASSIS_NUMBER = 138,
/**
* Engine number
*/
ENGINE_NUMBER = 139,
/**
* Engine model
*/
ENGINE_MODEL = 140,
/**
* Vehicle category
*/
VEHICLE_CATEGORY = 141,
/**
* Identity card number
*/
IDENTITY_CARD_NUMBER = 142,
/**
* Control number
*/
CONTROL_NUMBER = 143,
/**
* Parents' given names
*/
PARENTS_GIVEN_NAMES = 144,
/**
* Second surname
*/
SECOND_SURNAME = 145,
/**
* Middle name
*/
MIDDLE_NAME = 146,
/**
* Vehicle identification number
*/
REG_CERT_VIN = 147,
/**
* VIN check digit
*/
REG_CERT_VIN_CHECK_DIGIT = 148,
/**
* VIN checksum
*/
REG_CERT_VIN_CHECKSUM = 149,
/**
* Line 1 check digit
*/
LINE_1_CHECK_DIGIT = 150,
/**
* Line 2 check digit
*/
LINE_2_CHECK_DIGIT = 151,
/**
* Line 3 check digit
*/
LINE_3_CHECK_DIGIT = 152,
/**
* Line 1 checksum
*/
LINE_1_CHECKSUM = 153,
/**
* Line 2 checksum
*/
LINE_2_CHECKSUM = 154,
/**
* Line 3 checksum
*/
LINE_3_CHECKSUM = 155,
/**
* Registration number check digit
*/
REG_CERT_REG_NUMBER_CHECK_DIGIT = 156,
/**
* Registration number checksum
*/
REG_CERT_REG_NUMBER_CHECKSUM = 157,
/**
* Vehicle ITS code
*/
REG_CERT_VEHICLE_ITS_CODE = 158,
/**
* Card access number
*/
CARD_ACCESS_NUMBER = 159,
/**
* Marital status
*/
MARITAL_STATUS = 160,
/**
* Company name
*/
COMPANY_NAME = 161,
/**
* Special notes
*/
SPECIAL_NOTES = 162,
/**
* Spouse's surname
*/
SURNAME_OF_SPOUSE = 163,
/**
* Tracking number
*/
TRACKING_NUMBER = 164,
/**
* Booklet number
*/
BOOKLET_NUMBER = 165,
/**
* Children
*/
CHILDREN = 166,
/**
* Copy
*/
COPY = 167,
/**
* Serial number
*/
SERIAL_NUMBER = 168,
/**
* Dossier number
*/
DOSSIER_NUMBER = 169,
/**
* AKA: surname and given names
*/
AKA_SURNAME_AND_GIVEN_NAMES = 170,
/**
* Territorial validity
*/
TERRITORIAL_VALIDITY = 171,
/**
* MRZ strings with correct checksums
*/
MRZ_STRINGS_WITH_CORRECT_CHECK_SUMS = 172,
/**
* CDL restriction code
*/
DL_CDL_RESTRICTION_CODE = 173,
/**
* Date of 18th birthday
*/
DL_UNDER_18_DATE = 174,
/**
* DL record created
*/
DL_RECORD_CREATED = 175,
/**
* DL date of duplicate issue
*/
DL_DUPLICATE_DATE = 176,
/**
* Card type
*/
DL_ISSUE_TYPE = 177,
/**
* Military ID number
*/
MILITARY_BOOK_NUMBER = 178,
/**
* Destination
*/
DESTINATION = 179,
/**
* Blood group
*/
BLOOD_GROUP = 180,
/**
* Sequence number
*/
SEQUENCE_NUMBER = 181,
/**
* Body type
*/
REG_CERT_BODY_TYPE = 182,
/**
* Vehicle make
*/
REG_CERT_CAR_MARK = 183,
/**
* Transaction number
*/
TRANSACTION_NUMBER = 184,
/**
* Age
*/
AGE = 185,
/**
* Folio number
*/
FOLIO_NUMBER = 186,
/**
* Voter key
*/
VOTER_KEY = 187,
/**
* Address: municipality
*/
ADDRESS_MUNICIPALITY = 188,
/**
* Address: location
*/
ADDRESS_LOCATION = 189,
/**
* Section
*/
SECTION = 190,
/**
* OCR number
*/
OCR_NUMBER = 191,
/**
* Federal elections
*/
FEDERAL_ELECTIONS = 192,
/**
* Reference number
*/
REFERENCE_NUMBER = 193,
/**
* Optional data checksum
*/
OPTIONAL_DATA_CHECKSUM = 194,
/**
* Optional data check digit
*/
OPTIONAL_DATA_CHECK_DIGIT = 195,
/**
* Visa number
*/
VISA_NUMBER = 196,
/**
* Visa number checksum
*/
VISA_NUMBER_CHECKSUM = 197,
/**
* Visa number check digit
*/
VISA_NUMBER_CHECK_DIGIT = 198,
/**
* Voter
*/
VOTER = 199,
/**
* Type of the previous document
*/
PREVIOUS_TYPE = 200,
/**
* Field from MRZ
*/
FIELD_FROM_MRZ = 220,
/**
* Current date
*/
CURRENT_DATE = 221,
/**
* Status date of expiry
*/
STATUS_DATE_OF_EXPIRY = 251,
/**
* Banknote number
*/
BANKNOTE_NUMBER = 252,
/**
* CSC code
*/
CSC_CODE = 253,
/**
* Pseudonym
*/
ARTISTIC_NAME = 254,
/**
* Academic title
*/
ACADEMIC_TITLE = 255,
/**
* Address country
*/
ADDRESS_COUNTRY = 256,
/**
* Address ZIP code
*/
ADDRESS_ZIP_CODE = 257,
/**
* eID residence permit 1
*/
E_ID_RESIDENCE_PERMIT_1 = 258,
/**
* eID residence permit 2
*/
E_ID_RESIDENCE_PERMIT_2 = 259,
/**
* eID place of birth: street
*/
E_ID_PLACE_OF_BIRTH_STREET = 260,
/**
* eID place of birth: city
*/
E_ID_PLACE_OF_BIRTH_CITY = 261,
/**
* eID place of birth: state
*/
E_ID_PLACE_OF_BIRTH_STATE = 262,
/**
* eID place of birth: country
*/
E_ID_PLACE_OF_BIRTH_COUNTRY = 263,
/**
* eID place of birth: postal code
*/
E_ID_PLACE_OF_BIRTH_ZIP_CODE = 264,
/**
* CDL class
*/
CDL_CLASS = 265,
/**
* Date of 19th birthday
*/
DL_UNDER_19_DATE = 266,
/**
* Weight (pound)
*/
WEIGHT_POUNDS = 267,
/**
* Indicator of document limited duration
*/
LIMITED_DURATION_DOCUMENT_INDICATOR = 268,
/**
* Endorsement expiration date
*/
ENDORSEMENT_EXPIRATION_DATE = 269,
/**
* Revision date
*/
REVISION_DATE = 270,
/**
* Compliance type
*/
COMPLIANCE_TYPE = 271,
/**
* Family name truncation
*/
FAMILY_NAME_TRUNCATION = 272,
/**
* First name truncation
*/
FIRST_NAME_TRUNCATION = 273,
/**
* Middle name truncation
*/
MIDDLE_NAME_TRUNCATION = 274,
/**
* Exam date
*/
EXAM_DATE = 275,
/**
* Organization
*/
ORGANIZATION = 276,
/**
* Department
*/
DEPARTMENT = 277,
/**
* Pay grade
*/
PAY_GRADE = 278,
/**
* Rank
*/
RANK = 279,
/**
* Benefits n