Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -191,7 +191,7 @@ public ChosenDocumentType rfIDPresence(@javax.annotation.Nonnull RfidLocation rf
}

/**
* Get rfIDPresence
* Indication of the presence of an RFID chip in the document (electronic document indicator)
*
* @return rfIDPresence
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ public DetailsOptical overallStatus(@javax.annotation.Nonnull CheckResult overal
}

/**
* Get overallStatus
* Overall optical checks combined status
*
* @return overallStatus
*/
Expand All @@ -113,7 +113,7 @@ public DetailsOptical docType(@javax.annotation.Nonnull CheckResult docType) {
}

/**
* Get docType
* Status of document type recognition
*
* @return docType
*/
Expand All @@ -132,7 +132,7 @@ public DetailsOptical expiry(@javax.annotation.Nonnull CheckResult expiry) {
}

/**
* Get expiry
* Status of document expiration
*
* @return expiry
*/
Expand All @@ -151,7 +151,7 @@ public DetailsOptical imageQA(@javax.annotation.Nonnull CheckResult imageQA) {
}

/**
* Get imageQA
* Status of document image quality check
*
* @return imageQA
*/
Expand All @@ -170,7 +170,7 @@ public DetailsOptical mrz(@javax.annotation.Nonnull CheckResult mrz) {
}

/**
* Get mrz
* Status of document MRZ
*
* @return mrz
*/
Expand Down Expand Up @@ -208,7 +208,7 @@ public DetailsOptical security(@javax.annotation.Nonnull CheckResult security) {
}

/**
* Get security
* Authenticity verification status
*
* @return security
*/
Expand All @@ -227,7 +227,7 @@ public DetailsOptical text(@javax.annotation.Nonnull CheckResult text) {
}

/**
* Get text
* Status of text fields analysis
*
* @return text
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ public DetailsRFID overallStatus(@javax.annotation.Nonnull CheckResult overallSt
}

/**
* Get overallStatus
* Overall RFID checks combined status
*
* @return overallStatus
*/
Expand All @@ -101,7 +101,7 @@ public DetailsRFID AA(@javax.annotation.Nonnull CheckResult AA) {
}

/**
* Get AA
* Active Authentication status
*
* @return AA
*/
Expand All @@ -120,7 +120,7 @@ public DetailsRFID BAC(@javax.annotation.Nonnull CheckResult BAC) {
}

/**
* Get BAC
* Basic Access Control (BAC) status
*
* @return BAC
*/
Expand All @@ -139,7 +139,7 @@ public DetailsRFID CA(@javax.annotation.Nonnull CheckResult CA) {
}

/**
* Get CA
* Chip Authentication status
*
* @return CA
*/
Expand All @@ -158,7 +158,7 @@ public DetailsRFID PA(@javax.annotation.Nonnull CheckResult PA) {
}

/**
* Get PA
* Passive Authentication status
*
* @return PA
*/
Expand All @@ -177,7 +177,7 @@ public DetailsRFID PACE(@javax.annotation.Nonnull CheckResult PACE) {
}

/**
* Get PACE
* Password Authenticated Connection Establishment (PACE) status
*
* @return PACE
*/
Expand All @@ -196,7 +196,7 @@ public DetailsRFID TA(@javax.annotation.Nonnull CheckResult TA) {
}

/**
* Get TA
* Terminal Authentication status
*
* @return TA
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,8 @@ public DocVisualExtendedField fieldRect(
}

/**
* Get fieldRect
* Coordinates of the text field in the normalized image of the document. Only for
* Result.VISUAL_TEXT and Result.MRZ_TEXT results.
*
* @return fieldRect
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,8 @@ public DocVisualExtendedFieldItem fieldRect(
}

/**
* Get fieldRect
* Coordinates of the text field in the normalized image of the document. Only for
* Result.VISUAL_TEXT and Result.MRZ_TEXT results.
*
* @return fieldRect
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,9 @@ public enum DocumentFormat {
/** ID3 double document format */
ID3_X2(5),

/** Turkey ID2 card */
ID2_TURKEY(6),

/** ID1 format document rotated 90 ° */
ID1_90(10),

