> 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/flutter/standalone-modules/documentdetector/builder.md).

# Building the SDK

## Creating a Document Detector SDK Instance

To create an instance of `DocumentDetector`, configure it using the provided methods to suit your application's needs.

### Builder Methods

| Parameter                                      | Description                                                                                       | Required |
| ---------------------------------------------- | ------------------------------------------------------------------------------------------------- | :------: |
| **setAndroidSettings(AndroidSettings)**        | Configures Android-specific settings, including security configurations like root detection.      |     ✅    |
| **setStage(CafStage)**                         | Defines the environment stage (e.g., `PROD`, `BETA`). Default: `PROD`.                            |     ✅    |
| **setPersonId(String)**                        | Associates a unique person ID or CPF for the document capture flow.                               |     ✅    |
| **setPreviewSettings(PreviewSettings)**        | Enables or disables the preview screen for document capture. Default: `true`.                     |     ❌    |
| **setNetworkSettings(int)**                    | Sets the network timeout duration in seconds. Default: `20`.                                      |     ❌    |
| **setUploadSettings(UploadSettings)**          | Configures upload-related settings when capturing documents.                                      |     ❌    |
| **setDisplayPopup(bool)**                      | Toggles the display of instructional popups before each capture step. Default: `true`.            |     ❌    |
| **setCountryCodeList(List)**                   | Restricts accepted passport documents to specific countries.                                      |     ❌    |
| **setMessageSettings(MessageSettings)**        | Customizes the messages displayed during the capture process.                                     |     ❌    |
| **setUrlExpirationTime(String)**               | Configures the expiration time for image URLs on the server (e.g., "30m", "10d"). Default: `30m`. |     ❌    |
| **setUseAnalytics(bool)**                      | Enables or disables data collection for analytics. Default: `false`.                              |     ❌    |
| **setIOSSettings(IOSSettings)**                | Configures iOS-specific settings.                                                                 |     ❌    |
| **setCurrentStepDoneDelayAndroid(bool, int?)** | Enables or disables delay between capture steps on Android, and sets the duration (milliseconds). |     ❌    |
| **setCurrentStepDoneDelayIOS(int)**            | Sets the delay duration (in seconds) between capture steps on iOS.                                |     ❌    |

### Example Implementation (Flutter)

Below is an example of how to integrate and configure the Document Detector SDK in a Flutter application.

```dart
void startDocumentDetector(List<DocumentCaptureFlow> captureFlow) async {
  String personId = personIdController.text;
  String mobileToken = mobileTokenController.text;

  DocumentDetector documentDetector =
      DocumentDetector(mobileToken: mobileToken, captureFlow: captureFlow);

  // Configure Android-specific settings
  AndroidSettings androidSettings = AndroidSettings(
      securitySettings: SecuritySettings(
          useAdb: true,
          useDebug: true,
          useDeveloperMode: true,
          useEmulator: true,
          useRoot: true));

  documentDetector.setAndroidSettings(androidSettings);
  documentDetector.setNetworkSettings(20);
  documentDetector.setStage(isBeta ? CafStage.beta : CafStage.prod);
  documentDetector.setPersonId(personId);
  documentDetector.setPreviewSettings(PreviewSettings(show: true));

  try {
    DocumentDetectorEvent event = await documentDetector.start();
    // Handle the result
    if (event is DocumentDetectorEventSuccess) {
      print("SUCCESS: ${event.documentType}");
    } else if (event is DocumentDetectorEventFailure) {
      print("FAILURE: ${event.errorMessage}");
    } else if (event is DocumentDetectorEventClosed) {
      print("User closed document capture flow");
    }
  } catch (e) {
    print("Error starting DocumentDetector: ${e}");
  }
}
```


---

# 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/flutter/standalone-modules/documentdetector/builder.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.