DocumentField

Represents meta information about an additional field for a document.

DocumentField.Id

= Id

The unique identifier of the document field.

DocumentField.DocumentId

= DocumentId

The unique identifier of the document that this field belongs to.

DocumentField.Name

= Name

The internal name of this document field.

DocumentField.ImageType

= ImageType

Links the field to a scanned ImageType.

DocumentField.SourceId

= SourceId

Determines from where the field was derived: Hrz, Mrz, Chip.

See also

DocumentFieldSource for more information about the document field source.

DocumentField.DisplayName

= DisplayName

The name of the document field - how it is displayed to operators of the system.

DocumentField.DescriptionText

= DescriptionText

Additional help text describing the purpose of the field.

DocumentField.RegionCoordinates

= RegionCoordinates

Provides the location and size of the region showing where on the document the field information was derived. In the format: X,Y,Width,Height

DocumentField.DataType

= DataType

The type of the data that the field contains.

See also

DocumentFieldDataType for more information on the document field data type.

DocumentField.FieldValueString

= FieldValueString

The internal value of this document field in case the data type is representing a string value.

DocumentField.FieldValueDate

= FieldValueDate

The internal value of this document field in case the data type is representing a date and/or time value.

DocumentField.Reliability

= Reliability

A number between 0.0 and 1.0 indicating the reliability of the information, where 0.0 indicates least and 1.0 most reliable.