Scan Object

(Scanning Step)

Attribute
Description

faceImageId

The id of the image of the face of the user in the document. See Download a resource for details on how to download the image.

frontImageId

The id of the image of the front page of the document. See Download a resource for details on how to download the image.

frontFrameImageId

The id of the complete frame image of the document's front side. See Download a resource for details on how to download the image. Note: Only available in mobile SDK 3.3.0 and above

backImageId

The id of the image of the back page of the document. See Download a resource for details on how to download the image. Note: Only available if the document has a back side

backFrameImageId

The id of the complete frame image of the document's back side. See Download a resource for details on how to download the image. Note: Only available in mobile SDK 3.3.0 and above

front

See API Documentation for the Scan / OCR fields. The only exception is the face image that is not included directly in the result but as a reference as per the common fields described above

back

See API Documentation for the Scan / OCR fields. The only exception is the face image that is not included directly in the result but as a reference as per the faceImageId described above

Last updated