Enums

DocumentEnums

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.

Swift	Objective-C	Description
DocumentEnums.CPF	DocumentCPF	Capture the CPF
DocumentEnums.CNH	DocumentCNH	Capture the open CNH (front and back)
DocumentEnums.cnhFrente	DocumentCnhFrente	Capture the front of the CNH
DocumentEnums.cnhVerso	DocumentCnhVerso	Capture the back of the CNH
DocumentEnums.RG	DocumentRG	Capture the open RG (front and back)
DocumentEnums.rgFrente	DocumentRgFrente	Capture the front of the RG
DocumentEnums.rgVerso	DocumentRgVerso	Capture the back of the RG
DocumentEnums.none	DocumentNone	Generic rectangular frame — use for any document without a dedicated frame

Non-Brazilian documents

The document-specific frames (CPF, CNH, RG) are Brazil-only. For US driver's licenses, passports, or any other document type, use DocumentEnums.none / DocumentNone.

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.

Value	Description
EnvironmentEnum.PROD	Production environment
EnvironmentEnum.UAT	UAT / sandbox environment

enum EnvironmentEnum {
    case PROD
    case UAT
}

LocaleTypes

Defines the language used in the SDK UI.

Value	Description
LocaleTypes.PT_BR	Portuguese (Brazil)
LocaleTypes.ES_MX	Spanish (Mexico)
LocaleTypes.ES_ES	Spanish (Spain)
LocaleTypes.EN_US	English (USA)

enum LocaleTypes {
    case PT_BR
    case ES_MX
    case ES_ES
    case EN_US
}