---
title: API de Captura
canonical: https://developer.unico.io/pt-BR/developers/sdks-and-tools/ios/api-reference/capture-api
locale: pt-BR
generated_by: markdown-export
---

- [/pt-BR/](/pt-BR/)
- [SDKs e Ferramentas](/pt-BR/developers/sdks-and-tools/overview)
- [iOS SDK](/pt-BR/developers/sdks-and-tools/ios/requirements)
- Referência de API
- API de Captura

# API de Captura

Métodos para iniciar uma sessão
| Método | Descrição |
| --- | --- |
| `prepareSelfieCamera(_:config:)` | Prepara a câmera de selfie |
| `prepareSelfieCamera(_:config:prepareInfo:)` | Prepara a câmera de selfie com metadados `PrepareInfo` |
| `prepareDocumentCamera(_:config:)` | Prepara a câmera de documento |
| `open(_:webAppToken:)` | Abre a câmera de selfie preparada, passando o `process.webAppToken` retornado por Create Process |
| `openDocument(_:delegate:)` | Abre a câmera de documento preparada com um `DocumentEnums` |

Opções / parâmetros de captura
**`PrepareInfo`** — metadados para identificar a sessão do usuário.

| Campo | Tipo | Obrigatório | Descrição |
| --- | --- | --- | --- |
| `externalUserId` | `String` | sim | Identificador do usuário no seu sistema. Gerado hash SHA-256 antes da transmissão. |
| `useCase` | `String` | não | Identificador do contexto ou fluxo em execução. Transmitido em texto simples. |

**`DocumentEnums`** — consulte [Enums](/pt-BR/developers/sdks-and-tools/ios/api-reference/enums).

Tipos de resultado e campos
**`SelfieResult`** — objeto retornado em captura de selfie bem-sucedida.

| Campo | Tipo | Descrição |
| --- | --- | --- |
| `base64` | `String` | Imagem capturada em Base64 |
| `encrypted` | `String` | JWT a ser enviado ao backend |

**`SuccessResult`** — objeto retornado por `onSuccess` em uma integração com a Unico API.

| Campo | Tipo | Descrição |
| --- | --- | --- |
| `processId` | `String` | Identificador do processo usado para consultar o resultado da validação via API REST |

**`DocumentResult`** — objeto retornado em captura de documento bem-sucedida. Mesmos campos que `SelfieResult`.

Última atualização em **15 de out. de 2026**