diff --git a/src/Regula.DocumentReader.WebClient/Model/ChosenDocumentType.cs b/src/Regula.DocumentReader.WebClient/Model/ChosenDocumentType.cs index 0aef2cb..e46132f 100644 --- a/src/Regula.DocumentReader.WebClient/Model/ChosenDocumentType.cs +++ b/src/Regula.DocumentReader.WebClient/Model/ChosenDocumentType.cs @@ -34,8 +34,9 @@ public partial class ChosenDocumentType : IValidatableObject { /// - /// Gets or Sets RFIDPresence + /// Indication of the presence of an RFID chip in the document (electronic document indicator) /// + /// Indication of the presence of an RFID chip in the document (electronic document indicator) [DataMember(Name = "RFID_Presence", IsRequired = true, EmitDefaultValue = true)] public RfidLocation RFIDPresence { get; set; } /// @@ -50,7 +51,7 @@ protected ChosenDocumentType() { } /// Unique document type template identifier (Regula's internal numeric code) (required). /// A measure of the likelihood of correct recognition in the analysis of this type of document (required). /// Indicates if the document of the given type is rotated by 180 degrees (required). - /// rFIDPresence (required). + /// Indication of the presence of an RFID chip in the document (electronic document indicator) (required). /// fDSIDList. /// Combination of lighting scheme identifiers (Light enum) required to conduct OCR for this type of document (required). /// Set of authentication options provided for this type of document (combination of Authenticity enum) (required). diff --git a/src/Regula.DocumentReader.WebClient/Model/DetailsOptical.cs b/src/Regula.DocumentReader.WebClient/Model/DetailsOptical.cs index 4f84dd5..c03a9b9 100644 --- a/src/Regula.DocumentReader.WebClient/Model/DetailsOptical.cs +++ b/src/Regula.DocumentReader.WebClient/Model/DetailsOptical.cs @@ -34,44 +34,51 @@ public partial class DetailsOptical : IValidatableObject { /// - /// Gets or Sets OverallStatus + /// Overall optical checks combined status /// + /// Overall optical checks combined status [DataMember(Name = "overallStatus", IsRequired = true, EmitDefaultValue = true)] public CheckResult OverallStatus { get; set; } /// - /// Gets or Sets DocType + /// Status of document type recognition /// + /// Status of document type recognition [DataMember(Name = "docType", IsRequired = true, EmitDefaultValue = true)] public CheckResult DocType { get; set; } /// - /// Gets or Sets Expiry + /// Status of document expiration /// + /// Status of document expiration [DataMember(Name = "expiry", IsRequired = true, EmitDefaultValue = true)] public CheckResult Expiry { get; set; } /// - /// Gets or Sets ImageQA + /// Status of document image quality check /// + /// Status of document image quality check [DataMember(Name = "imageQA", IsRequired = true, EmitDefaultValue = true)] public CheckResult ImageQA { get; set; } /// - /// Gets or Sets Mrz + /// Status of document MRZ /// + /// Status of document MRZ [DataMember(Name = "mrz", IsRequired = true, EmitDefaultValue = true)] public CheckResult Mrz { get; set; } /// - /// Gets or Sets Security + /// Authenticity verification status /// + /// Authenticity verification status [DataMember(Name = "security", IsRequired = true, EmitDefaultValue = true)] public CheckResult Security { get; set; } /// - /// Gets or Sets Text + /// Status of text fields analysis /// + /// Status of text fields analysis [DataMember(Name = "text", IsRequired = true, EmitDefaultValue = true)] public CheckResult Text { get; set; } /// @@ -82,14 +89,14 @@ protected DetailsOptical() { } /// /// Initializes a new instance of the class. /// - /// overallStatus (required). - /// docType (required). - /// expiry (required). - /// imageQA (required). - /// mrz (required). + /// Overall optical checks combined status (required). + /// Status of document type recognition (required). + /// Status of document expiration (required). + /// Status of document image quality check (required). + /// Status of document MRZ (required). /// Number of processed pages in the document (required). - /// security (required). - /// text (required). + /// Authenticity verification status (required). + /// Status of text fields analysis (required). /// vds. public DetailsOptical(CheckResult overallStatus = default, CheckResult docType = default, CheckResult expiry = default, CheckResult imageQA = default, CheckResult mrz = default, int pagesCount = default, CheckResult security = default, CheckResult text = default, int? vds = default) { diff --git a/src/Regula.DocumentReader.WebClient/Model/DetailsRFID.cs b/src/Regula.DocumentReader.WebClient/Model/DetailsRFID.cs index 0c2698b..ddc5193 100644 --- a/src/Regula.DocumentReader.WebClient/Model/DetailsRFID.cs +++ b/src/Regula.DocumentReader.WebClient/Model/DetailsRFID.cs @@ -34,44 +34,51 @@ public partial class DetailsRFID : IValidatableObject { /// - /// Gets or Sets OverallStatus + /// Overall RFID checks combined status /// + /// Overall RFID checks combined status [DataMember(Name = "overallStatus", IsRequired = true, EmitDefaultValue = true)] public CheckResult OverallStatus { get; set; } /// - /// Gets or Sets AA + /// Active Authentication status /// + /// Active Authentication status [DataMember(Name = "AA", IsRequired = true, EmitDefaultValue = true)] public CheckResult AA { get; set; } /// - /// Gets or Sets BAC + /// Basic Access Control (BAC) status /// + /// Basic Access Control (BAC) status [DataMember(Name = "BAC", IsRequired = true, EmitDefaultValue = true)] public CheckResult BAC { get; set; } /// - /// Gets or Sets CA + /// Chip Authentication status /// + /// Chip Authentication status [DataMember(Name = "CA", IsRequired = true, EmitDefaultValue = true)] public CheckResult CA { get; set; } /// - /// Gets or Sets PA + /// Passive Authentication status /// + /// Passive Authentication status [DataMember(Name = "PA", IsRequired = true, EmitDefaultValue = true)] public CheckResult PA { get; set; } /// - /// Gets or Sets PACE + /// Password Authenticated Connection Establishment (PACE) status /// + /// Password Authenticated Connection Establishment (PACE) status [DataMember(Name = "PACE", IsRequired = true, EmitDefaultValue = true)] public CheckResult PACE { get; set; } /// - /// Gets or Sets TA + /// Terminal Authentication status /// + /// Terminal Authentication status [DataMember(Name = "TA", IsRequired = true, EmitDefaultValue = true)] public CheckResult TA { get; set; } /// @@ -82,13 +89,13 @@ protected DetailsRFID() { } /// /// Initializes a new instance of the class. /// - /// overallStatus (required). - /// aA (required). - /// bAC (required). - /// cA (required). - /// pA (required). - /// pACE (required). - /// tA (required). + /// Overall RFID checks combined status (required). + /// Active Authentication status (required). + /// Basic Access Control (BAC) status (required). + /// Chip Authentication status (required). + /// Passive Authentication status (required). + /// Password Authenticated Connection Establishment (PACE) status (required). + /// Terminal Authentication status (required). public DetailsRFID(CheckResult overallStatus = default, CheckResult aA = default, CheckResult bAC = default, CheckResult cA = default, CheckResult pA = default, CheckResult pACE = default, CheckResult tA = default) { this.OverallStatus = overallStatus; diff --git a/src/Regula.DocumentReader.WebClient/Model/DocVisualExtendedField.cs b/src/Regula.DocumentReader.WebClient/Model/DocVisualExtendedField.cs index 99ccb7e..299c5eb 100644 --- a/src/Regula.DocumentReader.WebClient/Model/DocVisualExtendedField.cs +++ b/src/Regula.DocumentReader.WebClient/Model/DocVisualExtendedField.cs @@ -40,7 +40,7 @@ protected DocVisualExtendedField() { } /// /// Initializes a new instance of the class. /// - /// fieldRect (required). + /// Coordinates of the text field in the normalized image of the document. Only for Result.VISUAL_TEXT and Result.MRZ_TEXT results. (required). /// wFieldType (required). /// Field symbolic name (null-terminated string) (required). /// Number of StringsResult array elements (required). @@ -64,8 +64,9 @@ public DocVisualExtendedField(RectangleCoordinates fieldRect = default, TextFiel } /// - /// Gets or Sets FieldRect + /// Coordinates of the text field in the normalized image of the document. Only for Result.VISUAL_TEXT and Result.MRZ_TEXT results. /// + /// Coordinates of the text field in the normalized image of the document. Only for Result.VISUAL_TEXT and Result.MRZ_TEXT results. [DataMember(Name = "FieldRect", IsRequired = true, EmitDefaultValue = true)] public RectangleCoordinates FieldRect { get; set; } diff --git a/src/Regula.DocumentReader.WebClient/Model/DocVisualExtendedFieldItem.cs b/src/Regula.DocumentReader.WebClient/Model/DocVisualExtendedFieldItem.cs index 76ae708..59a8373 100644 --- a/src/Regula.DocumentReader.WebClient/Model/DocVisualExtendedFieldItem.cs +++ b/src/Regula.DocumentReader.WebClient/Model/DocVisualExtendedFieldItem.cs @@ -40,7 +40,7 @@ protected DocVisualExtendedFieldItem() { } /// /// Initializes a new instance of the class. /// - /// fieldRect (required). + /// Coordinates of the text field in the normalized image of the document. Only for Result.VISUAL_TEXT and Result.MRZ_TEXT results. (required). public DocVisualExtendedFieldItem(RectangleCoordinates fieldRect = default) { // to ensure "fieldRect" is required (not null) @@ -52,8 +52,9 @@ public DocVisualExtendedFieldItem(RectangleCoordinates fieldRect = default) } /// - /// Gets or Sets FieldRect + /// Coordinates of the text field in the normalized image of the document. Only for Result.VISUAL_TEXT and Result.MRZ_TEXT results. /// + /// Coordinates of the text field in the normalized image of the document. Only for Result.VISUAL_TEXT and Result.MRZ_TEXT results. [DataMember(Name = "FieldRect", IsRequired = true, EmitDefaultValue = true)] public RectangleCoordinates FieldRect { get; set; } diff --git a/src/Regula.DocumentReader.WebClient/Model/DocumentFormat.cs b/src/Regula.DocumentReader.WebClient/Model/DocumentFormat.cs index 1d478d7..dc84022 100644 --- a/src/Regula.DocumentReader.WebClient/Model/DocumentFormat.cs +++ b/src/Regula.DocumentReader.WebClient/Model/DocumentFormat.cs @@ -67,6 +67,11 @@ public enum DocumentFormat /// ID3_X2 = 5, + /// + /// Enum ID2_TURKEY for value: 6 + /// + ID2_TURKEY = 6, + /// /// Enum ID1_90 for value: 10 /// diff --git a/src/Regula.DocumentReader.WebClient/Model/DocumentTypesCandidates.cs b/src/Regula.DocumentReader.WebClient/Model/DocumentTypesCandidates.cs index 26380f9..5ab7709 100644 --- a/src/Regula.DocumentReader.WebClient/Model/DocumentTypesCandidates.cs +++ b/src/Regula.DocumentReader.WebClient/Model/DocumentTypesCandidates.cs @@ -34,14 +34,15 @@ public partial class DocumentTypesCandidates : IValidatableObject { /// - /// Gets or Sets RecResult + /// Overall recognition result /// + /// Overall recognition result [DataMember(Name = "RecResult", EmitDefaultValue = false)] public DocumentTypeRecognitionResult? RecResult { get; set; } /// /// Initializes a new instance of the class. /// - /// recResult. + /// Overall recognition result. /// candidates. public DocumentTypesCandidates(DocumentTypeRecognitionResult? recResult = default, List candidates = default) { diff --git a/src/Regula.DocumentReader.WebClient/Model/DocumentTypesCandidatesList.cs b/src/Regula.DocumentReader.WebClient/Model/DocumentTypesCandidatesList.cs index c90681c..68aeb94 100644 --- a/src/Regula.DocumentReader.WebClient/Model/DocumentTypesCandidatesList.cs +++ b/src/Regula.DocumentReader.WebClient/Model/DocumentTypesCandidatesList.cs @@ -34,14 +34,15 @@ public partial class DocumentTypesCandidatesList : IValidatableObject { /// - /// Gets or Sets RecResult + /// Overall recognition result /// + /// Overall recognition result [DataMember(Name = "RecResult", EmitDefaultValue = false)] public DocumentTypeRecognitionResult? RecResult { get; set; } /// /// Initializes a new instance of the class. /// - /// recResult. + /// Overall recognition result. /// candidates. public DocumentTypesCandidatesList(DocumentTypeRecognitionResult? recResult = default, List candidates = default) { diff --git a/src/Regula.DocumentReader.WebClient/Model/EncryptedRCLItem.cs b/src/Regula.DocumentReader.WebClient/Model/EncryptedRCLItem.cs index a48b984..a8694e9 100644 --- a/src/Regula.DocumentReader.WebClient/Model/EncryptedRCLItem.cs +++ b/src/Regula.DocumentReader.WebClient/Model/EncryptedRCLItem.cs @@ -56,7 +56,7 @@ public EncryptedRCLItem(byte[] encryptedRCL = default) /// /// Base64 encoded data /* - [B@708d2ee3 + [B@36e73f43 */ [DataMember(Name = "EncryptedRCL", IsRequired = true, EmitDefaultValue = true)] public byte[] EncryptedRCL { get; set; } diff --git a/src/Regula.DocumentReader.WebClient/Model/EncryptedRCLResult.cs b/src/Regula.DocumentReader.WebClient/Model/EncryptedRCLResult.cs index 918b816..e4191ed 100644 --- a/src/Regula.DocumentReader.WebClient/Model/EncryptedRCLResult.cs +++ b/src/Regula.DocumentReader.WebClient/Model/EncryptedRCLResult.cs @@ -62,7 +62,7 @@ public EncryptedRCLResult(byte[] encryptedRCL = default, int? bufLength = defaul /// /// Base64 encoded data /* - [B@708d2ee3 + [B@36e73f43 */ [DataMember(Name = "EncryptedRCL", IsRequired = true, EmitDefaultValue = true)] public byte[] EncryptedRCL { get; set; } diff --git a/src/Regula.DocumentReader.WebClient/Model/FiberItem.cs b/src/Regula.DocumentReader.WebClient/Model/FiberItem.cs index 0ff7737..ec9d130 100644 --- a/src/Regula.DocumentReader.WebClient/Model/FiberItem.cs +++ b/src/Regula.DocumentReader.WebClient/Model/FiberItem.cs @@ -34,8 +34,9 @@ public partial class FiberItem : IValidatableObject { /// - /// Gets or Sets LightValue + /// For UV_Background authentication result type /// + /// For UV_Background authentication result type [DataMember(Name = "LightValue", EmitDefaultValue = false)] public Light? LightValue { get; set; } /// @@ -48,13 +49,13 @@ protected FiberItem() { } /// /// For UV_Fibers authenticity result type (required). /// Expected fibers number. For UV_Fibers authentication result type (required). - /// lightValue. + /// For UV_Background authentication result type. /// For UV_Background authentication result type. /// Coordinates of located areas for defined fibers type (required). /// Fibers width value for located areas (in pixels) (required). /// Fibers length value for located areas (in pixels) (required). /// Fibers value for areas (in pixels) (required). - /// Fibers color value (required). + /// Fibers color value. Example: [BLUE, GREEN, RED] (required). public FiberItem(int rectCount = default, int expectedCount = default, Light? lightValue = default, int? lightDisp = default, List rectArray = default, List width = default, List length = default, List area = default, List colorValues = default) { this.RectCount = rectCount; @@ -143,11 +144,11 @@ public FiberItem(int rectCount = default, int expectedCount = default, Light? li public List Area { get; set; } /// - /// Fibers color value + /// Fibers color value. Example: [BLUE, GREEN, RED] /// - /// Fibers color value + /// Fibers color value. Example: [BLUE, GREEN, RED] /* - ["BLUE","GREEN","RED"] + [233,120,201] */ [DataMember(Name = "ColorValues", IsRequired = true, EmitDefaultValue = true)] public List ColorValues { get; set; } diff --git a/src/Regula.DocumentReader.WebClient/Model/FiberResult.cs b/src/Regula.DocumentReader.WebClient/Model/FiberResult.cs index 004d47b..41de3a3 100644 --- a/src/Regula.DocumentReader.WebClient/Model/FiberResult.cs +++ b/src/Regula.DocumentReader.WebClient/Model/FiberResult.cs @@ -35,8 +35,9 @@ public partial class FiberResult : AuthenticityCheckResultItem, IValidatableObje { /// - /// Gets or Sets LightValue + /// For UV_Background authentication result type /// + /// For UV_Background authentication result type [DataMember(Name = "LightValue", EmitDefaultValue = false)] public Light? LightValue { get; set; } /// @@ -49,13 +50,13 @@ protected FiberResult() { } /// /// For UV_Fibers authenticity result type (required). /// Expected fibers number. For UV_Fibers authentication result type (required). - /// lightValue. + /// For UV_Background authentication result type. /// For UV_Background authentication result type. /// Coordinates of located areas for defined fibers type (required). /// Fibers width value for located areas (in pixels) (required). /// Fibers length value for located areas (in pixels) (required). /// Fibers value for areas (in pixels) (required). - /// Fibers color value (required). + /// Fibers color value. Example: [BLUE, GREEN, RED] (required). /// type (required) (default to AuthenticityResultType.UV_FIBERS). /// elementResult. /// elementDiagnose. @@ -148,11 +149,11 @@ public FiberResult(int rectCount = default, int expectedCount = default, Light? public List Area { get; set; } /// - /// Fibers color value + /// Fibers color value. Example: [BLUE, GREEN, RED] /// - /// Fibers color value + /// Fibers color value. Example: [BLUE, GREEN, RED] /* - [BLUE, GREEN, RED] + [233, 120, 201] */ [DataMember(Name = "ColorValues", IsRequired = true, EmitDefaultValue = true)] public List ColorValues { get; set; } diff --git a/src/Regula.DocumentReader.WebClient/Model/IdentItem.cs b/src/Regula.DocumentReader.WebClient/Model/IdentItem.cs index edee6a6..ca655b3 100644 --- a/src/Regula.DocumentReader.WebClient/Model/IdentItem.cs +++ b/src/Regula.DocumentReader.WebClient/Model/IdentItem.cs @@ -55,8 +55,8 @@ protected IdentItem() { } /// elementType (required). /// lightIndex (required). /// area. - /// image (required). - /// etalonImage (required). + /// Original image (required). + /// Reference image (required). /// areaList. /// elementID. public IdentItem(SecurityFeatureType elementType = default, Light lightIndex = default, RectangleCoordinates? area = default, ImageData image = default, ImageData etalonImage = default, AreaContainer? areaList = default, int? elementID = default) @@ -87,14 +87,16 @@ public IdentItem(SecurityFeatureType elementType = default, Light lightIndex = d public RectangleCoordinates? Area { get; set; } /// - /// Gets or Sets Image + /// Original image /// + /// Original image [DataMember(Name = "Image", IsRequired = true, EmitDefaultValue = true)] public ImageData Image { get; set; } /// - /// Gets or Sets EtalonImage + /// Reference image /// + /// Reference image [DataMember(Name = "EtalonImage", IsRequired = true, EmitDefaultValue = true)] public ImageData EtalonImage { get; set; } diff --git a/src/Regula.DocumentReader.WebClient/Model/IdentResult.cs b/src/Regula.DocumentReader.WebClient/Model/IdentResult.cs index d53354e..66fd884 100644 --- a/src/Regula.DocumentReader.WebClient/Model/IdentResult.cs +++ b/src/Regula.DocumentReader.WebClient/Model/IdentResult.cs @@ -56,8 +56,8 @@ protected IdentResult() { } /// elementType (required). /// lightIndex (required). /// area. - /// image (required). - /// etalonImage (required). + /// Original image (required). + /// Reference image (required). /// areaList. /// elementID. /// type (required) (default to AuthenticityResultType.IMAGE_PATTERN). @@ -92,14 +92,16 @@ public IdentResult(SecurityFeatureType elementType = default, Light lightIndex = public RectangleCoordinates? Area { get; set; } /// - /// Gets or Sets Image + /// Original image /// + /// Original image [DataMember(Name = "Image", IsRequired = true, EmitDefaultValue = true)] public ImageData Image { get; set; } /// - /// Gets or Sets EtalonImage + /// Reference image /// + /// Reference image [DataMember(Name = "EtalonImage", IsRequired = true, EmitDefaultValue = true)] public ImageData EtalonImage { get; set; } diff --git a/src/Regula.DocumentReader.WebClient/Model/ImageQualityCheckList.cs b/src/Regula.DocumentReader.WebClient/Model/ImageQualityCheckList.cs index 39922c5..e2c252c 100644 --- a/src/Regula.DocumentReader.WebClient/Model/ImageQualityCheckList.cs +++ b/src/Regula.DocumentReader.WebClient/Model/ImageQualityCheckList.cs @@ -34,8 +34,9 @@ public partial class ImageQualityCheckList : IValidatableObject { /// - /// Gets or Sets Result + /// Overall image quality status, combined from check statuses in the list. /// + /// Overall image quality status, combined from check statuses in the list. [DataMember(Name = "result", IsRequired = true, EmitDefaultValue = true)] public CheckResult Result { get; set; } /// @@ -46,7 +47,7 @@ protected ImageQualityCheckList() { } /// /// Initializes a new instance of the class. /// - /// result (required). + /// Overall image quality status, combined from check statuses in the list. (required). /// list (required). /// Number of List array elements (required). public ImageQualityCheckList(CheckResult result = default, List list = default, decimal count = default) diff --git a/src/Regula.DocumentReader.WebClient/Model/ImagesFieldValue.cs b/src/Regula.DocumentReader.WebClient/Model/ImagesFieldValue.cs index 9875554..104a6db 100644 --- a/src/Regula.DocumentReader.WebClient/Model/ImagesFieldValue.cs +++ b/src/Regula.DocumentReader.WebClient/Model/ImagesFieldValue.cs @@ -54,13 +54,13 @@ protected ImagesFieldValue() { } /// /// source (required). /// Base64 encoded image. - /// Base64 encoded image. + /// Only for images from RFID. Image as was originally stored in the RFID chip.. /// Original page index. /// Page index of the image from input list (required). /// lightIndex (required). /// Same as Result type, but used for safe parsing of not-described values. See Result type. (required) (default to 0). - /// fieldRect. - /// rfidOrigin. + /// Only for images from VISUAL. Coordinates of the image in the normalized image of the document.. + /// Only for images from RFID. Image location in RFID chip.. public ImagesFieldValue(Source source = default, string? value = default, string? originalValue = default, int? originalPageIndex = default, int pageIndex = default, Light lightIndex = default, int containerType = 0, RectangleCoordinates? fieldRect = default, RfidOrigin? rfidOrigin = default) { this.Source = source; @@ -85,9 +85,9 @@ public ImagesFieldValue(Source source = default, string? value = default, string public string? Value { get; set; } /// - /// Base64 encoded image + /// Only for images from RFID. Image as was originally stored in the RFID chip. /// - /// Base64 encoded image + /// Only for images from RFID. Image as was originally stored in the RFID chip. /* Base64 encoded image */ @@ -116,14 +116,16 @@ public ImagesFieldValue(Source source = default, string? value = default, string public int ContainerType { get; set; } /// - /// Gets or Sets FieldRect + /// Only for images from VISUAL. Coordinates of the image in the normalized image of the document. /// + /// Only for images from VISUAL. Coordinates of the image in the normalized image of the document. [DataMember(Name = "fieldRect", EmitDefaultValue = false)] public RectangleCoordinates? FieldRect { get; set; } /// - /// Gets or Sets RfidOrigin + /// Only for images from RFID. Image location in RFID chip. /// + /// Only for images from RFID. Image location in RFID chip. [DataMember(Name = "rfidOrigin", EmitDefaultValue = false)] public RfidOrigin? RfidOrigin { get; set; } diff --git a/src/Regula.DocumentReader.WebClient/Model/LicenseItem.cs b/src/Regula.DocumentReader.WebClient/Model/LicenseItem.cs index 7019ab7..41d3b64 100644 --- a/src/Regula.DocumentReader.WebClient/Model/LicenseItem.cs +++ b/src/Regula.DocumentReader.WebClient/Model/LicenseItem.cs @@ -56,7 +56,7 @@ public LicenseItem(byte[] license = default) /// /// Base64 encoded data /* - [B@7321f020 + [B@7d453cb0 */ [DataMember(Name = "License", IsRequired = true, EmitDefaultValue = true)] public byte[] License { get; set; } diff --git a/src/Regula.DocumentReader.WebClient/Model/LicenseResult.cs b/src/Regula.DocumentReader.WebClient/Model/LicenseResult.cs index 73100a8..6d1427a 100644 --- a/src/Regula.DocumentReader.WebClient/Model/LicenseResult.cs +++ b/src/Regula.DocumentReader.WebClient/Model/LicenseResult.cs @@ -62,7 +62,7 @@ public LicenseResult(byte[] license = default, int? bufLength = default, int? li /// /// Base64 encoded data /* - [B@7321f020 + [B@7d453cb0 */ [DataMember(Name = "License", IsRequired = true, EmitDefaultValue = true)] public byte[] License { get; set; } diff --git a/src/Regula.DocumentReader.WebClient/Model/Light.cs b/src/Regula.DocumentReader.WebClient/Model/Light.cs index f3de7be..e1decfe 100644 --- a/src/Regula.DocumentReader.WebClient/Model/Light.cs +++ b/src/Regula.DocumentReader.WebClient/Model/Light.cs @@ -57,15 +57,95 @@ public enum Light /// IR = 24, + /// + /// Enum TRANSMITTED for value: 32 + /// + TRANSMITTED = 32, + + /// + /// Enum TRANSMITTED_IR for value: 64 + /// + TRANSMITTED_IR = 64, + /// /// Enum UV for value: 128 /// UV = 128, + /// + /// Enum WHITE_UV for value: 134 + /// + WHITE_UV = 134, + + /// + /// Enum IR_LUMINESCENCE for value: 256 + /// + IR_LUMINESCENCE = 256, + /// /// Enum AXIAL_WHITE for value: 3072 /// - AXIAL_WHITE = 3072 + AXIAL_WHITE = 3072, + + /// + /// Enum IR_720 for value: 4096 + /// + IR_720 = 4096, + + /// + /// Enum IR_940 for value: 8192 + /// + IR_940 = 8192, + + /// + /// Enum ANTI_STOKES for value: 65536 + /// + ANTI_STOKES = 65536, + + /// + /// Enum UVC for value: 524288 + /// + UVC = 524288, + + /// + /// Enum UVB for value: 1048576 + /// + UVB = 1048576, + + /// + /// Enum WHITE_OBL for value: 2097152 + /// + WHITE_OBL = 2097152, + + /// + /// Enum WHITE_SPECIAL for value: 4194304 + /// + WHITE_SPECIAL = 4194304, + + /// + /// Enum OVD for value: 67108864 + /// + OVD = 67108864, + + /// + /// Enum IR_870_OBL for value: 268435456 + /// + IR_870_OBL = 268435456, + + /// + /// Enum HR_WHITE for value: 1073741830 + /// + HR_WHITE = 1073741830, + + /// + /// Enum HR_IR for value: 1073741848 + /// + HR_IR = 1073741848, + + /// + /// Enum HR_UV for value: 1073741952 + /// + HR_UV = 1073741952 } } diff --git a/src/Regula.DocumentReader.WebClient/Model/OneCandidate.cs b/src/Regula.DocumentReader.WebClient/Model/OneCandidate.cs index 9bf2acd..ffbc616 100644 --- a/src/Regula.DocumentReader.WebClient/Model/OneCandidate.cs +++ b/src/Regula.DocumentReader.WebClient/Model/OneCandidate.cs @@ -34,8 +34,9 @@ public partial class OneCandidate : IValidatableObject { /// - /// Gets or Sets RFIDPresence + /// Indication of the presence of an RFID chip in the document (electronic document indicator) /// + /// Indication of the presence of an RFID chip in the document (electronic document indicator) [DataMember(Name = "RFID_Presence", IsRequired = true, EmitDefaultValue = true)] public RfidLocation RFIDPresence { get; set; } /// @@ -50,7 +51,7 @@ protected OneCandidate() { } /// Unique document type template identifier (Regula's internal numeric code) (required). /// A measure of the likelihood of correct recognition in the analysis of this type of document (required). /// Indicates if the document of the given type is rotated by 180 degrees (required). - /// rFIDPresence (required). + /// Indication of the presence of an RFID chip in the document (electronic document indicator) (required). /// fDSIDList. /// Combination of lighting scheme identifiers (Light enum) required to conduct OCR for this type of document (required). /// Set of authentication options provided for this type of document (combination of Authenticity enum) (required). diff --git a/src/Regula.DocumentReader.WebClient/Model/ProcessParams.cs b/src/Regula.DocumentReader.WebClient/Model/ProcessParams.cs index 671373c..c723687 100644 --- a/src/Regula.DocumentReader.WebClient/Model/ProcessParams.cs +++ b/src/Regula.DocumentReader.WebClient/Model/ProcessParams.cs @@ -40,26 +40,30 @@ public partial class ProcessParams : IValidatableObject public Scenario Scenario { get; set; } /// - /// Gets or Sets MeasureSystem + /// This option allows you to set the system of measurement used for converting original values in document to output result values. Metric by default. /// + /// This option allows you to set the system of measurement used for converting original values in document to output result values. Metric by default. [DataMember(Name = "measureSystem", EmitDefaultValue = false)] public MeasureSystem? MeasureSystem { get; set; } /// - /// Gets or Sets LogLevel + /// When used together with 'log' parameter enabled, sets the level of logs detalization. 'INFO' by default. /// + /// When used together with 'log' parameter enabled, sets the level of logs detalization. 'INFO' by default. [DataMember(Name = "logLevel", EmitDefaultValue = false)] public LogLevel? LogLevel { get; set; } /// - /// Gets or Sets ForceDocFormat + /// Force use of specified document format when locating and recognizing document to reduce the number of candidates. /// + /// Force use of specified document format when locating and recognizing document to reduce the number of candidates. [DataMember(Name = "forceDocFormat", EmitDefaultValue = false)] public DocumentFormat? ForceDocFormat { get; set; } /// - /// Gets or Sets ConvertCase + /// This option allows output text case transformation. No changes applied by default to original values. /// + /// This option allows output text case transformation. No changes applied by default to original values. [DataMember(Name = "convertCase", EmitDefaultValue = false)] public TextPostProcessing? ConvertCase { get; set; } @@ -92,13 +96,13 @@ protected ProcessParams() { } /// If a document contains Visual zone, you can set the list of field types to extract. In this case, other fields are skipped during the processing, i.e. document recognition becomes faster. This filter is not applicable to the MRZ, barcode or RFID. If the fieldTypesFilter is empty, all fields are extracted. Empty by default. If fieldTypesFilter and fieldTypesIgnoreFilter are used simultaneously, fieldTypesFilter takes priority.. /// If a document contains a Visual zone, you can specify a list of field types that should be excluded from extraction. All field types listed in this array are skipped during processing, while the remaining fields are recognized. This filter is not applicable to the MRZ, barcode or RFID. If the fieldTypesIgnoreFilter is empty, all fields are extracted. Empty by default. If fieldTypesFilter and fieldTypesIgnoreFilter are used simultaneously, fieldTypesFilter takes priority.. /// 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).. - /// measureSystem. + /// This option allows you to set the system of measurement used for converting original values in document to output result values. Metric by default.. /// This parameter controls maximum resolution in dpi of output images. Resolution will remain original in case 0 is supplied. By default is set to return images in response with resolution not greater than 300 dpi for all scenarios except FullAuth. In FullAuth scenario this limit is 1000 dpi by default.. /// This option can be enabled 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. Disabled by default.. /// This option allows passing custom processing parameters that can be implemented in future without changing API.. /// This option allows setting additional custom configuration per document type. If recognized document has ID specified in config, processing adjusts according to designated configuration.. /// When enabled, results will contain transaction processing log. Disabled by default. - /// logLevel. + /// When used together with 'log' parameter enabled, sets the level of logs detalization. 'INFO' by default.. /// Force use of specific template ID and skip document type identification step.. /// When disabled, text field OCR will be done as is and then the recognized value will be matched to the field mask for validity. If enabled, we are trying to read a field value with maximum efforts to match the mask and provide a correctly formatted value, making assumptions based on the provided field mask in the template. Enabled by default.. /// When enabled, shorten the list of candidates to process during document detection in a single image process mode. Reduces processing time for specific backgrounds. Enabled by default.. @@ -108,7 +112,7 @@ protected ProcessParams() { } /// imageQa. /// When enabled, the image quality check status affects the document optical and overall status. Disabled by default.. /// Deprecated. Please use strictImageQuality instead. When enabled, image quality checks status affects document optical and overall status. Disabled by default.. - /// forceDocFormat. + /// Force use of specified document format when locating and recognizing document to reduce the number of candidates.. /// When enabled, no graphic fields will be cropped from document image. Disabled by default.. /// When enabled, all personal data will be forcibly removed from the logs. Disabled by default.. /// This option allows locating and cropping multiple documents from one image if enabled. Disabled by default.. @@ -117,7 +121,7 @@ protected ProcessParams() { } /// When enabled, returns input images in output. Disabled by default.. /// This option allows limiting MRZ formats to be recognized by specifying them in array.. /// This option can be disabled to stop parsing after barcode is read. Enabled by default.. - /// convertCase. + /// This option allows output text case transformation. No changes applied by default to original values.. /// When enabled, the Surname and GivenNames fields from MRZ will be divided into ft_First_Name, ft_Second_Name, ft_Third_Name, ft_Fourth_Name, ft_Last_Name fields. Disabled by default.. /// When enabled, OCR of perforated fields in the document template will not be performed. Enabled by default.. /// List of specific eligible document types from DocumentType enum to recognize from. You may, for example, specify only passports to be recognized by setting this property. Empty by default.. diff --git a/src/Regula.DocumentReader.WebClient/Model/Status.cs b/src/Regula.DocumentReader.WebClient/Model/Status.cs index e388c75..4e4cd9a 100644 --- a/src/Regula.DocumentReader.WebClient/Model/Status.cs +++ b/src/Regula.DocumentReader.WebClient/Model/Status.cs @@ -34,32 +34,37 @@ public partial class Status : IValidatableObject { /// - /// Gets or Sets OverallStatus + /// Overall checks status. Rootx status /// + /// Overall checks status. Rootx status [DataMember(Name = "overallStatus", IsRequired = true, EmitDefaultValue = true)] public CheckResult OverallStatus { get; set; } /// - /// Gets or Sets Optical + /// Overall optical checks combined status /// + /// Overall optical checks combined status [DataMember(Name = "optical", IsRequired = true, EmitDefaultValue = true)] public CheckResult Optical { get; set; } /// - /// Gets or Sets Portrait + /// Portrait comparison status /// + /// Portrait comparison status [DataMember(Name = "portrait", IsRequired = true, EmitDefaultValue = true)] public CheckResult Portrait { get; set; } /// - /// Gets or Sets Rfid + /// Overall RFID checks combined status /// + /// Overall RFID checks combined status [DataMember(Name = "rfid", IsRequired = true, EmitDefaultValue = true)] public CheckResult Rfid { get; set; } /// - /// Gets or Sets StopList + /// Stop list check status /// + /// Stop list check status [DataMember(Name = "stopList", IsRequired = true, EmitDefaultValue = true)] public CheckResult StopList { get; set; } @@ -82,11 +87,11 @@ protected Status() { } /// /// Initializes a new instance of the class. /// - /// overallStatus (required). - /// optical (required). - /// portrait (required). - /// rfid (required). - /// stopList (required). + /// Overall checks status. Rootx status (required). + /// Overall optical checks combined status (required). + /// Portrait comparison status (required). + /// Overall RFID checks combined status (required). + /// Stop list check status (required). /// detailsRFID. /// detailsOptical (required). /// age (required). diff --git a/src/Regula.DocumentReader.WebClient/Model/SymbolRecognitionResult.cs b/src/Regula.DocumentReader.WebClient/Model/SymbolRecognitionResult.cs index b3f137f..d889e73 100644 --- a/src/Regula.DocumentReader.WebClient/Model/SymbolRecognitionResult.cs +++ b/src/Regula.DocumentReader.WebClient/Model/SymbolRecognitionResult.cs @@ -40,7 +40,7 @@ protected SymbolRecognitionResult() { } /// /// Initializes a new instance of the class. /// - /// symbolRect. + /// Coordinates of the symbol in the normalized image of the document. /// Number of significant elements of ListOfCandidates array (required). /// Array of candidate characters. Sorted in descending order of recognition probabilities (the first element has highest probability) (required). /// baseLineBottom. @@ -60,8 +60,9 @@ public SymbolRecognitionResult(RectangleCoordinates? symbolRect = default, decim } /// - /// Gets or Sets SymbolRect + /// Coordinates of the symbol in the normalized image of the document /// + /// Coordinates of the symbol in the normalized image of the document [DataMember(Name = "SymbolRect", EmitDefaultValue = false)] public RectangleCoordinates? SymbolRect { get; set; } diff --git a/src/Regula.DocumentReader.WebClient/Model/Text.cs b/src/Regula.DocumentReader.WebClient/Model/Text.cs index d368856..ae9c490 100644 --- a/src/Regula.DocumentReader.WebClient/Model/Text.cs +++ b/src/Regula.DocumentReader.WebClient/Model/Text.cs @@ -34,20 +34,23 @@ public partial class Text : IValidatableObject { /// - /// Gets or Sets Status + /// Overall status of all checks from all text fields /// + /// Overall status of all checks from all text fields [DataMember(Name = "status", IsRequired = true, EmitDefaultValue = true)] public CheckResult Status { get; set; } /// - /// Gets or Sets ValidityStatus + /// Overall status of validity from all text fields from all sources /// + /// Overall status of validity from all text fields from all sources [DataMember(Name = "validityStatus", IsRequired = true, EmitDefaultValue = true)] public CheckResult ValidityStatus { get; set; } /// - /// Gets or Sets ComparisonStatus + /// Overall status of data comparison from different sources for each text field /// + /// Overall status of data comparison from different sources for each text field [DataMember(Name = "comparisonStatus", IsRequired = true, EmitDefaultValue = true)] public CheckResult ComparisonStatus { get; set; } /// @@ -58,9 +61,9 @@ protected Text() { } /// /// Initializes a new instance of the class. /// - /// status (required). - /// validityStatus (required). - /// comparisonStatus (required). + /// Overall status of all checks from all text fields (required). + /// Overall status of validity from all text fields from all sources (required). + /// Overall status of data comparison from different sources for each text field (required). /// Date format (required). /// fieldList (required). /// availableSourceList (required). diff --git a/src/Regula.DocumentReader.WebClient/Model/TextAvailableSource.cs b/src/Regula.DocumentReader.WebClient/Model/TextAvailableSource.cs index f06c88e..d97aae9 100644 --- a/src/Regula.DocumentReader.WebClient/Model/TextAvailableSource.cs +++ b/src/Regula.DocumentReader.WebClient/Model/TextAvailableSource.cs @@ -40,8 +40,9 @@ public partial class TextAvailableSource : IValidatableObject public Source Source { get; set; } /// - /// Gets or Sets ValidityStatus + /// Overall status of validity from all fields for given source /// + /// Overall status of validity from all fields for given source [DataMember(Name = "validityStatus", IsRequired = true, EmitDefaultValue = true)] public CheckResult ValidityStatus { get; set; } /// @@ -53,7 +54,7 @@ protected TextAvailableSource() { } /// Initializes a new instance of the class. /// /// source (required). - /// validityStatus (required). + /// Overall status of validity from all fields for given source (required). /// Same as Result type, but used for safe parsing of not-described values. See Result type. (default to 0). public TextAvailableSource(Source source = default, CheckResult validityStatus = default, int? containerType = 0) { diff --git a/src/Regula.DocumentReader.WebClient/Model/TextField.cs b/src/Regula.DocumentReader.WebClient/Model/TextField.cs index 9e76bfb..08477aa 100644 --- a/src/Regula.DocumentReader.WebClient/Model/TextField.cs +++ b/src/Regula.DocumentReader.WebClient/Model/TextField.cs @@ -46,20 +46,23 @@ public partial class TextField : IValidatableObject public LCID Lcid { get; set; } /// - /// Gets or Sets Status + /// Overall status of all checks from all values /// + /// Overall status of all checks from all values [DataMember(Name = "status", IsRequired = true, EmitDefaultValue = true)] public CheckResult Status { get; set; } /// - /// Gets or Sets ValidityStatus + /// Overall status of validity from all values /// + /// Overall status of validity from all values [DataMember(Name = "validityStatus", IsRequired = true, EmitDefaultValue = true)] public CheckResult ValidityStatus { get; set; } /// - /// Gets or Sets ComparisonStatus + /// Overall status of data comparison from different sources /// + /// Overall status of data comparison from different sources [DataMember(Name = "comparisonStatus", IsRequired = true, EmitDefaultValue = true)] public CheckResult ComparisonStatus { get; set; } /// @@ -74,9 +77,9 @@ protected TextField() { } /// Field name. Only use to search values for fields with fieldType=50(other). In general, use fieldType for lookup. (required). /// lcid (required). /// LCID name. - /// status (required). - /// validityStatus (required). - /// comparisonStatus (required). + /// Overall status of all checks from all values (required). + /// Overall status of validity from all values (required). + /// Overall status of data comparison from different sources (required). /// The most confidence value, selected from valueList (required). /// valueList (required). /// Validity of all field values for given source. If there are two values on different pages for one field-source pair, then validity also will include logical match checking. If such values do not match, validity will return error. (required). diff --git a/src/Regula.DocumentReader.WebClient/Model/TextFieldValue.cs b/src/Regula.DocumentReader.WebClient/Model/TextFieldValue.cs index 26f368e..c84eb67 100644 --- a/src/Regula.DocumentReader.WebClient/Model/TextFieldValue.cs +++ b/src/Regula.DocumentReader.WebClient/Model/TextFieldValue.cs @@ -59,8 +59,8 @@ protected TextFieldValue() { } /// originalSymbols. /// Page index of the image from input list (required). /// Min recognition probability. Combined minimum probability from single characters probabilities (required). - /// fieldRect. - /// rfidOrigin. + /// Only for visual and mrz results. Coordinates of the rectangle region on a document image(result type 1). Represented by two points - (left, top) + (right, bottom). + /// Only for RFID images. Text location in RFID chip.. /// Same as Result type, but used for safe parsing of not-described values. See Result type. (default to 0). public TextFieldValue(Source source = default, string value = default, string? originalValue = default, CheckResult originalValidity = default, List originalSymbols = default, int pageIndex = default, int probability = default, RectangleCoordinates? fieldRect = default, RfidOrigin? rfidOrigin = default, int? containerType = 0) { @@ -116,14 +116,16 @@ public TextFieldValue(Source source = default, string value = default, string? o public int Probability { get; set; } /// - /// Gets or Sets FieldRect + /// Only for visual and mrz results. Coordinates of the rectangle region on a document image(result type 1). Represented by two points - (left, top) + (right, bottom) /// + /// Only for visual and mrz results. Coordinates of the rectangle region on a document image(result type 1). Represented by two points - (left, top) + (right, bottom) [DataMember(Name = "fieldRect", EmitDefaultValue = false)] public RectangleCoordinates? FieldRect { get; set; } /// - /// Gets or Sets RfidOrigin + /// Only for RFID images. Text location in RFID chip. /// + /// Only for RFID images. Text location in RFID chip. [DataMember(Name = "rfidOrigin", EmitDefaultValue = false)] public RfidOrigin? RfidOrigin { get; set; }