Skip to main content

Enums

Markdown
DocumentEnums
warning

For security reasons, iOS SDK 3.5.0 and later no longer include the native document capture. The public API still exists for now, but calling it returns error 73905, "Unable to open document camera". It will be removed in an upcoming version. For more information, contact your CSM.

Deprecated since iOS SDK 3.5.0. Defines the type of document to be captured. Passed to openDocument to configure the capture session.

Mixed casing

CPF, CNH, and RG use uppercase (historical SDK naming). Multi-word variants use lowerCamelCase (cnhFrente, rgVerso, etc.). Use each value exactly as documented — the SDK is case-sensitive.

SwiftObjective-CDescription
DocumentEnums.CPFDocumentCPFCapture the CPF
DocumentEnums.CNHDocumentCNHCapture the open CNH (front and back)
DocumentEnums.cnhFrenteDocumentCnhFrenteCapture the front of the CNH
DocumentEnums.cnhVersoDocumentCnhVersoCapture the back of the CNH
DocumentEnums.RGDocumentRGCapture the open RG (front and back)
DocumentEnums.rgFrenteDocumentRgFrenteCapture the front of the RG
DocumentEnums.rgVersoDocumentRgVersoCapture the back of the RG
DocumentEnums.noneDocumentNoneGeneric rectangular frame — use for any document without a dedicated frame
enum DocumentEnums {
case CPF
case CNH
case cnhFrente
case cnhVerso
case RG
case rgFrente
case rgVerso
case none
}
EnvironmentEnum

Defines the environment used during SDK execution.

ValueDescription
EnvironmentEnum.PRODProduction environment
EnvironmentEnum.UATUAT / sandbox environment
enum EnvironmentEnum {
case PROD
case UAT
}
LocaleTypes

Defines the language used in the SDK UI.

ValueDescription
LocaleTypes.PT_BRPortuguese (Brazil)
LocaleTypes.ES_MXSpanish (Mexico)
LocaleTypes.ES_ESSpanish (Spain)
LocaleTypes.EN_USEnglish (USA)
enum LocaleTypes {
case PT_BR
case ES_MX
case ES_ES
case EN_US
}