References

DocumentDetectorResult

Parameter
Description
Allow Null

captures: Array<Capture>

Array of captures for the documents provided. Can be null in case of an error.

type: String

Class of the document stream. Possible values are listed above. Can be null in case of error. The possible value are listed in the section below

trackingId: String

Identifier for this execution on our servers. Required for analytics and debugging.

sdkFailure: SDKFailure?

Indicates the reason for SDK shutdown. Null if the operation is successful.

Possible Values for type

The parameter type can have one of the following values:

  • "blank"

  • "cnh"

  • "cnh_new"

  • "generic"

  • "rg"

  • "rg_new"

  • "rne"

  • "rnm"

  • "ctps"

  • "passport"

  • "crlv"

  • "crlv_new"

  • "cin"

Capture

Parameter
Description
Allow Null

imagePath: String

Full path of the image on the user's device.

imageUrl: String

URL of the document on the Caf's server. This URL expires, and expiry time can be set using setGetImageUrlExpireTime.

label: String

Label of the respective document. Possible values are listed in the section below.

quality: Double

Quality score inferred by the document quality algorithm. Ranges between 0 and 5.

Possible Values for captures

The parameter captures can have one of the following values:

  • "blank"

  • "cnh_back"

  • "cnh_front"

  • "cnh_full"

  • "new_cnh_back"

  • "new_cnh_front"

  • "new_cnh_full"

  • "crlv"

  • "crlv_new"

  • "generic"

  • "rg_back"

  • "rg_front"

  • "rg_full"

  • "rg_new_back"

  • "rg_new_front"

  • "rg_new_full"

  • "rne_back"

  • "rne_front"

  • "rnm_back"

  • "rnm_front"

  • "ctps_back"

  • "ctps_front"

  • "passport"

  • "cin_front"

  • "cin_back"

Last updated

Logo

2023 © Caf. - All rights reserved