String mobileToken
Token associado à sua conta, para usar o SDK.
| Sim. | |.setDocumentSteps(DocumentDetectorStep\[] documentSteps)
Define o fluxo de captura do documento conforme explicado aqui
| Sim. | |.setPeopleId(String peopleId)
Identificador do usuário para fins de identificação do perfil de fraude e para auxiliar na identificação de logs do Analytics em casos de bugs e erros.
| Não. Usado apenas para [analytics](https://github.com/combateafraude/public-docs/blob/docs-sdks/analytics.md) fins. | |.setAnalyticsSettings(boolean useAnalytics)
Ativa/desativa a coleta de dados para analytics.
| Não. O valor padrão é true. | |.setCaptureStages(CaptureStage\[] captureStages)
Configura os requisitos para cada etapa de captura. Normalmente variando da mais exigente, que requer a maior qualidade, até a menos exigente, com a menor qualidade, conforme explicado aqui.
| Não. | |.setPopupSettings(boolean show)
Ativa/desativa os pop-ups exibidos antes de cada captura de documento.
| Não. O valor padrão é true. | |.setLayout(@Nullable @LayoutRes Integer layoutId)
Substitui o layout padrão do SDK. Crie um arquivo na pasta layout do seu projeto, copie este modelo e faça as alterações que desejar.
| Não. | |.setMask(MaskType type)
Define o design da máscara exibida durante as capturas. Há três tipos:
MaskType.DEFAULT, com o padrão pontilhado no formato do documento;MaskType.DETAILED, que mostra uma ilustração do documento solicitado, juntamente com a máscara pontilhada;MaskType.NONE, que remove completamente a máscara..setMask(@DrawableRes Integer greenMask, @DrawableRes Integer whiteMask, @DrawableRes Integer redMask)
Permite a personalização completa das máscaras exibidas durante a captura do documento. São necessários três tipos, um para cada feedback de validação do documento durante a captura: SUCCESS (greenMask), NORMAL (whiteMask) e ERROR (redMask). Ao optar por esta opção, use máscaras com a mesma área de detecção do documento; isso é extremamente importante para que o algoritmo faça as validações durante a captura.
|Não. Veja nossos modelos de máscara para obter a área de detecção:
| |.setStyle(@StyleRes int styleResourceId)
Configure uma nova diretriz de estilo para o SDK. Crie um arquivo styles.xml no seu projeto com este modelo e personalize-o.
| Não. | |.setAudioSettings(boolean enable)
Ativa/desativa a reprodução de áudio do SDK.
| Não. O valor padrão é **`true`**. | |.setNetworkSettings(int requestTimeout)
Define o das requisições tempo limite.
| Não. O valor padrão é 60 (segundos). | |.setLuminositySensorSettings(@Nullable SensorLuminositySettings sensorLuminositySettings)
Define o limite entre brilho ambiente aceitável/não aceitável. Defina null se você não quiser usar este sensor.
.setOrientationSensorSettings(@Nullable SensorOrientationSettings sensorOrientationSettings)
Define o limite entre a orientação correta/incorreta do dispositivo. Quanto maior o valor, mais flexível ele será. Defina null se você não quiser usar este sensor.
.setStabilitySensorSettings(@Nullable SensorStabilitySettings sensorStabilitySettings)
Define as configurações do sensor de estabilidade. Defina null se você não quiser usar este sensor.
.setProxySettings(@Nullable ProxySettings proxySettings)
Define as configurações de proxy. Siga o este guia.
| Não. A configuração padrão é **`null`**. | |.setPreviewSettings(@NonNull PreviewSettings previewSettings)
Ativa/desativa e permite configurar a visualização da captura realizada, solicitando a confirmação do usuário para prosseguir.
| Não. O padrão é desativado. | |.setAutoDetection(boolean enable)
Ativa/desativa a detecção automática e as verificações dos sensores. Use false para desativar todas as verificações no dispositivo. Dessa forma, todas as validações serão realizadas no backend após a captura.
| Não. O padrão é **`true`**. | |.setCurrentStepDoneDelay(boolean showDelay, int delay)
Atraso a atividade após a conclusão de cada etapa. Este método pode ser usado para exibir uma mensagem de sucesso na própria tela após a captura, por exemplo.
| Não. O padrão é **`false`**. | |.setMessageSettings(MessageSettings messageSettings)
Permite personalizar as mensagens exibidas no balão de "status" durante o processo de captura e análise. Veja os atributos disponíveis aqui.
| Não. | |.enableSwitchCameraButton(boolean enable)
Ativa/desativa o botão para o usuário alternar entre as câmeras frontal e traseira.
| Não. O padrão é **`true`**. | |.setResolutionSettings(Resolution resolution)
Permite definir a resolução de captura. O método recebe como parâmetro uma Resolução que possui as seguintes opções:
HD: 720x1280FULL\_HD: 1080x1920QUAD\_HD: 1440x2560ULTRA\_HD: 2160x3840.setCompressSettings(@IntRange(from = 50, to = 100) int compressQuality)
Permite configurar a qualidade no processo de compressão. Por padrão, todas as capturas passam por compressão. O método espera como parâmetro valores entre 50 e 100, sendo 100 a compressão de melhor qualidade (recomendada).
| Não. O padrão é **`100`**. | |.enableGoogleServices(boolean enable)
Permite ativar/desativar recursos do SDK que consomem GoogleServices no SDK; não recomendamos desativar os serviços devido à perda de segurança.
| Não. O padrão é **`true`**. | |.setUseEmulator(boolean use)
Permite o uso de emuladores quando true. Não é recomendado ativar esta opção; use-a apenas para fins de teste.
.setUseRoot(boolean use)
Permite o uso de dispositivos com root quando true. Não é recomendado ativar esta opção; use-a apenas para fins de teste.
.setUseDeveloperMode(boolean use)
Ativa o uso do modo desenvolvedor quando true. Não é recomendado ativar esta opção; use-a apenas para fins de teste.
.setUseAdb(boolean use)
Ativa o modo de depuração do Android Debug Bridge (ADB) quando true. Não é recomendado ativar esta opção; use-a apenas para fins de teste.
.setUseDebug(boolean use)
Permite usar o app em modo de depuração quando true. Não é recomendado ativar esta opção; use-a apenas para fins de teste.
.setGetImageUrlExpireTime (String expireTime)
Define por quanto tempo a URL da imagem ficará no servidor até expirar. Espere receber um intervalo de tempo entre "30m" e "30d".
Exemplos:
setGetImageUrlExpireTime("30m"): Para configurar apenas minuto(s)setGetImageUrlExpireTime("24h"): Para configurar apenas hora(s)setGetImageUrlExpireTime("1h 10m"): Para definir hora(s) e minuto(s)setGetImageUrlExpireTime("10d"): Para configurar dia(s).setUploadSettings(UploadSettings uploadSettings)
Define as configurações para o envio de documentos. Ao ativar esta opção, o fluxo do SDK solicitará que o usuário envie os arquivos do documento em vez de capturá-los com a câmera do dispositivo. Esta opção também inclui verificações de qualidade do documento. Veja como configurá-la aqui.
| Não. Por padrão, esta opção está desativada. | |.setAllowedPassportCountriesList(CountryCodeList\[] countryList)
Ativa a opção de permitir passaportes de apenas um determinado país emissor ou de uma lista de países. Veja a lista completa em: ISO 3166-1 alpha-3
Exemplo:
.setAllowedPassportCountriesList(new CountryCodesList\[]{CountryCodesList.BRA}).setStage(CafStage stage)
Permite escolher o ambiente em que o SDK será executado (produção, beta). O método recebe como parâmetro um enum CafStage para selecionar o ambiente:
documento Document
Identifica qual documento você deseja capturar na respectiva etapa. Veja os tipos de documentos suportados aqui.
| Sim. | |.setStepLabel(@StringRes int stepLabel)
Define o texto a ser exibido na parte inferior do layout.
| Não. Existe um padrão por **`Documento`** tipo. | |.setIllustration(@StringRes int illustration)
Define a ilustração a ser exibida no pop-up antes da captura.
| Não. Existe um padrão por **`Documento`** tipo. | |.setStepAudio(@RawRes int stepAudio)
Define o áudio que será reproduzido no início da etapa.
| Não. Existe um padrão por **`Documento`** tipo. | |.setMask(@DrawableRes Integer whiteMaskResId, @DrawableRes Integer greenMaskResId, @DrawableRes Integer redMaskResId)
Define as máscaras para cada tipo de documento. O uso deste método substitui as máscaras definidas no .setMask método da DocumentDetector.Builder.
Long durationMillis
Duração da etapa, em milissegundos. Se você não quiser um tempo limite, defina null.
boolean wantSensorCheck
Ativa/desativa o uso de sensores para capturar a foto.
| |QualitySettings qualitySettings
Configurações da verificação de qualidade do documento. Se você não quiser verificar a qualidade do documento, defina null.
DetectionSettings detectionSettings
Configurações para detecção automática de documentos. Se você não quiser usar a detecção automática, defina null.
CaptureMode captureMode
Modo de captura do documento, que pode ser CaptureMode.AUTOMATIC ou CaptureMode.MANUAL. Na captura manual, um botão será habilitado para o usuário realizar a captura.
double threshold
Limite que define se a captura do documento tem qualidade ou não.
| Varia de 1,0 a 5,0, sendo 1,8 o limite recomendado. | #### **DetectionSettings** | Parâmetro | Observações | | -------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------ | |double threshold
Limite que define se o documento exibido pelo usuário é ou não o documento solicitado.
| Um valor entre 0,0 e 1,0, sendo 0,95 o recomendado. | |int consecutiveFrames
Número de quadros consecutivos corretos para aceitação do documento.
| 5 é o recomendado. Quanto mais quadros, mais tempo levará para detectar o documento. | ### **UploadSettings** Para habilitar a funcionalidade de envio de documentos, é necessário instanciar um objeto do tipo UploadSettings(boolean enable) e definir seus parâmetros: | Parâmetro | Obrigatório | | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------ | |.setEnable(Boolean enable)
Ativa/desativa este recurso.
| Não. O padrão é true. | |.setCompress(Boolean enable)
Ativa/desativa a compressão de arquivos antes do envio.
| Não. O padrão é **`true`**. | |.setFileFormats(FileFormat\[] fileFormats)
Define o(s) formato(s) de arquivo que serão aceitos para envio.
| Não. Por padrão, .PDF, .JPG, .JPEG, .PNG, .HEIF são aceitos. | |.setMaxFileSize(Integer maxFileSize)
Define o limite máximo em KB do arquivo a ser enviado.
| Não. O limite padrão é 10000 KB (10 MB). | |.setActivityLayout ( Integer activityLayout)
Define o layout de fundo do envio do documento.
| Não. | |.setPopUpLayout (Integer popUpLayout)
Define o layout do pop-up de solicitação de envio do documento.
| Não. | Atualmente, os formatos de arquivo suportados são: ```java public enum FileFormat { PNG("image/png"), JPG ("image/jpg"), JPEG ("image/jpeg"), PDF("application/pdf"), HEIF("image/heif"); } ``` ### **MessageSettings** Para usar, basta instanciar um **`MessageSettings`** objeto e usar os métodos conforme necessário para personalização. | Método | Valor padrão | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | |.setPopupDocumentSubtitleMessage(@NonNull @StringRes Integer message)
Mensagem exibida no subtítulo do pop-up que traz a ilustração do documento cuja captura está sendo solicitada.
| “Posicione o documento em uma mesa, centralize-o na marcação e aguarde a captura automática.” | |.setFitTheDocumentMessage(Integer message)
Mensagem informando para encaixar o documento na máscara.
| "Encaixe o documento na marcação" | |.setHoldItMessage(Integer message)
Mensagem exibida no momento em que a captura está sendo realizada.
| "Segure assim" | |.setVerifyingQualityMessage(Integer message)
Mensagem exibida quando o SDK faz uma requisição ao backend, verificando a qualidade.
| "Verificando qualidade…" | |.setLowQualityDocumentMessage(Integer message)
Mensagem exibida quando a qualidade da captura falha.
| "Ops, não foi possível ler as informações. Por favor, tente novamente" | |.setUploadingImageMessage(Integer message)
Mensagem exibida quando não há verificação de qualidade e a captura está sendo salva nos servidores.
| "Enviando imagem…" | |.setShowOpenDocumentErrorMessage(boolean show, @Nullable Integer message)
Mensagem exibida ao mostrar um documento aberto; a mensagem será exibida junto com a mensagem de erro no documento em uso. Exemplo: se o usuário apresentar uma CNH aberta (carteira de motorista brasileira), a mensagem de erro padrão "Essa é uma CNH Aberta" + a mensagem definida será exibida.
| "Use o documento fechado e tente novamente" | |.setWaitMessage(boolean show, @Nullable Integer message)
Mensagem exibida ao iniciar a câmera.
| "Aguarde..." | |.setSensorLuminosityMessage(@NonNull @StringRes Integer message)
Mensagem exibida quando o limite de brilho é menor do que o esperado.
| "Ambiente muito escuro" | |.setSensorOrientationMessage(@NonNull @StringRes Integer message)
Mensagem exibida quando o limite de orientação é menor do que o esperado.
| "Celular não está na vertical" | |.setSensorStabilityMessage(@NonNull @StringRes Integer message)
Mensagem exibida quando o limite de orientação é menor do que o esperado.
| "Mantenha o celular parado" | |.setWrongDocumentMessage\_RG\_FRONT(Integer message)
Mensagem exibida quando a frente do RG (carteira de identidade brasileira) é exibida em um fluxo diferente do esperado.
| "Ops, esta é a frente do RG" | |.setWrongDocumentMessage\_RG\_BACK(Integer message)
Mensagem exibida quando a versão do RG (carteira de identidade brasileira) é exibida em um fluxo diferente do esperado.
| "Ops, este é o verso do RG" | |.setWrongDocumentMessage\_RG\_FULL(Integer message)
Mensagem exibida quando o RG aberto (carteira de identidade brasileira) é exibido em um fluxo diferente do esperado.
| "Ops, este é o RG aberto" | |.setWrongDocumentMessage\_CNH\_FRONT(Integer message)
Mensagem exibida quando a frente da CNH (Carteira Nacional de Habilitação) é exibida em um fluxo diferente do esperado.
| "Ops, esta é a frente da CNH" | |.setWrongDocumentMessage\_CNH\_BACK(Integer message)
Mensagem exibida quando a versão da CNH (Carteira Nacional de Habilitação) é exibida em um fluxo diferente do esperado.
| "Ops, este é o verso da CNH" | |.setWrongDocumentMessage\_CNH\_FULL(Integer message)
Mensagem exibida quando a CNH aberta (Carteira Nacional de Habilitação) é exibida em um fluxo diferente do esperado.
| "Ops, esta é a CNH aberta" | |.setWrongDocumentMessage\_CRLV(Integer message)
Mensagem exibida quando o CRLV (Certificado de Registro e Licenciamento de Veículo) é exibido em um fluxo diferente do esperado.
| "Ops, este é o CRLV" | |.setWrongDocumentMessage\_RNE\_FRONT(Integer message)
Mensagem exibida quando a frente do RNE (Registro Nacional de Estrangeiros) é exibida em um fluxo diferente do esperado.
| "Ops, esta é a frente do RNE" | |.setWrongDocumentMessage\_RNE\_BACK(Integer message)
Mensagem exibida quando o verso do RNE (Registro Nacional de Estrangeiros) é exibido em um fluxo diferente do esperado.
| "Ops, este é o verso do RNE" | |.setPositiveButtonMessage(Integer message)
Permite personalizar a mensagem do botão de confirmação.
| Não. O padrão é "Ok, entendi!" | |.setUploadedImageIsTooLargeTitle
Define o título do pop-up de envio quando o arquivo enviado excede o tamanho máximo permitido.
| Não. O padrão é "Tamanho do arquivo excedido" | |.setUploadedImageIsTooLargeMessage
Define a mensagem do pop-up de envio quando o arquivo enviado excede o tamanho máximo permitido.
| Não. O padrão é "Parece que o arquivo que você escolheu excede o tamanho permitido. Tente enviar um arquivo menor." | |.setUploadedImageHasInvalidFormatTitle
Define o título do pop-up de envio quando o formato do arquivo enviado não é válido.
| Não. O padrão é "Formato inválido." | |.setUploadedImageNotSupportedFormatMessage
Define a mensagem do pop-up de envio quando o formato do arquivo enviado não é válido.
| Não. O padrão é "Parece que o formato do arquivo não é suportado. Tente reenviar usando os formatos JPG, PNG ou PDF." | |.setUploadedImageGenericErrorTitle
Define o título genérico de erro do pop-up de envio.
| Não. O padrão é "Ops, algo deu errado." | |.setUploadedImageWrongMessage
Define a mensagem de erro genérica do pop-up de envio.
| Não. O padrão é "Parece que o documento não é o esperado. Envie um arquivo com o tipo de documento solicitado." | |.setUploadedImageLowQualityTitle
Define o título do pop-up de envio quando a qualidade da imagem enviada falha.
| Não. O padrão é "Ops, qualidade baixa" | |.setUploadedImageLowQualityMessage
Define a mensagem do pop-up de envio quando a qualidade da imagem enviada falha.
| Não. O padrão é "Parece que a qualidade da imagem do documento está muito baixa. Tente enviar um arquivo com melhor qualidade." | |.setUploadPopupLoadingMessage
Define a mensagem exibida no pop-up de envio enquanto o arquivo está sendo enviado.
| Não. O padrão é "Enviando documento" | **Exemplo** ```java MessageSettings messageSettings = new MessageSetings() .setFitTheDocumentMessage(R.string.exempleFit) .setHoldItMessage(R.string.exempleHoldIt); ``` ### **Validações de segurança** Estamos constantemente tomando medidas para tornar o produto cada vez mais seguro, mitigando uma série de ataques observados no processo de captura e, consequentemente, reduzindo ao máximo possível as fraudes de identidade. O SDK possui alguns bloqueios que podem impedir sua execução em determinados contextos. **Para** **desativá-las**, você pode usar os métodos conforme mostrado no exemplo abaixo: ```java DocumentDetector.Builder("mobileToken") .setUseEmulator(true) .setUseRoot(true) .setUseDeveloperMode(true) .setUseAdb(true) .setUseDebug(true) .build(); ``` {% hint style="warning" %} A desativação das validações de segurança é recomendada **apenas para fins de teste**. Para publicar seu aplicativo em produção, recomendamos usar as configurações padrão. {% endhint %} ## Iniciando a Activity Depois de criar o **`DocumentDetector`**, inicie a **`DocumentDetectorActivity`** passando este objeto como parâmetro via extra do intent: ```java Intent mIntent = new Intent(context, DocumentDetectorActivity.class); mIntent.putExtra(DocumentDetector.PARAMETER_NAME, mDocumentDetector); startActivityForResult(mIntent, REQUEST_CODE); ``` ## Obtendo o resultado Para obter o **`DocumentDetectorResult`** objeto, que contém as capturas feitas pelo SDK, sobrescreva o **`onActivityResult`** método na mesma Activity em que você iniciou a **`DocumentDetectorActivity`**: ```java @Override protected void onActivityResult(int requestCode, int resultCode, Intent data) { if (requestCode == REQUEST_CODE){ if (resultCode == RESULT_OK && data != null){ DocumentDetectorResult mDocumentDetectorResult = (DocumentDetectorResult) data.getSerializableExtra(DocumentDetectorResult.PARAMETER_NAME); // verifique mDocumentDetectorResult.getSDKFailure() para descobrir por que o SDK foi encerrado } else { // o usuário fechou a activity } } super.onActivityResult(requestCode, resultCode, data); } ``` ### **DocumentDetectorResult** | Parâmetro | Permitir nulo | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | |Capture\[] captures
A matriz com as respectivas capturas dos documentos parametrizados.
| Sim, em caso de erro | |String type
A classe do fluxo do documento lido. Este parâmetro é útil em uma integração com nossa rota de OCR.
| Sim, em caso de erro ou quando você não conseguir verificar a qualidade. | |String trackingId
Identificador desta execução em nossos servidores. Se possível, salve este campo e envie-o para nossa API. Dessa forma, teremos mais dados sobre como o usuário se comportou durante a execução.
| Sim, se o usuário definir **`useAnalytics = false`** ou as chamadas de analytics não funcionam. | |SDKFailure sdkFailure
Objeto que informa o motivo do encerramento do SDK. Para mais informações, veja aqui.
| Sim, em caso de sucesso | #### **Captura** | Parâmetro | Permitir nulo | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------- | |String imagePath
Caminho completo da imagem no dispositivo do usuário.
| Não. | |String imageUrl
URL do documento no servidor da CAF.
| Não. | |String label
Identificação do tipo do documento capturado, entre as seguintes possibilidades: \["blank", "cnh\_back", "cnh\_front", "cnh\_full", "new\_cnh\_back", "new\_cnh\_front", "new\_cnh\_full", "crlv", "crlv\_new", "generic", "rg\_back", "rg\_front", "rg\_full", "rg\_new\_back", "rg\_new\_front", "rg\_new\_full", "rne\_back", "rne\_front", "rnm\_back", "rnm\_front", "ctps\_back", "ctps\_front", "passport", "cin\_front", "cin\_back"].
Qualidade dupla
A qualidade é inferida pelo algoritmo de qualidade do documento quando ativado. Varia de 1,0 a 5,0.
| Sim, quando você não conseguir verificar a qualidade. | |int lensFacing
Define o lado da câmera que foi usado. Use DocumentDetectorResult.LENS\_FACING\_FRONT ou DocumentDetectorResult.LENS\_FACING\_FRONT para validar.