> 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/standalone-modules/cafsdk.md).

# CafSDK

Bem-vindo à documentação de **CafSDK**, um SDK iOS unificado e modular que oferece soluções robustas para detecção de documentos e validação de vivacidade facial.

***

* [Visão geral](#overview)
* [Recursos](#features)
* [Requisitos](#requirements)
* [Instalação](#installation)
  * [Swift Package Manager (SPM)](#swift-package-manager-spm)
  * [CocoaPods](#cocoapods)
* [Uso](#usage)
* [Arquitetura do Módulo](#module-architecture)

***

## Visão geral

**CafSDK** é um SDK iOS abrangente que integra duas funcionalidades principais:

* **Detecção de Documentos:** Baseado no [DocumentDetector](/caf-sdk/caf-sdk-pt-br/ios/standalone-modules/document-detector.md) framework e TensorFlow Lite.
* **Validação de Vivacidade Facial:** Disponibilizada por meio do [CafFaceLiveness](/caf-sdk/caf-sdk-pt-br/ios/standalone-modules/caffaceliveness.md) módulo, que oferece suporte tanto a **iProov** e **FaceTec 2D** provedores. Esses provedores podem ser usados de forma independente ou em combinação, oferecendo a flexibilidade de adaptar a solução às suas necessidades.

Essa abordagem unificada permite que os desenvolvedores incluam apenas os módulos necessários, reduzindo o excesso e simplificando a integração.

***

## Recursos

* **Modularidade:** Integre o SDK completo ou selecione componentes individuais.
* **Facilidade de Integração:** Compatível com Swift Package Manager e CocoaPods.
* **Segurança e Precisão:** Aproveita frameworks avançados (por exemplo, TensorFlow Lite, iProov, FaceTec) para uma validação robusta de documentos e faces.
* **Escalabilidade:** Projetado para iOS 13.0+, garantindo compatibilidade com dispositivos modernos.

***

## Requisitos

| Informações de implantação | Versão |
| -------------------------- | ------ |
| **Alvo do iOS**            | 13.0+  |
| **Xcode**                  | 15.4+  |
| **Swift**                  | 5.10+  |

***

## Instalação

### Swift Package Manager (SPM)

Para adicionar **CafSDK** usando SPM, inclua a seguinte dependência no seu `Package.swift` arquivo:

```swift
dependencies: [
    .package(url: "https://github.com/combateafraude/caf-ios-sdk.git", from: "0.1.1")
]
```

Depois, adicione os produtos desejados ao target do seu app:

```swift
.target(
    name: "YourApp",
    dependencies: [
        .product(name: "CafSDK", package: "CafSDK"),            // SDK completo
        .product(name: "DocumentDetector", package: "CafSDK"),    // Apenas DocumentDetector
        .product(name: "CafFaceLiveness", package: "CafSDK"),       // Apenas CafFaceLiveness
        .product(name: "IproovProvider", package: "CafSDK"),        // Provedor iProov opcional
        .product(name: "FaceTec2DProvider", package: "CafSDK"),     // Provedor FaceTec 2D opcional
    ]
)
```

### CocoaPods

Para instalar usando `CocoaPods`, adicione o seguinte ao seu `Podfile`:

```bash
# SDK completo
pod 'CafSDK'

# Apenas DocumentDetector
pod 'CafSDK/DocumentDetector'

# Apenas CafFaceLiveness
pod 'CafSDK/CafFaceLiveness'

# Provedor iProov opcional
pod 'CafSDK/IproovProvider'

# Provedor FaceTec 2D opcional
pod 'CafSDK/FaceTec2DProvider'
```

## Uso

Para importar e usar **DocumentDetector ou CafFaceliveness** no seu app, adicione a seguinte instrução de importação no início dos seus arquivos Swift:

```swift
import DocumentDetector
import CafFaceliveness
```

Documentação:

[DocumentDetector](/caf-sdk/caf-sdk-pt-br/ios/standalone-modules/document-detector.md)[CafFaceLiveness](/caf-sdk/caf-sdk-pt-br/ios/standalone-modules/caffaceliveness.md)

## Arquitetura do Módulo

O CafSDK unificado é organizado em vários componentes modulares:

* `CafSDK`: O módulo guarda-chuva para as funcionalidades principais.
* `DocumentDetector`: Fornece detecção segura de documentos usando TensorFlow Lite.
* `CafFaceLiveness`: Gerencia a validação de vivacidade facial.
* `IproovProvider`: Integra a solução de vivacidade facial da iProov.
* `FaceTec2DProvider`: Integra a solução de vivacidade facial FaceTec 2D.


---

# 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 dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.caf.io/caf-sdk/caf-sdk-pt-br/ios/standalone-modules/cafsdk.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.