Expand All @@ -53,7 +56,7 @@ public enum DocumentFormat {
/** ID1 format document rotated 270 ° */
ID1_270(12),

/** ID2 format document rotated 90 ° */
/** ID2 format document rotated 180 ° */
ID2_180(13),

/** ID3 format document rotated 180 ° */
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ public DocumentTypesCandidates recResult(
}

/**
* Get recResult
* Overall recognition result
*
* @return recResult
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ public DocumentTypesCandidatesList recResult(
}

/**
* Get recResult
* Overall recognition result
*
* @return recResult
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -135,7 +135,7 @@ public FiberItem lightValue(@javax.annotation.Nullable Light lightValue) {
}

/**
* Get lightValue
* For UV_Background authentication result type
*
* @return lightValue
*/
Expand Down Expand Up @@ -289,7 +289,7 @@ public FiberItem addColorValuesItem(Integer colorValuesItem) {
}

/**
* Fibers color value
* Fibers color value. Example: [BLUE, GREEN, RED]
*
* @return colorValues
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -134,7 +134,7 @@ public FiberResult lightValue(@javax.annotation.Nullable Light lightValue) {
}

/**
* Get lightValue
* For UV_Background authentication result type
*
* @return lightValue
*/
Expand Down Expand Up @@ -288,7 +288,7 @@ public FiberResult addColorValuesItem(Integer colorValuesItem) {
}

/**
* Fibers color value
* Fibers color value. Example: [BLUE, GREEN, RED]
*
* @return colorValues
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -139,7 +139,7 @@ public IdentItem image(@javax.annotation.Nonnull ImageData image) {
}

/**
* Get image
* Original image
*
* @return image
*/
Expand All @@ -158,7 +158,7 @@ public IdentItem etalonImage(@javax.annotation.Nonnull ImageData etalonImage) {
}

/**
* Get etalonImage
* Reference image
*
* @return etalonImage
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -139,7 +139,7 @@ public IdentResult image(@javax.annotation.Nonnull ImageData image) {
}

/**
* Get image
* Original image
*
* @return image
*/
Expand All @@ -158,7 +158,7 @@ public IdentResult etalonImage(@javax.annotation.Nonnull ImageData etalonImage)
}

/**
* Get etalonImage
* Reference image
*
* @return etalonImage
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ public ImageQualityCheckList result(@javax.annotation.Nonnull CheckResult result
}

/**
* Get result
* Overall image quality status, combined from check statuses in the list.
*
* @return result
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -132,7 +132,7 @@ public ImagesFieldValue originalValue(@javax.annotation.Nullable String original
}

/**
* Base64 encoded image
* Only for images from RFID. Image as was originally stored in the RFID chip.
*
* @return originalValue
*/
Expand Down Expand Up @@ -227,7 +227,7 @@ public ImagesFieldValue fieldRect(@javax.annotation.Nullable RectangleCoordinate
}

/**
* Get fieldRect
* Only for images from VISUAL. Coordinates of the image in the normalized image of the document.
*
* @return fieldRect
*/
Expand All @@ -246,7 +246,7 @@ public ImagesFieldValue rfidOrigin(@javax.annotation.Nullable RfidOrigin rfidOri
}

/**
* Get rfidOrigin
* Only for images from RFID. Image location in RFID chip.
*
* @return rfidOrigin
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,11 +38,59 @@ public enum Light {
/** Infrared */
IR(24),

/** Transmitted */
TRANSMITTED(32),

/** Transmitted IR */
TRANSMITTED_IR(64),

/** Ultraviolet */
UV(128),

/** White UV */
WHITE_UV(134),

/** IR luminescence */
IR_LUMINESCENCE(256),

/** Axial white */
AXIAL_WHITE(3072);
AXIAL_WHITE(3072),

/** IR720 */
IR_720(4096),

/** IR940 */
IR_940(8192),

/** Transmitted AntiStokes */
ANTI_STOKES(65536),

/** UVС 254 (mod. 88X0) */
UVC(524288),

/** UVB 313 (mod. 88X0) */
UVB(1048576),

/** White oblique light */
WHITE_OBL(2097152),

/** For internal use */
WHITE_SPECIAL(4194304),

/** OVD light for hologram visualization */
OVD(67108864),

/** Light IR 870 oblique */
IR_870_OBL(268435456),

/** HR white */
HR_WHITE(1073741830),

/** HR IR */
HR_IR(1073741848),

/** HR UV */
HR_UV(1073741952);

private Integer value;

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -191,7 +191,7 @@ public OneCandidate rfIDPresence(@javax.annotation.Nonnull RfidLocation rfIDPres
}

/**
* Get rfIDPresence
* Indication of the presence of an RFID chip in the document (electronic document indicator)
*
* @return rfIDPresence
*/
Expand Down
Loading
Loading