ID Capture Session

Defined in package

class IdCaptureSession

Added in version 6.2.0

The ID capture session is responsible for keeping the CapturedId data.


The capture session should only be accessed from within onIdCaptured() to which it is provided as an argument. It is not safe to be accessed from anywhere else since it may be concurrently modified. References to the individual captured IDs can be kept and processed later as they are not further modified.

@Nullable CapturedId getNewlyCapturedId()

Added in version 6.2.0

Parsed data from a document recognized in the last frame, if any.

@Nullable LocalizedOnlyId getNewlyLocalizedOnlyId()

Added in version 6.10.0

An information about a document or its part localized in the last frame, if any. A document or its part is considered localized when it’s detected in a frame, but its data is not yet extracted.

@Nullable RejectedId getNewlyRejectedId()

Added in version 6.10.0

An information about a document or its part recognized in a frame, but rejected. A document is rejected if (a) it’s not enabled in the settings (see IdCaptureSettings.supportedDocuments), (b) it’s a barcode of a correct symbology or a Machine Readable Zone (MRZ), but the data is encoded in an unexpected/incorrect format.

long getFrameSequenceId()

Added in version 6.2.0

The identifier of the current frame sequence.


As long as there is no interruptions of frames coming from the camera, the frameSequenceId will stay the same.

@NonNull String toJson()

Added in version 6.6.0

Returns the JSON representation of the ID Capture session.