github.com/moov-io/imagecashletter@v0.10.1/client/model_image_view_analysis.go (about)

     1  /*
     2   * ImageCashLetter API
     3   *
     4   * Moov Image Cash Letter (ICL) implements an HTTP API for creating, parsing, and validating ImageCashLetter files.
     5   *
     6   * API version: v1
     7   * Generated by: OpenAPI Generator (https://openapi-generator.tech)
     8   */
     9  
    10  package openapi
    11  
    12  // ImageViewAnalysis struct for ImageViewAnalysis
    13  type ImageViewAnalysis struct {
    14  	// ImageViewAnalysis ID
    15  	ID string `json:"ID,omitempty"`
    16  	// GlobalImageQuality is a code that indicates whether the image view was tested for any of the conditions related to image quality defined in the Image Quality Information.  * `0` -  The image was not tested for any of the image quality conditions * `1` -  The image was tested and one or more image quality conditions were reported * `2` -  The image was tested and no image quality conditions were reported
    17  	GlobalImageQuality int32 `json:"globalImageQuality,omitempty"`
    18  	// GlobalImageUsability is a code that indicates whether the image view was tested for any of the conditions related to image usability defined in the Image Usability Information.  * `0` -  The image was not tested for any of the image quality conditions * `1` -  The image was tested and one or more image quality conditions were reported * `2` -  The image was tested and no image quality conditions were reported
    19  	GlobalImageUsability int32 `json:"globalImageUsability,omitempty"`
    20  	// ImagingBankSpecificTest designates the capture institution may be able to perform specific tests that can indicate a potentially problematic image view caused by conditions other than those listed in the Image Quality and Image Usability Information fields. By mutual agreement, clearing partners can use the UserField to report the presence or absence of additional image conditions found through tests that are particular to the specific imaging institution. The meaning and interpretation of the User Field data must be understood and agreed upon between participants.   * `0` -  The image was not tested for any of the image quality conditions * `1` -  The image was tested and one or more image quality conditions were reported * `2` -  The image was tested and no image quality conditions were reported
    21  	ImagingBankSpecificTest int32 `json:"imagingBankSpecificTest,omitempty"`
    22  	// PartialImage is a code that indicates if only a portion of the image view is represented digitally while the other portion is suspected to be missing or corrupt.  * `0` -  The image was not tested for any of the image quality conditions * `1` -  The image was tested and one or more image quality conditions were reported * `2` -  The image was tested and no image quality conditions were reported
    23  	PartialImage int32 `json:"partialImage,omitempty"`
    24  	// ExcessiveImageSkew is a code that indicates if the image view skew exceeds an acceptable value. This value is specific to the imaging institution’s own defined requirements and/or constraints.  * `0` -  The image was not tested for any of the image quality conditions * `1` -  The image was tested and one or more image quality conditions were reported * `2` -  The image was tested and no image quality conditions were reported
    25  	ExcessiveImageSkew int32 `json:"excessiveImageSkew,omitempty"`
    26  	// PiggybackImage is a code that indicates if a “piggyback” condition has been detected. With a “piggyback” condition, the intended image view may be extended, obscured, or replaced by image(s) of additional document(s). A piggyback occurs when two or more documents are fed together and captured as one document when only a single document should have been fed and captured.  * `0` -  The image was not tested for any of the image quality conditions * `1` -  The image was tested and one or more image quality conditions were reported * `2` -  The image was tested and no image quality conditions were reported
    27  	PiggybackImage int32 `json:"piggybackImage,omitempty"`
    28  	// TooLightOrTooDark is a code that indicates if the image view is too light or too dark. The value is specific to the imaging institution’s own defined requirements and/or constraints.  * `0` -  The image was not tested for any of the image quality conditions * `1` -  The image was tested and one or more image quality conditions were reported * `2` -  The image was tested and no image quality conditions were reported
    29  	TooLightOrTooDark int32 `json:"tooLightOrTooDark,omitempty"`
    30  	// StreaksAndOrBands is a A code that indicates if the image view is likely corrupted due to streaks and/or bands. Streaks and bands can be caused by such problems as dirt, dust, ink, or debris on a lens or in the optical path, and failures in the imaging equipment scanner.  * `0` -  The image was not tested for any of the image quality conditions * `1` -  The image was tested and one or more image quality conditions were reported * `2` -  The image was tested and no image quality conditions were reported
    31  	StreaksAndOrBands int32 `json:"streaksAndOrBands,omitempty"`
    32  	// BelowMinimumImageSize is a code that indicates if the size of the compressed image view is below an acceptable value. The value is specific to the imaging institution’s own defined requirements and/or constraints.  * `0` -  The image was not tested for any of the image quality conditions * `1` -  The image was tested and one or more image quality conditions were reported * `2` -  The image was tested and no image quality conditions were reported
    33  	BelowMinimumImageSize int32 `json:"belowMinimumImageSize,omitempty"`
    34  	// ExceedsMaximumImageSize is a code that indicates if the size of the compressed image view is above an acceptable value. The value is specific to the imaging institution’s own defined requirements and/or constraints.  * `0` -  The image was not tested for any of the image quality conditions * `1` -  The image was tested and one or more image quality conditions were reported * `2` -  The image was tested and no image quality conditions were reported
    35  	ExceedsMaximumImageSize int32 `json:"exceedsMaximumImageSize,omitempty"`
    36  	// ImageEnabledPOD is a code that indicates if the image view was used within an image-enabled POD (Proof of Deposit) application.  * `0` -  The image was not tested for any of the image quality conditions * `1` -  The image was tested and one or more image quality conditions were reported * `2` -  The image was tested and no image quality conditions were reported
    37  	ImageEnabledPOD int32 `json:"imageEnabledPOD,omitempty"`
    38  	// SourceDocumentBad is a code that indicates if it is possible to obtain a better image from the source document when it is known that the current image of the document is unusable.  * `0` -  The image was not tested for any of the image quality conditions * `1` -  The image was tested and one or more image quality conditions were reported * `2` -  The image was tested and no image quality conditions were reported
    39  	SourceDocumentBad int32 `json:"sourceDocumentBad,omitempty"`
    40  	// DateUsability is a code that indicates if the date Area of Interest is usable and readable from the image. The definition of the Area of Interest for image usability testing purposes is specific to the imaging institution's own defined requirements and/or constraint  * `0` -  The image was not tested for any of the image quality conditions * `1` -  The image was tested and one or more image quality conditions were reported * `2` -  The image was tested and no image quality conditions were reported
    41  	DateUsability int32 `json:"dateUsability,omitempty"`
    42  	// PayeeUsability is a code that indicates if the payee name Area of Interest is usable and readable from the image. The definition of the Area of Interest for image usability testing purposes is specific to the imaging institution's own defined requirements and/or constraints.  * `0` -  The image was not tested for any of the image quality conditions * `1` -  The image was tested and one or more image quality conditions were reported * `2` -  The image was tested and no image quality conditions were reported
    43  	PayeeUsability int32 `json:"payeeUsability,omitempty"`
    44  	// ConvenienceAmountUsability is a code that indicates if the convenience amount Area of Interest is usable and readable from the image. The definition of the Area of Interest for image usability testing purposes is specific to the imaging institution's own defined requirements and/or constraints.  * `0` -  The image was not tested for any of the image quality conditions * `1` -  The image was tested and one or more image quality conditions were reported * `2` -  The image was tested and no image quality conditions were reported
    45  	ConvenienceAmountUsability int32 `json:"convenienceAmountUsability,omitempty"`
    46  	// AmountInWordsUsability is a code that indicates if the amount in words (legal amount) Area of Interest is usable and readable from the image. The definition of the Area of Interest for image usability testing purposes is specific to the imaging institution's own defined requirements and/or constraints.  * `0` -  The image was not tested for any of the image quality conditions * `1` -  The image was tested and one or more image quality conditions were reported * `2` -  The image was tested and no image quality conditions were reported
    47  	AmountInWordsUsability int32 `json:"amountInWordsUsability,omitempty"`
    48  	// SignatureUsability is a code that indicates if the signature Area of Interest is usable and readable from the image. The definition of the Area of Interest for image usability testing purposes is specific to the imaging institution's own defined requirements and/or constraints.  * `0` -  The image was not tested for any of the image quality conditions * `1` -  The image was tested and one or more image quality conditions were reported * `2` -  The image was tested and no image quality conditions were reported
    49  	SignatureUsability int32 `json:"signatureUsability,omitempty"`
    50  	// PayorNameAddressUsability is a code that indicates if the payor name and address Area of Interest is usable and readable from the image. The definition of the Area of Interest for image usability testing purposes is specific to the imaging institution's own defined requirements and/or constraints.  * `0` -  The image was not tested for any of the image quality conditions * `1` -  The image was tested and one or more image quality conditions were reported * `2` -  The image was tested and no image quality conditions were reported
    51  	PayorNameAddressUsability int32 `json:"payorNameAddressUsability,omitempty"`
    52  	// MICRLineUsability is a code that indicates if the MICR line Area of Interest is usable and readable from the image. The definition of the Area of Interest for image usability testing purposes is specific to the imaging institution's own defined requirements and/or constraints.  * `0` -  The image was not tested for any of the image quality conditions * `1` -  The image was tested and one or more image quality conditions were reported * `2` -  The image was tested and no image quality conditions were reported
    53  	MICRLineUsability int32 `json:"mICRLineUsability,omitempty"`
    54  	// MemoLineUsability is a code that indicates if the memo line Area of Interest is usable and readable from the image. The definition of the Area of Interest for image usability testing purposes is specific to the imaging institution's own defined requirements and/or constraints.  * `0` -  The image was not tested for any of the image quality conditions * `1` -  The image was tested and one or more image quality conditions were reported * `2` -  The image was tested and no image quality conditions were reported
    55  	MemoLineUsability int32 `json:"memoLineUsability,omitempty"`
    56  	// PayorBankNameAddressUsability is a code that indicates if the payor bank name and address Area of Interest is usable and readable from the image. The definition of the Area of Interest for image usability testing purposes is specific to the imaging institution's own defined requirements and/or constraints.  * `0` -  The image was not tested for any of the image quality conditions * `1` -  The image was tested and one or more image quality conditions were reported * `2` -  The image was tested and no image quality conditions were reported
    57  	PayorBankNameAddressUsability int32 `json:"payorBankNameAddressUsability,omitempty"`
    58  	// PayeeEndorsementUsability is a code that indicates if the payee endorsement Area of Interest is usable and readable from the image. The definition of the Area of Interest for image usability testing purposes is specific to the imaging institution's own defined requirements and/or constraints.  * `0` -  The image was not tested for any of the image quality conditions * `1` -  The image was tested and one or more image quality conditions were reported * `2` -  The image was tested and no image quality conditions were reported
    59  	PayeeEndorsementUsability int32 `json:"payeeEndorsementUsability,omitempty"`
    60  	// BOFDEndorsementUsability is a code that indicates if the Bank of First Deposit (BOFD) endorsement Area of Interest is usable and readable from the image. The definition of the Area of Interest for image usability testing purposes is specific to the imaging institution's own defined requirements and/or constraints.  * `0` -  The image was not tested for any of the image quality conditions * `1` -  The image was tested and one or more image quality conditions were reported * `2` -  The image was tested and no image quality conditions were reported
    61  	BOFDEndorsementUsability int32 `json:"bOFDEndorsementUsability,omitempty"`
    62  	// TransitEndorsementUsability is a code that indicates if the transit endorsement Area of Interest is usable and readable from the image. The definition of the Area of Interest for image usability testing purposes is specific to the imaging institution's own defined requirements and/or constraints.  * `0` -  The image was not tested for any of the image quality conditions * `1` -  The image was tested and one or more image quality conditions were reported * `2` -  The image was tested and no image quality conditions were reported
    63  	TransitEndorsementUsability int32 `json:"transitEndorsementUsability,omitempty"`
    64  	// UserField identifies a field used at the discretion of users of the standard.
    65  	UserField string `json:"userField,omitempty"`
    66  }