For the complete documentation index, see llms.txt. This page is also available as Markdown.

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.

faceImageIdChecksum

Checksum of the image binary. The value has the format "sha256:<digest>" with the prefix defining the cryptographic hash that was used, SHA-256 in this case.

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.

frontImageIdChecksum

Checksum of the image binary. The value has the format "sha256:<digest>" with the prefix defining the cryptographic hash that was used, SHA-256 in this case.

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

frontFrameImageIdChecksum

Checksum of the image binary. The value has the format "sha256:<digest>" with the prefix defining the cryptographic hash that was used, SHA-256 in this case.

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

backImageIdChecksum

Checksum of the image binary. The value has the format "sha256:<digest>" with the prefix defining the cryptographic hash that was used, SHA-256 in this case.

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

backFrameImageIdChecksum

Checksum of the image binary. The value has the format "sha256:<digest>" with the prefix defining the cryptographic hash that was used, SHA-256 in this case.

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

Was this helpful?