# IDImageOptions



## Scope and provenance

- Product: mobile
- Status: Imported reference snapshot. Import date is not a verification date or guarantee of current release support.
- SDK version: Not declared for this page. Versions in examples must not be assumed current.
- Environment: Page-specific. Confirm the environment host, credentials, and service configuration; do not infer them from another product.
- Source: https://documentation.idmission.com/identity/Android-SDK-2/-i-dentity--s-d-k/com.idmission.sdk2.client.model/-i-d-image-options/
- Imported at: 2026-10-21T17:27:02.187Z
- Canonical page: https://docs.idmission.com/mobile/reference/android/-i-dentity--s-d-k/com.idmission.sdk2.client.model/-i-d-image-options
- Agent index: https://docs.idmission.com/llms.txt

---

[IDentity-SDK](https://docs.idmission.com/markdown/mobile/android-sdk-2.md)/[com.idmission.sdk2.client.model](https://docs.idmission.com/markdown/mobile/reference/android/-i-dentity--s-d-k/com.idmission.sdk2.client.model.md)/IDImageOptions

<a id="idimageoptions"></a>

# IDImage​Options

```
public final class IDImageOptions implements Parcelable
```

Provides options to customize images in ID Capture, Retry and Instruction Screens.

<a id="constructors"></a>

## Constructors

<a id="302499744/Constructors/191329751"></a>

[]()

[IDImage​Options](https://docs.idmission.com/markdown/mobile/reference/android/-i-dentity--s-d-k/com.idmission.sdk2.client.model/-i-d-image-options/-i-d-image-options.md)

```
@JvmOverloads()public IDImageOptions IDImageOptions(@DrawableRes() Integer retryScreenImage, @DrawableRes() Integer captureScreenIdFrontOverlayImage, @DrawableRes() Integer captureScreenIdBackOverlayImage, @DrawableRes() Integer idInstructionImageResId, @DrawableRes() Integer idInstructionBackImageResId, @DrawableRes() Integer documentInstructionImageResId, @DrawableRes() Integer captureBottomBarImage, @DrawableRes() Integer captureScreenCancelBtnImage, @DrawableRes() Integer previewScreenToolbarBackIcon, String previewScreenToolbarBackIconTintColor, <Error class: unknown class><Integer> idCaptureInstructionAnimationImages)
```

```
@JvmOverloads()public IDImageOptions IDImageOptions(@DrawableRes() Integer retryScreenImage, @DrawableRes() Integer captureScreenIdFrontOverlayImage, @DrawableRes() Integer captureScreenIdBackOverlayImage, @DrawableRes() Integer idInstructionImageResId, @DrawableRes() Integer idInstructionBackImageResId, @DrawableRes() Integer documentInstructionImageResId, @DrawableRes() Integer captureBottomBarImage, @DrawableRes() Integer captureScreenCancelBtnImage, @DrawableRes() Integer previewScreenToolbarBackIcon, String previewScreenToolbarBackIconTintColor)
```

```
@JvmOverloads()public IDImageOptions IDImageOptions(@DrawableRes() Integer retryScreenImage, @DrawableRes() Integer captureScreenIdFrontOverlayImage, @DrawableRes() Integer captureScreenIdBackOverlayImage, @DrawableRes() Integer idInstructionImageResId, @DrawableRes() Integer idInstructionBackImageResId, @DrawableRes() Integer documentInstructionImageResId, @DrawableRes() Integer captureBottomBarImage, @DrawableRes() Integer captureScreenCancelBtnImage, @DrawableRes() Integer previewScreenToolbarBackIcon)
```

```
@JvmOverloads()public IDImageOptions IDImageOptions(@DrawableRes() Integer retryScreenImage, @DrawableRes() Integer captureScreenIdFrontOverlayImage, @DrawableRes() Integer captureScreenIdBackOverlayImage, @DrawableRes() Integer idInstructionImageResId, @DrawableRes() Integer idInstructionBackImageResId, @DrawableRes() Integer documentInstructionImageResId, @DrawableRes() Integer captureBottomBarImage, @DrawableRes() Integer captureScreenCancelBtnImage)
```

```
@JvmOverloads()public IDImageOptions IDImageOptions(@DrawableRes() Integer retryScreenImage, @DrawableRes() Integer captureScreenIdFrontOverlayImage, @DrawableRes() Integer captureScreenIdBackOverlayImage, @DrawableRes() Integer idInstructionImageResId, @DrawableRes() Integer idInstructionBackImageResId, @DrawableRes() Integer documentInstructionImageResId, @DrawableRes() Integer captureBottomBarImage)
```

```
@JvmOverloads()public IDImageOptions IDImageOptions(@DrawableRes() Integer retryScreenImage, @DrawableRes() Integer captureScreenIdFrontOverlayImage, @DrawableRes() Integer captureScreenIdBackOverlayImage, @DrawableRes() Integer idInstructionImageResId, @DrawableRes() Integer idInstructionBackImageResId, @DrawableRes() Integer documentInstructionImageResId)
```

```
@JvmOverloads()public IDImageOptions IDImageOptions(@DrawableRes() Integer retryScreenImage, @DrawableRes() Integer captureScreenIdFrontOverlayImage, @DrawableRes() Integer captureScreenIdBackOverlayImage, @DrawableRes() Integer idInstructionImageResId, @DrawableRes() Integer idInstructionBackImageResId)
```

```
@JvmOverloads()public IDImageOptions IDImageOptions(@DrawableRes() Integer retryScreenImage, @DrawableRes() Integer captureScreenIdFrontOverlayImage, @DrawableRes() Integer captureScreenIdBackOverlayImage, @DrawableRes() Integer idInstructionImageResId)
```

```
@JvmOverloads()public IDImageOptions IDImageOptions(@DrawableRes() Integer retryScreenImage, @DrawableRes() Integer captureScreenIdFrontOverlayImage, @DrawableRes() Integer captureScreenIdBackOverlayImage)
```

```
@JvmOverloads()public IDImageOptions IDImageOptions(@DrawableRes() Integer retryScreenImage, @DrawableRes() Integer captureScreenIdFrontOverlayImage)
```

```
@JvmOverloads()public IDImageOptions IDImageOptions(@DrawableRes() Integer retryScreenImage)
```

```
@JvmOverloads()public IDImageOptions IDImageOptions()
```

<a id="properties"></a>

## Properties

<a id="-649381192/Properties/191329751"></a>

[]()

[capture​Bottom​Bar​Image](https://docs.idmission.com/markdown/mobile/reference/android/-i-dentity--s-d-k/com.idmission.sdk2.client.model/-i-d-image-options.md#-649381192%2FProperties%2F191329751)

```
private Integer captureBottomBarImage
```

Option to set bottom image in Capture screen.

<a id="123933766/Properties/191329751"></a>

[]()

[capture​Screen​Cancel​Btn​Image](https://docs.idmission.com/markdown/mobile/reference/android/-i-dentity--s-d-k/com.idmission.sdk2.client.model/-i-d-image-options.md#123933766%2FProperties%2F191329751)

```
private Integer captureScreenCancelBtnImage
```

Option to set bottom image in Capture screen.

<a id="-1056368110/Properties/191329751"></a>

[]()

[capture​Screen​Id​Back​Overlay​Image](https://docs.idmission.com/markdown/mobile/reference/android/-i-dentity--s-d-k/com.idmission.sdk2.client.model/-i-d-image-options.md#-1056368110%2FProperties%2F191329751)

```
private Integer captureScreenIdBackOverlayImage
```

Option to set image in Back Overlay for ID.

<a id="-1122315294/Properties/191329751"></a>

[]()

[capture​Screen​Id​Front​Overlay​Image](https://docs.idmission.com/markdown/mobile/reference/android/-i-dentity--s-d-k/com.idmission.sdk2.client.model/-i-d-image-options.md#-1122315294%2FProperties%2F191329751)

```
private Integer captureScreenIdFrontOverlayImage
```

Option to set image in Front Overlay for ID.

<a id="-299915490/Properties/191329751"></a>

[]()

[document​Instruction​Image​Res​Id](https://docs.idmission.com/markdown/mobile/reference/android/-i-dentity--s-d-k/com.idmission.sdk2.client.model/-i-d-image-options.md#-299915490%2FProperties%2F191329751)

```
private Integer documentInstructionImageResId
```

Option to set image in Instruction screen for Document Capture.

<a id="1132748344/Properties/191329751"></a>

[]()

[id​Capture​Instruction​Animation​Images](https://docs.idmission.com/markdown/mobile/reference/android/-i-dentity--s-d-k/com.idmission.sdk2.client.model/-i-d-image-options.md#1132748344%2FProperties%2F191329751)

```
private <Error class: unknown class><Integer> idCaptureInstructionAnimationImages
```

Option to set image list in Instruction screen for ID.

<a id="1858186039/Properties/191329751"></a>

[]()

[id​Instruction​Back​Image​Res​Id](https://docs.idmission.com/markdown/mobile/reference/android/-i-dentity--s-d-k/com.idmission.sdk2.client.model/-i-d-image-options.md#1858186039%2FProperties%2F191329751)

```
private Integer idInstructionBackImageResId
```

Option to set image in Instruction screen for back button.

<a id="-31391202/Properties/191329751"></a>

[]()

[id​Instruction​Image​Res​Id](https://docs.idmission.com/markdown/mobile/reference/android/-i-dentity--s-d-k/com.idmission.sdk2.client.model/-i-d-image-options.md#-31391202%2FProperties%2F191329751)

```
private Integer idInstructionImageResId
```

Option to set image in Instruction screen for ID.

<a id="-2030822558/Properties/191329751"></a>

[]()

[preview​Screen​Toolbar​Back​Icon](https://docs.idmission.com/markdown/mobile/reference/android/-i-dentity--s-d-k/com.idmission.sdk2.client.model/-i-d-image-options.md#-2030822558%2FProperties%2F191329751)

```
private Integer previewScreenToolbarBackIcon
```

Option to set Preview screen toolbar back button image.

<a id="-650707536/Properties/191329751"></a>

[]()

[preview​Screen​Toolbar​Back​Icon​Tint​Color](https://docs.idmission.com/markdown/mobile/reference/android/-i-dentity--s-d-k/com.idmission.sdk2.client.model/-i-d-image-options.md#-650707536%2FProperties%2F191329751)

```
private String previewScreenToolbarBackIconTintColor
```

Option to set Preview screen toolbar back button tint color.

<a id="-765326718/Properties/191329751"></a>

[]()

[retry​Screen​Image](https://docs.idmission.com/markdown/mobile/reference/android/-i-dentity--s-d-k/com.idmission.sdk2.client.model/-i-d-image-options.md#-765326718%2FProperties%2F191329751)

```
private Integer retryScreenImage
```

Option to set Retry screen image.

<a id="functions"></a>

## Functions

<a id="-1578325224/Functions/191329751"></a>

[]()

[describe​Contents](https://docs.idmission.com/markdown/mobile/reference/android/-i-dentity--s-d-k/com.idmission.sdk2.client.model/-voice-capture-customization-options.md#-1578325224%2FFunctions%2F191329751)

```
public abstract Integer describeContents()
```

<a id="1682830086/Functions/191329751"></a>

[]()

[get​Capture​Bottom​Bar​Image](https://docs.idmission.com/markdown/mobile/reference/android/-i-dentity--s-d-k/com.idmission.sdk2.client.model/-i-d-image-options/get-capture-bottom-bar-image.md)

```
public final Integer getCaptureBottomBarImage()
```

Option to set bottom image in Capture screen.

<a id="1637997076/Functions/191329751"></a>

[]()

[get​Capture​Screen​Cancel​Btn​Image](https://docs.idmission.com/markdown/mobile/reference/android/-i-dentity--s-d-k/com.idmission.sdk2.client.model/-i-d-image-options/get-capture-screen-cancel-btn-image.md)

```
public final Integer getCaptureScreenCancelBtnImage()
```

Option to set bottom image in Capture screen.

<a id="-1347139360/Functions/191329751"></a>

[]()

[get​Capture​Screen​Id​Back​Overlay​Image](https://docs.idmission.com/markdown/mobile/reference/android/-i-dentity--s-d-k/com.idmission.sdk2.client.model/-i-d-image-options/get-capture-screen-id-back-overlay-image.md)

```
public final Integer getCaptureScreenIdBackOverlayImage()
```

Option to set image in Back Overlay for ID.

<a id="-1546289452/Functions/191329751"></a>

[]()

[get​Capture​Screen​Id​Front​Overlay​Image](https://docs.idmission.com/markdown/mobile/reference/android/-i-dentity--s-d-k/com.idmission.sdk2.client.model/-i-d-image-options/get-capture-screen-id-front-overlay-image.md)

```
public final Integer getCaptureScreenIdFrontOverlayImage()
```

Option to set image in Front Overlay for ID.

<a id="-1278987924/Functions/191329751"></a>

[]()

[get​Document​Instruction​Image​Res​Id](https://docs.idmission.com/markdown/mobile/reference/android/-i-dentity--s-d-k/com.idmission.sdk2.client.model/-i-d-image-options/get-document-instruction-image-res-id.md)

```
public final Integer getDocumentInstructionImageResId()
```

Option to set image in Instruction screen for Document Capture.

<a id="2017424902/Functions/191329751"></a>

[]()

[get​Id​Capture​Instruction​Animation​Images](https://docs.idmission.com/markdown/mobile/reference/android/-i-dentity--s-d-k/com.idmission.sdk2.client.model/-i-d-image-options/get-id-capture-instruction-animation-images.md)

```
public final <Error class: unknown class><Integer> getIdCaptureInstructionAnimationImages()
```

Option to set image list in Instruction screen for ID.

<a id="-922717947/Functions/191329751"></a>

[]()

[get​Id​Instruction​Back​Image​Res​Id](https://docs.idmission.com/markdown/mobile/reference/android/-i-dentity--s-d-k/com.idmission.sdk2.client.model/-i-d-image-options/get-id-instruction-back-image-res-id.md)

```
public final Integer getIdInstructionBackImageResId()
```

Option to set image in Instruction screen for back button.

<a id="-749281556/Functions/191329751"></a>

[]()

[get​Id​Instruction​Image​Res​Id](https://docs.idmission.com/markdown/mobile/reference/android/-i-dentity--s-d-k/com.idmission.sdk2.client.model/-i-d-image-options/get-id-instruction-image-res-id.md)

```
public final Integer getIdInstructionImageResId()
```

Option to set image in Instruction screen for ID.

<a id="1955467092/Functions/191329751"></a>

[]()

[get​Preview​Screen​Toolbar​Back​Icon](https://docs.idmission.com/markdown/mobile/reference/android/-i-dentity--s-d-k/com.idmission.sdk2.client.model/-i-d-image-options/get-preview-screen-toolbar-back-icon.md)

```
public final Integer getPreviewScreenToolbarBackIcon()
```

Option to set Preview screen toolbar back button image.

<a id="-880059906/Functions/191329751"></a>

[]()

[get​Preview​Screen​Toolbar​Back​Icon​Tint​Color](https://docs.idmission.com/markdown/mobile/reference/android/-i-dentity--s-d-k/com.idmission.sdk2.client.model/-i-d-image-options/get-preview-screen-toolbar-back-icon-tint-color.md)

```
public final String getPreviewScreenToolbarBackIconTintColor()
```

Option to set Preview screen toolbar back button tint color.

<a id="199547252/Functions/191329751"></a>

[]()

[get​Retry​Screen​Image](https://docs.idmission.com/markdown/mobile/reference/android/-i-dentity--s-d-k/com.idmission.sdk2.client.model/-i-d-image-options/get-retry-screen-image.md)

```
public final Integer getRetryScreenImage()
```

Option to set Retry screen image.

<a id="1392895667/Functions/191329751"></a>

[]()

[set​Capture​Bottom​Bar​Image](https://docs.idmission.com/markdown/mobile/reference/android/-i-dentity--s-d-k/com.idmission.sdk2.client.model/-i-d-image-options/set-capture-bottom-bar-image.md)

```
public final Unit setCaptureBottomBarImage(Integer captureBottomBarImage)
```

Option to set bottom image in Capture screen.

<a id="1037009893/Functions/191329751"></a>

[]()

[set​Capture​Screen​Cancel​Btn​Image](https://docs.idmission.com/markdown/mobile/reference/android/-i-dentity--s-d-k/com.idmission.sdk2.client.model/-i-d-image-options/set-capture-screen-cancel-btn-image.md)

```
public final Unit setCaptureScreenCancelBtnImage(Integer captureScreenCancelBtnImage)
```

Option to set bottom image in Capture screen.

<a id="-144292967/Functions/191329751"></a>

[]()

[set​Capture​Screen​Id​Back​Overlay​Image](https://docs.idmission.com/markdown/mobile/reference/android/-i-dentity--s-d-k/com.idmission.sdk2.client.model/-i-d-image-options/set-capture-screen-id-back-overlay-image.md)

```
public final Unit setCaptureScreenIdBackOverlayImage(Integer captureScreenIdBackOverlayImage)
```

Option to set image in Back Overlay for ID.

<a id="-323261251/Functions/191329751"></a>

[]()

[set​Capture​Screen​Id​Front​Overlay​Image](https://docs.idmission.com/markdown/mobile/reference/android/-i-dentity--s-d-k/com.idmission.sdk2.client.model/-i-d-image-options/set-capture-screen-id-front-overlay-image.md)

```
public final Unit setCaptureScreenIdFrontOverlayImage(Integer captureScreenIdFrontOverlayImage)
```

Option to set image in Front Overlay for ID.

<a id="27203725/Functions/191329751"></a>

[]()

[set​Document​Instruction​Image​Res​Id](https://docs.idmission.com/markdown/mobile/reference/android/-i-dentity--s-d-k/com.idmission.sdk2.client.model/-i-d-image-options/set-document-instruction-image-res-id.md)

```
public final Unit setDocumentInstructionImageResId(Integer documentInstructionImageResId)
```

Option to set image in Instruction screen for Document Capture.

<a id="-1740584839/Functions/191329751"></a>

[]()

[set​Id​Capture​Instruction​Animation​Images](https://docs.idmission.com/markdown/mobile/reference/android/-i-dentity--s-d-k/com.idmission.sdk2.client.model/-i-d-image-options/set-id-capture-instruction-animation-images.md)

```
public final Unit setIdCaptureInstructionAnimationImages(<Error class: unknown class><Integer> idCaptureInstructionAnimationImages)
```

Option to set image list in Instruction screen for ID.

<a id="-2066490284/Functions/191329751"></a>

[]()

[set​Id​Instruction​Back​Image​Res​Id](https://docs.idmission.com/markdown/mobile/reference/android/-i-dentity--s-d-k/com.idmission.sdk2.client.model/-i-d-image-options/set-id-instruction-back-image-res-id.md)

```
public final Unit setIdInstructionBackImageResId(Integer idInstructionBackImageResId)
```

Option to set image in Instruction screen for back button.

<a id="1445356045/Functions/191329751"></a>

[]()

[set​Id​Instruction​Image​Res​Id](https://docs.idmission.com/markdown/mobile/reference/android/-i-dentity--s-d-k/com.idmission.sdk2.client.model/-i-d-image-options/set-id-instruction-image-res-id.md)

```
public final Unit setIdInstructionImageResId(Integer idInstructionImageResId)
```

Option to set image in Instruction screen for ID.

<a id="1709240893/Functions/191329751"></a>

[]()

[set​Preview​Screen​Toolbar​Back​Icon](https://docs.idmission.com/markdown/mobile/reference/android/-i-dentity--s-d-k/com.idmission.sdk2.client.model/-i-d-image-options/set-preview-screen-toolbar-back-icon.md)

```
public final Unit setPreviewScreenToolbarBackIcon(Integer previewScreenToolbarBackIcon)
```

Option to set Preview screen toolbar back button image.

<a id="-1949776151/Functions/191329751"></a>

[]()

[set​Preview​Screen​Toolbar​Back​Icon​Tint​Color](https://docs.idmission.com/markdown/mobile/reference/android/-i-dentity--s-d-k/com.idmission.sdk2.client.model/-i-d-image-options/set-preview-screen-toolbar-back-icon-tint-color.md)

```
public final Unit setPreviewScreenToolbarBackIconTintColor(String previewScreenToolbarBackIconTintColor)
```

Option to set Preview screen toolbar back button tint color.

<a id="-1033976291/Functions/191329751"></a>

[]()

[set​Retry​Screen​Image](https://docs.idmission.com/markdown/mobile/reference/android/-i-dentity--s-d-k/com.idmission.sdk2.client.model/-i-d-image-options/set-retry-screen-image.md)

```
public final Unit setRetryScreenImage(Integer retryScreenImage)
```

Option to set Retry screen image.

<a id="-1754457655/Functions/191329751"></a>

[]()

[write​To​Parcel](https://docs.idmission.com/markdown/mobile/reference/android/-i-dentity--s-d-k/com.idmission.sdk2.client.model/-voice-capture-customization-options.md#-1754457655%2FFunctions%2F191329751)

```
public abstract Unit writeToParcel(Parcel p0, Integer p1)
```