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.

@NonNull CapturedId getNewlyCapturedId()

Added in version 6.2.0

Parsed data from a document recognized in the last frame.

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.