> For the complete documentation index, see [llms.txt](https://docs.caf.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.caf.io/caf-sdk/caf-sdk-pt-br/ios/getting-started-with-the-sdk-2/customizing-document-detector.md).

# Personalizando o Document Detector

{% hint style="warning" %}

## Este guia abrange a versão 7.0.0 e superiores. Para versões anteriores à 7.0.0, consulte a [documentação legada](https://docs.caf.io/caf-sdk/caf-sdk-pt-br/ios/getting-started-with-the-sdk-5.md).

{% endhint %}

## Visão geral

Esta página é uma **campo a campo** referência de tudo o que os integradores podem alterar em **Detector de Documentos**: textos, interface de captura, etapas do fluxo, comportamento de envio, proxy opcional, filtragem de passaporte, personalizações de strings e cores globais.

***

### Interface de personalização

Suponha **`Certta.shared.configure(configuration:)`** já foi executado com um **token móvel** e **ID do usuário**. Importe **`UIKit`** e **`CafSDK`** (e vincule **DocumentDetector** conforme sua distribuição).

#### 1. Abertura mínima — UI padrão, frente e verso do RG

Usa **`CerttaDocumentDetectorUIConfiguration()`** para que todos os campos da UI usem os padrões do SDK. Apenas **`fluxo`** é personalizado.

```swift
import UIKit
import CafSDK

final class DocumentFlowViewController: UIViewController {

    func startDocumentDetector() {
        CerttaDocumentDetector.shared.delegate = self

        let flow: [CafDocumentDetectorStep] = [
            CafDocumentDetectorStep(stepType: .rgFront),
            CafDocumentDetectorStep(stepType: .rgBack)
        ]

        let configuration = CerttaDocumentDetectorConfiguration(
            flow: flow,
            ui: CerttaDocumentDetectorUIConfiguration(),
            enableMultiLanguage: true
        )

        CerttaDocumentDetector.shared.open(from: self, configuration: configuration)
    }
}

extension DocumentFlowViewController: CerttaDocumentDetectorDelegate {
    func didFinish(result: String) {
        // Envie `result` para o seu backend (payload assinado).
    }

    func didFinishWith(_ error: CerttaError) {
        // Mapeie `error` / `error.message` para a UI (veja o README).
    }
}
```

Defina **`Certta.shared.delegate`** se você precisar **`certtaDidCancel()`** / **`certtaDidLog`**.

#### 2. UI estruturada — seleção, instruções, elementos visuais da captura, envio

Construa **`CerttaDocumentDetectorUIConfiguration`** propriedade por propriedade. Este exemplo habilita **o envio**, personaliza **as instruções**, restringe **as tentativas**, e ajusta **as cores da moldura** durante a captura.

```swift
func makeDocumentConfiguration() -> CerttaDocumentDetectorConfiguration {
    var ui = CerttaDocumentDetectorUIConfiguration()

    ui.documentSelectionScreen.title = "Tipo de documento"
    ui.documentSelectionScreen.subtitle = "Escolha o documento que vai fotografar"
    ui.documentSelectionScreen.titlesByDocumentKind = [
        .rg: "RG",
        .cnh: "CNH"
    ]

    ui.instructionsScreen.title = "Como fotografar"
    ui.instructionsScreen.message = "Coloque o documento inteiro dentro da área e evite reflexos."
    ui.instructionsScreen.steps = [
        "Segure o telefone firme",
        "Centralize o documento na moldura"
    ]
    ui.instructionsScreen.primaryButtonTitle = "Continuar"

    ui.captureScreen.documentFrameNeutralColor = .label
    ui.captureScreen.documentFrameValidationFailedColor = .systemRed
    ui.captureScreen.documentFrameValidationPassedColor = .systemGreen
    // ui.captureScreen.fontName = "MyFont-Regular"  // nome PostScript, se incorporado

    ui.uploadSettings = CafUploadSettings(
        enable: true,
        compress: true,
        fileFormats: [.jpeg, .png],
        maximumFileSize: 5_000_000
    )
    ui.showPreview = true
    ui.showPopup = true
    ui.requestTimeout = 90
    ui.maxRetryAttempts = 4

    let flow = [
        CafDocumentDetectorStep(stepType: .rgFront),
        CafDocumentDetectorStep(stepType: .rgBack)
    ]

    return CerttaDocumentDetectorConfiguration(flow: flow, ui: ui, enableMultiLanguage: true)
}

// Uso:
// CerttaDocumentDetector.shared.open(from: self, configuration: makeDocumentConfiguration())
```

#### 3. Texto e ilustração por etapa

Use **`CafDocumentDetectorStep`** inicializadores para substituir rótulos, de forma opcional **`UIImage`**, e mensagens para uma única etapa.

```swift
let flow: [CafDocumentDetectorStep] = [
    CafDocumentDetectorStep(
        stepType: .rgFront,
        customStepLabel: "Frente do RG",
        customIllustration: UIImage(named: "illustration-rg-front"),
        showStepLabel: true,
        customMessage: "Capture a frente nítida, sem cortes.",
        customOkButtonTitle: "OK"
    ),
    CafDocumentDetectorStep(stepType: .rgBack)
]
```

#### 4. Personalizações de strings (`CafDDCustomization`)

Passe uma ou mais structs de personalização dentro de **`CerttaDocumentDetectorCustomization`**. Elas mapeiam para as strings nativas do DD **personalizadas** (pré-visualização, popup de envio, linhas de progresso, captura com falha).

```swift
var ui = CerttaDocumentDetectorUIConfiguration()

let previewStrings = CafPreviewCustomization(
    title: "Conferir foto",
    message: "O texto está legível?",
    okButton: "Usar esta foto",
    tryAgainButton: "Tirar de novo"
)

let uploadProgress = CafUploadMessagesCustomization(
    sending: "Enviando…",
    verifyingIntegrity: "Verificando…",
    processingData: "Processando…",
    almostDone: "Quase lá…",
    timeBetweenMessages: 1.2
)

let failed = CafFailedPhotoCustomization(
    title: "Foto rejeitada",
    description: "Tente novamente com melhor iluminação.",
    continueButton: "Continuar"
)

ui.customization = CerttaDocumentDetectorCustomization(
    ddCustomizations: [previewStrings, uploadProgress, failed]
)

let configuration = CerttaDocumentDetectorConfiguration(
    flow: [
        CafDocumentDetectorStep(stepType: .cnhFront),
        CafDocumentDetectorStep(stepType: .cnhBack)
    ],
    ui: ui
)
```

#### 5. Inicializador legado — `CafDocumentDetectorLayout` + `CafInstructionsConfiguration`

Quando você preferir não usar **`CerttaDocumentDetectorUIConfiguration`**, monte **`o layout`**, **`instructionsConfig`**, e **`uploadSettings`** você mesmo.

```swift
var layout = CafDocumentDetectorLayout()
layout.setCloseButton(image: UIImage(systemName: "xmark.circle.fill"))
layout.setFeedbackColors(
    CafDocumentFeedbackColors(
        defaultColor: .white,
        errorColor: .systemRed,
        successColor: .systemGreen
    )
)

var instructions = CafInstructionsConfiguration(
    enabled: true,
    captureTitle: "Captura",
    captureDescriptionText: "Alinhe o documento.",
    captureSteps: ["Passo 1", "Passo 2"],
    captureButtonTitle: "Capturar"
)

let configuration = CerttaDocumentDetectorConfiguration(
    flow: [
        CafDocumentDetectorStep(stepType: .passport)
    ],
    layout: layout,
    uploadSettings: CafUploadSettings(enable: true),
    instructionsConfig: instructions,
    requestTimeout: 60,
    showPreCapturePopup: true,
    showPreview: true,
    ddCustomizations: [],
    enableMultiLanguage: true,
    selectDocumentConfig: nil,
    maxRetryAttempts: 3
)
```

#### 6. Ponte a partir de full `CafDocumentDetectorConfig`

Se você já monta **`CafDocumentDetectorConfig`** (demo, JSON ou builder legado), envolva-o com **`init(from:)`**. Os campos **não** armazenados em **`CerttaDocumentDetectorConfiguration`** ainda recebem **padrões do hub** em tempo de execução — veja **Mapeamento do hub**.

```swift
let full = CafDocumentDetectorConfig(
    flow: [
        CafDocumentDetectorStep(stepType: .rgFront),
        CafDocumentDetectorStep(stepType: .rgBack)
    ],
    proxySettings: CafProxySettings(hostname: "proxy.example.com", port: 443),
    allowedPassportCountryList: [.bra, .usa]
)

let configuration = CerttaDocumentDetectorConfiguration(from: full)
CerttaDocumentDetector.shared.open(from: self, configuration: configuration)
```

> **Observação:** Proxy e lista de passaportes em **`full`** são **não** encaminhados pelo mapeamento interno do hub da Certta da mesma forma que **`CafSDKProvider` + `CafDocumentDetectorConfig`** — para comportamento garantido de proxy/lista de permissões, use **`CafSDKProvider.Builder`** com um completo **`CafDocumentDetectorConfig`** (veja abaixo).

#### 7. Controle total — `CafSDKProvider.Builder` + proxy / passaporte / atrasos

Use este caminho quando você precisar definir **proxy**, **`getUrlExpireTime`**, **`currentStepDoneDelay`**, **`allowedPassportCountryList`**, ou campos de captura manual exatamente. Pseudocódigo:

```swift
var config = CafDocumentDetectorConfig(
    flow: [CafDocumentDetectorStep(stepType: .passport)],
    proxySettings: CafProxySettings(hostname: "10.0.0.1", port: 8080),
    getUrlExpireTime: "3600",
    currentStepDoneDelay: 0.5,
    allowedPassportCountryList: [.bra],
    maxRetryAttempts: 5
)

let provider = CafSDKProvider.Builder(
    self,
    mobileToken: token,
    personId: userId,
    environment: .prod,
    configuration: CafSDKConfiguration(
        presentationOrder: [.documentDetector],
        colorConfig: nil,
        waitForAllServices: true,
        enableTransitionScreens: true
    ).setDocumentDetectorConfig(config)
) { event in
    // Trate CafUnifiedEvent (sucesso, falha, erro, log, etc.)
}.build()

provider.start()
```

Exato **`CafSDKConfiguration`** e o tratamento de callback dependem do seu app; veja **a referência de configuração** e exemplos do produto.

#### 8. Ponte legada `CafDocumentDetectorLayout` + `CafInstructionsConfiguration` para `CerttaDocumentDetectorUIConfiguration`

Se você já tiver **`CafDocumentDetectorLayout`** e **`CafInstructionsConfiguration`** (ou **`CafSelectDocumentConfig`**) de uma integração mais antiga, use:

```swift
let ui = CerttaDocumentDetectorUIConfiguration(
    layout: existingLayout,
    instructions: existingInstructions,
    documentTypeSelection: existingSelectConfig // or nil
)

let configuration = CerttaDocumentDetectorConfiguration(
    flow: [CafDocumentDetectorStep(stepType: .rgFront)],
    ui: ui
)
```

Os padrões para **`uploadSettings`**, **`showPreview`**, etc., são definidos dentro desse inicializador de ponte — ajuste os campos em **`ui`** após a construção, se necessário.

#### 9. Cores da sessão antes de abrir o DD

```swift
// Depois de Certta.shared.configure(...)
Certta.shared.setColorConfiguration(
    CafColorConfiguration(
        primaryColor: "#34D690",
        secondaryColor: "#012D1F",
        contentColor: "#323232",
        backgroundColor: "#FFFFFF",
        mediumColor: "#D1D1D1",
        dialogBackgroundColor: "#FFFFFF",
        dialogBorderColor: "#E5E5E7"
    )
)
```

Use **`UITraitCollection`** (ou sua camada de tema) para criar **diferentes** **`CafColorConfiguration`** valores para claro e escuro, se necessário.

#### 10. Opcional: aquecer com `loadSession`

```swift
let configuration = CerttaDocumentDetectorConfiguration(
    flow: [CafDocumentDetectorStep(stepType: .rgFront)],
    ui: CerttaDocumentDetectorUIConfiguration()
)

CerttaDocumentDetector.shared.loadSession(from: self, configuration: configuration)
// … depois, a mesma configuração:
CerttaDocumentDetector.shared.open(from: self, configuration: configuration)
```

***

### `CerttaDocumentDetectorUIConfiguration`

Tipo raiz para a UI estruturada. Os padrões abaixo correspondem ao **Swift** inicializador em **CafSDK**.

| Propriedade                   | Tipo                                         | O que faz                                                                                                                                                      | Padrão (típico)                                                   |
| ----------------------------- | -------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------- |
| **`documentSelectionScreen`** | `CafDocumentDetectorDocumentSelectionScreen` | Títulos/subtítulos para o **tipo de documento** seletor; rótulos por tipo. Se tudo estiver vazio, a configuração de seleção pode ser omitida internamente.     | Veja a seção aninhada                                             |
| **`layoutResourceName`**      | `String?`                                    | Reservado para futuros **nativos** ganchos de layout; **não usado** pela UI padrão.                                                                            | `nil`                                                             |
| **`instructionsScreen`**      | `CafDocumentDetectorInstructionsScreen`      | Pré-captura **as instruções** (título, mensagem, etapas, botão, imagem de cabeçalho). Corresponde aos **campos de captura** de `CafInstructionsConfiguration`. | Veja a seção aninhada                                             |
| **`captureScreen`**           | `CafDocumentDetectorCaptureScreen`           | **Durante a captura**: botão de fechar, cores da moldura (neutro / erro / sucesso), nome da fonte. Corresponde a `CafDocumentDetectorLayout`.                  | Veja a seção aninhada                                             |
| **`uploadSettings`**          | `CafUploadSettings`                          | Se os envios são executados, compressão, formatos, tamanho máximo.                                                                                             | **`enable: false`** (padrão da UI da Certta; alinhado ao Android) |
| **`showPreview`**             | `Bool`                                       | Mostrar **pré-visualização após a captura** antes de continuar.                                                                                                | **`verdadeiro`**                                                  |
| **`requestTimeout`**          | `Int`                                        | Tempo limite da requisição em **segundos** (HTTP).                                                                                                             | **`60`**                                                          |
| **`showPopup`**               | `Bool`                                       | Mostrar **popup antes da captura** (porta de entrada das instruções).                                                                                          | **`verdadeiro`**                                                  |
| **`maxRetryAttempts`**        | `Int`                                        | Máximo **as tentativas** quando a captura/validação falhar.                                                                                                    | **`2`**                                                           |
| **`personalização`**          | `CerttaDocumentDetectorCustomization`        | Wrapper para **`[CafDDCustomization]`** (texto do popup de upload, strings de pré-visualização, mensagens de progresso do upload, foto com falha).             | Personalizações vazias                                            |

#### `CafDocumentDetectorDocumentSelectionScreen`

| Propriedade                      | Tipo                            | O que faz                                                                       |
| -------------------------------- | ------------------------------- | ------------------------------------------------------------------------------- |
| **`título`**                     | `String?`                       | Título principal da tela do tipo de documento.                                  |
| **`subtítulo`**                  | `String?`                       | Subtítulo / descrição abaixo do título.                                         |
| **`titlesByDocumentKind`**       | `[CafDocumentTypeKey: String]?` | Substituir o rótulo por **lógico** grupo de documentos (por ex. `.rg`, `.cnh`). |
| **`descriptionsByDocumentKind`** | `[CafDocumentTypeKey: String]?` | Substituir o texto secundário por grupo.                                        |

**`CafDocumentTypeKey`**: `rg`, `rgDigital` (`rg_digital`), `cnh`, `cnhDigital` (`cnh_digital`), `crlv`, `rne`, `ctps`, `passaporte`, `qualquer`.

#### `CafDocumentDetectorInstructionsScreen`

| Propriedade              | Tipo        | O que faz                                       | Padrão       |
| ------------------------ | ----------- | ----------------------------------------------- | ------------ |
| **`ativado`**            | `Bool`      | Ative ou desative a etapa de instruções.        | `verdadeiro` |
| **`título`**             | `String?`   | Título principal da visualização de instruções. | `nil`        |
| **`mensagem`**           | `String?`   | Texto do corpo (por ex., como escanear).        | `nil`        |
| **`etapas`**             | `[String]?` | Linhas de tópicos / etapas.                     | `nil`        |
| **`primaryButtonTitle`** | `String?`   | CTA principal (por ex., “Continuar”).           | `nil`        |
| **`headerImage`**        | `UIImage?`  | Imagem opcional acima do texto.                 | `nil`        |

#### `CafDocumentDetectorCaptureScreen`

Controles **captura ao vivo** chrome (sobreposição, controle de fechar, cores da moldura, tipografia).

| Propriedade                              | Tipo                  | O que faz                                                                   | Padrão        |
| ---------------------------------------- | --------------------- | --------------------------------------------------------------------------- | ------------- |
| **`closeButtonImage`**                   | `UIImage?`            | Personalizado **fechar** ícone.                                             | `nil`         |
| **`closeButtonSize`**                    | `CGFloat?`            | Tamanho da área de toque / do ícone.                                        | `nil`         |
| **`closeButtonTintColor`**               | `UIColor?`            | Cor de tinta do controle de fechar.                                         | `nil`         |
| **`closeButtonContentMode`**             | `UIView.ContentMode?` | Como a imagem é dimensionada.                                               | `nil`         |
| **`documentFrameNeutralColor`**          | `UIColor`             | Cor da moldura **antes** do feedback de validação.                          | **`.black`**  |
| **`documentFrameValidationFailedColor`** | `UIColor`             | Moldura quando a validação **falha**.                                       | **`#E21B45`** |
| **`documentFrameValidationPassedColor`** | `UIColor`             | Moldura quando a validação **é aprovada**.                                  | **`#0BAA43`** |
| **`fontName`**                           | `String?`             | Fonte personalizada **nome PostScript** para o texto do DD, onde aplicável. | `nil`         |

#### `CerttaDocumentDetectorCustomization`

| Propriedade            | Tipo                   | O que faz                                                                                                                                                                        |
| ---------------------- | ---------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **`ddCustomizations`** | `[CafDDCustomization]` | Array de **`CafDDUploadCustomization`**, **`CafPreviewCustomization`**, **`CafUploadMessagesCustomization`**, **`CafFailedPhotoCustomization`** (veja as personalizações de DD). |

***

### `CerttaDocumentDetectorConfiguration` (parâmetros)

Usado com **`CerttaDocumentDetector.shared.open(from:configuration:)`**.

#### Recomendado: `init(flow:ui:enableMultiLanguage:captureType:)`

| Entrada                   | Função                                                                                  |
| ------------------------- | --------------------------------------------------------------------------------------- |
| **`fluxo`**               | **`[CafDocumentDetectorStep]`** — necessário para uma sessão real (ordem das capturas). |
| **`ui`**                  | **`CerttaDocumentDetectorUIConfiguration`** — toda a UI descrita acima.                 |
| **`enableMultiLanguage`** | Propaga para o runtime (`enableMultiLanguage`). Padrão **`verdadeiro`**.                |
| **`captureType`**         | **`DocumentDetectorCaptureType`** — veja abaixo. Padrão **`.manual`**.                  |

#### `DocumentDetectorCaptureType`

Disponível em **7.9.0**Define como o documento é capturado.

| Caso             | Comportamento                                                                                            |
| ---------------- | -------------------------------------------------------------------------------------------------------- |
| **`.manual`**    | Padrão. Apenas captura manual: o botão de captura fica disponível imediatamente.                         |
| **`.automatic`** | Captura automática. Se nenhum documento for capturado em **10 segundos**, a captura manual é habilitada. |

O fallback de 10 segundos é fixo e não pode ser configurado.

```swift
CerttaDocumentDetectorConfiguration(
    flow: [CafDocumentDetectorStep(stepType: .rgFront)],
    ui: CerttaDocumentDetectorUIConfiguration(),
    captureType: .automatic
)
```

#### Legado: `init(flow:layout:uploadSettings:instructionsConfig:requestTimeout:showPreCapturePopup:showPreview:ddCustomizations:enableMultiLanguage:selectDocumentConfig:maxRetryAttempts:captureType:)`

| Parâmetro                  | Padrão                            | O que faz                                                                                                                          |
| -------------------------- | --------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- |
| **`fluxo`**                | `[]`                              | Etapas de captura.                                                                                                                 |
| **`o layout`**             | `CafDocumentDetectorLayout()`     | Veja Layout.                                                                                                                       |
| **`uploadSettings`**       | `CafUploadSettings(enable: true)` | Veja Upload.                                                                                                                       |
| **`instructionsConfig`**   | `CafInstructionsConfiguration()`  | Veja Instruções.                                                                                                                   |
| **`requestTimeout`**       | `60`                              | Segundos (`TimeInterval`).                                                                                                         |
| **`showPreCapturePopup`**  | `verdadeiro`                      | Mesmo papel da UI **`showPopup`**.                                                                                                 |
| **`showPreview`**          | `falso`                           | Pré-visualização após a captura (o padrão do caminho de UI geralmente é `verdadeiro` via `CerttaDocumentDetectorUIConfiguration`). |
| **`ddCustomizations`**     | `[]`                              | Veja as personalizações de DD.                                                                                                     |
| **`enableMultiLanguage`**  | `verdadeiro`                      | Pacotes / comportamento multilíngue.                                                                                               |
| **`selectDocumentConfig`** | `nil`                             | Texto do seletor de documentos; veja Seleção.                                                                                      |
| **`maxRetryAttempts`**     | `2`                               | Limite de tentativas.                                                                                                              |
| **`captureType`**          | `.manual`                         | Veja [`DocumentDetectorCaptureType`](#documentdetectorcapturetype).                                                                |

#### `init(from: CafDocumentDetectorConfig)`

Copia todos os campos correspondentes de uma configuração completa **`CafDocumentDetectorConfig`**. O **hub Certta** ainda se aplica **fixos** valores para campos não presentes em **`CerttaDocumentDetectorConfiguration`** ao construir a configuração de runtime (veja o README — mapeamento do Hub). Este inicializador mantém os **`manualCaptureEnabled`** e **`manualCaptureTime`** valores da configuração de origem, em vez dos valores fixos usados por **`captureType`**.

***

### `CafDocumentDetectorConfig` (modelo completo)

Use com **`CafSDKProvider.Builder`** quando você precisar de todos os controles. Lista de propriedades (padrões de **CafSDK**):

| Propriedade                      | Tipo                           | O que faz                                                                              |
| -------------------------------- | ------------------------------ | -------------------------------------------------------------------------------------- |
| **`fluxo`**                      | `[CafDocumentDetectorStep]`    | Etapas em ordem.                                                                       |
| **`o layout`**                   | `CafDocumentDetectorLayout`    | Layout da UI de captura + cores de feedback + fonte.                                   |
| **`uploadSettings`**             | `CafUploadSettings`            | Pipeline de upload.                                                                    |
| **`instructionsConfig`**         | `CafInstructionsConfiguration` | Conteúdo das instruções e das instruções de upload.                                    |
| **`manualCaptureEnabled`**       | `Bool?`                        | Permite o caminho de captura manual quando suportado.                                  |
| **`manualCaptureTime`**          | `TimeInterval`                 | Temporização da captura manual.                                                        |
| **`requestTimeout`**             | `TimeInterval`                 | Tempo limite de rede (segundos).                                                       |
| **`showPopup`**                  | `Bool`                         | Popup de instruções antes da captura.                                                  |
| **`proxySettings`**              | `CafProxySettings?`            | Opcional **proxy reverso** para o tráfego da API.                                      |
| **`previewShow`**                | `Bool`                         | Tela de pré-visualização após a captura.                                               |
| **`ddCustomizations`**           | `[CafDDCustomization]`         | Personalizações de string / tela.                                                      |
| **`getUrlExpireTime`**           | `String?`                      | Tratamento personalizado de expiração de URL de imagem, quando aplicável.              |
| **`enableMultiLanguage`**        | `Bool`                         | Multilíngue.                                                                           |
| **`currentStepDoneDelay`**       | `TimeInterval`                 | Atraso **entre** etapas (segundos).                                                    |
| **`allowedPassportCountryList`** | `[CafCountryCode]?`            | Restringir **passaporte** emissores (códigos no estilo ISO). `nil` = sem filtro extra. |
| **`selectDocumentConfig`**       | `CafSelectDocumentConfig?`     | Strings da UI de seleção de documentos.                                                |
| **`sdkType`**                    | `CafSdkPlatform`               | Tag da plataforma (por ex. **`.nativeIos`**).                                          |
| **`maxRetryAttempts`**           | `Int`                          | Máximo de tentativas por etapa.                                                        |

***

### `CafDocumentDetectorStep` & `CafDocumentStepType`

Cada etapa é um alvo de captura, opcionalmente **substituído** para rótulos e ativos.

#### `CafDocumentStepType`

| Caso                                   | Significado                              |
| -------------------------------------- | ---------------------------------------- |
| **`rgFront` / `rgBack` / `rgFull`**    | Variantes de identidade brasileira (RG). |
| **`cnhFront` / `cnhBack` / `cnhFull`** | Variantes da CNH.                        |
| **`crlv`**                             | CRLV.                                    |
| **`rneFront` / `rneBack`**             | RNE.                                     |
| **`ctpsFront` / `ctpsBack`**           | CTPS.                                    |
| **`passaporte`**                       | Passaporte.                              |
| **`qualquer`**                         | Captura genérica / flexível.             |

#### `CafDocumentDetectorStep` campos

| Propriedade               | Tipo                  | O que faz                                                      |
| ------------------------- | --------------------- | -------------------------------------------------------------- |
| **`stepType`**            | `CafDocumentStepType` | Qual face do documento capturar.                               |
| **`customStepLabel`**     | `String?`             | Substituir o título da etapa na UI.                            |
| **`customIllustration`**  | `UIImage?`            | Ilustração personalizada para esta etapa.                      |
| **`showStepLabel`**       | `Bool`                | Mostrar ou ocultar o rótulo da etapa. Padrão **`verdadeiro`**. |
| **`customMessage`**       | `String?`             | Mensagem de instrução específica da etapa.                     |
| **`customOkButtonTitle`** | `String?`             | Título do botão principal para esta etapa.                     |

***

### `CafDocumentDetectorLayout` & cores de feedback

#### `CafDocumentDetectorLayout`

| Propriedade / API                                                                                   | O que faz                                                                                                      |
| --------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- |
| **`closeButtonImage`**, **`closeButtonSize`**, **`closeButtonColor`**, **`closeButtonContentMode`** | Controle de fechar; use **`setCloseButton(size:color:image:contentMode:)`** para definir em uma única chamada. |
| **`feedbackColors`**                                                                                | **`CafDocumentFeedbackColors`** — cores da linha da moldura; **`setFeedbackColors(_:)`**.                      |
| **`fonte`**                                                                                         | Nome da fonte PostScript para o texto aplicável do DD. **`setFont(name:)`**.                                   |

#### `CafDocumentFeedbackColors`

| Propriedade        | Padrão    | O que faz           |
| ------------------ | --------- | ------------------- |
| **`defaultColor`** | `.black`  | Moldura neutra.     |
| **`errorColor`**   | `#E21B45` | Validação falhou.   |
| **`successColor`** | `#0BAA43` | Validação aprovada. |

***

### `CafInstructionsConfiguration`

Dividido em **campos de captura** e **o envio** conteúdo de instruções (o Document Detector usa principalmente **campos de captura** campos).

| Propriedade                                                                                                              | Usado para DD (caminho de captura)                       |
| ------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------- |
| **`ativado`**                                                                                                            | Interruptor principal das instruções.                    |
| **`captureTitle`**, **`captureDescriptionText`**, **`captureSteps`**, **`captureButtonTitle`**, **`captureHeaderImage`** | Tela de instruções antes da captura.                     |
| **`uploadTitle`**, **`uploadDescriptionText`**, **`uploadSteps`**, **`uploadButtonTitle`**, **`uploadHeaderImage`**      | Instruções da fase de upload (se o seu fluxo as exibir). |

***

### `CafSelectDocumentConfig` & `CafDocumentTypeKey`

| Propriedade              | O que faz                                                       |
| ------------------------ | --------------------------------------------------------------- |
| **`screenTitle`**        | Título da seleção de documentos.                                |
| **`descrição`**          | Subtítulo / texto de ajuda.                                     |
| **`customTitles`**       | Map **`CafDocumentTypeKey` → String** para títulos por tipo.    |
| **`customDescriptions`** | Map **`CafDocumentTypeKey` → String** para descrições por tipo. |

***

### `CafUploadSettings` & `CafFileFormatWrapper`

#### `CafUploadSettings`

| Propriedade           | Padrão                                                 | O que faz                                                                                                                |
| --------------------- | ------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ |
| **`ativar`**          | `verdadeiro` (em **`CafDocumentDetectorConfig`** init) | Ative/desative o upload. **UI da Certta** o padrão geralmente é **`falso`** via `CerttaDocumentDetectorUIConfiguration`. |
| **`comprimir`**       | `verdadeiro`                                           | Comprimir antes do upload.                                                                                               |
| **`fileFormats`**     | PNG, JPEG, HEIF, PDF, HEIC                             | Permitido **`CafFileFormatWrapper`** valores.                                                                            |
| **`maximumFileSize`** | `10_000_000`                                           | Tamanho máximo em **bytes**.                                                                                             |

#### `CafFileFormatWrapper`

`png`, `jpeg`, `pdf`, `heif`, `heic` — mapeia internamente para strings da UTI.

***

### `CafProxySettings`

| Propriedade                     | O que faz                                                          |
| ------------------------------- | ------------------------------------------------------------------ |
| **`nome do host`**, **`porta`** | Endpoint do proxy (obrigatório em **`init(hostname:port:)`**).     |
| **`usuário`**, **`senha`**      | Autenticação opcional via **`setAuthentication(user:password:)`**. |

***

### `CafDDCustomization` tipos

Todos estão em conformidade com **`CafDDCustomization`**. Passe-os dentro de **`CerttaDocumentDetectorCustomization.ddCustomizations`** ou **`CafDocumentDetectorConfig.ddCustomizations`**. Eles são aplicados ao nativo **DocumentDetector** construtor (`setCustomStrings`).

#### `CafDDUploadCustomization`

Popup ao redor de **o envio** confirmação: **`imagem`**, **`mensagem`**, **`botão de envio`**, **`botão cancelar`**.

#### `CafPreviewCustomization`

**Pré-visualização** tela após a captura: **`título`**, **`mensagem`**, **`botão OK`**, **`botão tentar novamente`**.

#### `CafUploadMessagesCustomization`

**Progresso** strings durante o envio: **`enviando`**, **`verificando integridade`**, **`processando dados`**, **`quase concluído`**, **`tempo entre mensagens`**.

#### `CafFailedPhotoCustomization`

**Captura ruim** folha: **`título`**, **`descrição`**, **`botão continuar`**.

***

### Lista de permissões do passaporte (`CafCountryCode`)

**`allowedPassportCountryList`**: array de **`CafCountryCode`** (códigos no estilo ISO baseados em string, por exemplo **`bra`**, **`usa`**). Limita quais **passaporte** emissores são aceitos quando essa validação se aplica. **`nil`** significa sem restrição baseada em lista.

A enumeração é grande; veja **`CafCountryCode.swift`** em **CafSDK** para a lista completa.

***

### Cores globais

O Detector de Documentos respeita **`CafColorConfiguration`** fornecido via **Certta** (**`configurar`** / **`setColorConfiguration`**) para a UI compartilhada do CAF. Veja **Cores e tema**.

***


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.caf.io/caf-sdk/caf-sdk-pt-br/ios/getting-started-with-the-sdk-2/customizing-document-detector.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
