Ctrlk
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Referências em TypeScript

Tipos

DocumentDetectorResponse

Campo
Tipo
Descrição

resultado

DocumentDetectorResult ou nulo

Mostra quando o detector de documentos retorna uma captura bem-sucedida.

error

DocumentDetectorError ou nulo

Mostra quando o detector de documentos retorna algum erro.

cancelado

booleano

Mostra quando o usuário cancela o detector de documentos.

DocumentDetectorResult

Campo
Tipo
Descrição

capturas

DocumentDetectorCapture[]

O array com as capturas correspondentes dos documentos parametrizados

trackingId

string

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

tipo

string

A classe do fluxo do documento lido. Este parâmetro é útil em uma integração com nossa rota de OCR. Os tipos existentes são: ["blank", "cnh", "cnh_new", "generic", "rg", "rg_new", "rne", "rnm", "ctps", "passport, crlv, crlv_new"]

DocumentDetectorError

Campo
Tipo
Descrição

statusCode

string

Código de status HTTPS.

message

string

Mensagem de erro detalhada.

error

Error

Enum que descreve o tipo de erro.

DocumentDetectorSettings

Campo
Tipo
Descrição
Android
iOS
Obrigatório

documentSteps

DocumentDetectorStep[]

Define o fluxo de captura do documento.

✅

✅

✅

captureStages

DocumentDetectorCaptureStage[]

Configura os requisitos de cada etapa de captura. Criado para tornar a captura mais flexível nos casos em que o usuário não consegue capturar com todas as verificações ativas, evitando que ele fique preso nesta etapa no fluxo de cadastro.

✅

❌

❌

cafStage

Etapa

Altera o ambiente de desenvolvimento.

✅

✅

❌

popupSettings

booleano

Ativa/desativa os pop-ups exibidos antes de cada captura de documento.

✅

✅

❌

networkSettings

número

Define o tempo limite das requisições do SDK.

✅

✅

❌

sensorSettings

DocumentDetectorSensorSettings

Objeto de configuração para definir os sensores do SDK.

✅

✅

❌

proxySettings

DocumentDetectorProxySettings

Define seu proxy para fazer requisições.

✅

✅

❌

previewSettings

DocumentDetectorPreviewSettings

Ativa/desativa e permite configurar a visualização da captura realizada, solicitando a confirmação do usuário para prosseguir.

✅

✅

❌

compressSettings

número

Permite configurar a qualidade no processo de compressão. Por padrão, todas as capturas passam por compressão. O método espera valores entre 80 e 100 como parâmetro, sendo 100 a melhor qualidade de compressão.

✅

✅

❌

manualCaptureSettings

número

Ativa/desativa a captura manual.

❌

✅

❌

imageUrlExpireTime

string

Define o tempo que a URL da imagem permanecerá no servidor até expirar. Espere receber um intervalo de tempo entre "30m" e "30d". Exemplos: "30m": Para definir apenas minutos "24h": Para definir apenas hora(s). "1h 10m": Para definir hora(s) e minuto(s). "10d": Para definir dia(s).

✅

✅

❌

currentStepDoneDelay

número

Adia a atividade após a conclusão de cada etapa.

✅

✅

❌

resolutionSettings

Resolução

Permite definir a resolução da captura.

✅

✅

❌

allowedPassportList

CountryCodes[]

Ativa a opção de permitir passaportes apenas de um determinado país emissor ou de uma lista de países.

✅

✅

❌

messageSettings

DocumentDetectorMessageSettings

Para mensagens personalizadas, use este objeto.

✅

✅

❌

as configurações de upload

DocumentDetectorUploadSettings

Para ativar a funcionalidade de envio de documentos, é necessário usar este objeto.

✅

✅

❌

style

DocumentDetectorStyle

Define a cor primária e as cores de feedback do SDK.

Veja o exemplo

✅

❌

securitySettings

DocumentDetectorSecuritySettings

O SDK possui alguns bloqueios que podem impedir sua execução em certos contextos. Para desativá-los, você pode usar os métodos conforme mostrado no exemplo abaixo.

✅

❌

❌

useManualCaptureAsFallback

booleano

Ativa/desativa a opção quando os dispositivos não conseguem instanciar a IA incorporada na memória

✅

❌

❌

DocumentDetectorStep

Campo
Tipo
Descrição
Android
iOS

document

Documento

Define o fluxo de captura do documento.

✅

✅

stepLabel

string

Define o texto a ser exibido na parte inferior do layout.

✅

✅

showStepLabel

booleano

Apresente o texto a ser exibido na parte superior do layout.

✅

✅

illustration

string

Define a ilustração a ser exibida no pop-up antes da captura.

✅

✅

DocumentDetectorCaptureStage

Campo
Tipo
Descrição
Android
iOS

captureMode

CaptureMode

Define o modo de captura.

✅

❌

durationMillis

número

Duração da etapa, em milissegundos.

✅

❌

wantSensorCheck

booleano

Ativa/desativa o uso de sensores para capturar a foto.

✅

❌

DocumentDetectorSensorSettings

Campo
Tipo
Descrição
Android
iOS

luminositySensor

número

Define o limite entre brilho ambiente aceitável/inaceitável.

✅

✅

orientationSensor

número

Define o limite entre a orientação correta/incorreta do dispositivo. Quanto maior o valor, mais flexível ele será.

✅

✅

stabilitySensor

DocumentDetectorSensorSettingsStabilitySensor

Altera as configurações padrão do sensor de estabilidade. O limite deste sensor está na faixa das duas últimas acelerações coletadas do dispositivo.

✅

✅

DocumentDetectorSensorSettingsStabilitySensor

Campo
Tipo
Descrição
Android
iOS

stabledMillis

número

Define as configurações do sensor de estabilidade.

✅

❌

limite

número

O limite deste sensor está na faixa das duas últimas acelerações coletadas do dispositivo.

✅

✅

DocumentDetectorProxySettings

Campo
Tipo
Descrição
Android
iOS

hostname

string

Define o domínio ou endereço IP do serviço de proxy.

✅

✅

port

número

Define a porta a ser usada.

✅

✅

authentication

DocumentDetectorProxySettingsAuthentication

Ativa/desativa o uso de sensores para capturar a foto.

✅

✅

DocumentDetectorProxySettingsAuthentication

Campo
Tipo
Descrição
Android
iOS

user

string

Nome de usuário a ser usado para autenticação.

✅

✅

password

número

Senha a ser usada para autenticação.

✅

✅

DocumentDetectorPreviewSettings

Campo
Tipo
Descrição
Android
iOS

mostrar

booleano

Ativa/desativa e permite configurar a visualização da captura realizada, solicitando a confirmação do usuário para prosseguir.

✅

✅

título

string

Define o título exibido na tela.

✅

✅

subtítulo

string

Define o subtítulo exibido na tela.

✅

✅

confirmLabel

string

Define a mensagem exibida no botão de confirmação.

✅

✅

retryLabel

string

Define a mensagem exibida no botão para realizar uma nova captura.

✅

✅

DocumentDetectorMessageSettings

Campo
Tipo
Descrição
Android
iOS

waitMessage

string

Mensagem exibida ao iniciar a câmera

✅

✅

fitTheDocumentMessage

string

Mensagem que orienta a ajustar o documento à máscara

✅

✅

holdItMessage

string

Mensagem exibida no momento em que a captura está sendo realizada

✅

✅

verifyingQualityMessage

string

Mensagem exibida quando o SDK faz uma requisição ao backend, verificando a qualidade

✅

✅

lowQualityDocumentMessage

string

Mensagem exibida quando a qualidade da captura falha

✅

✅

uploadingImageMessage

string

Mensagem exibida quando não há verificação de qualidade e a captura está sendo salva nos servidores

✅

✅

openDocumentWrongMessage

string

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.

✅

❌

popupDocumentSubtitleMessage

string

Mensagem exibida no subtítulo do pop-up que traz a ilustração do documento cuja captura está sendo solicitada.

✅

✅

wrongDocumentMessage

string

Mensagem exibida quando o documento é exibido em um fluxo diferente do esperado.

✅

✅

unsupportedDocumentMessage

string

Mensagem exibida quando um tipo inesperado de documento é apresentado para captura

✅

✅

documentNotFoundMessage

string

Mensagem exibida quando um documento é desconhecido

✅

❌

sensorLuminosityMessage

string

Mensagem exibida quando o limite de brilho está abaixo do esperado

✅

✅

sensorOrientationMessage

string

Mensagem exibida quando o limite de orientação está abaixo do esperado

✅

✅

sensorStabilityMessage

string

Mensagem exibida quando o limite de orientação está abaixo do esperado

✅

✅

positiveButtonMessage

string

Permite personalizar a mensagem do botão de confirmação

✅

❌

predictorScanDocumentMessage

string

Mensagem exibida para solicitar que um documento esteja visível na câmera.

✅

✅

predictorGetCloserMessage

string

Mensagem exibida para solicitar que se aproxime do documento.

✅

✅

predictorCentralizeMessage

string

Mensagem exibida para solicitar que o documento seja centralizado.

✅

✅

predictorMoveAwayMessage

string

Mensagem exibida para solicitar que se afaste do documento.

✅

✅

predictorAlignDocumentMessage

string

Mensagem exibida para solicitar que o documento seja alinhado.

✅

✅

predictorTurnDocumentMessage

string

Mensagem exibida para solicitar que o documento seja girado 90 graus.

✅

✅

predictorCapturedMessage

string

Mensagem exibida para alertar que o documento foi capturado.

✅

✅

DocumentDetectorUploadSettings

Campo
Tipo
Descrição
Android
iOS

ativar

booleano

Ativa/desativa este recurso.

✅

✅

comprimir

booleano

Ativa/desativa a compressão de arquivos antes do envio.

✅

✅

fileFormats

FileFormat[]

Define o(s) formato(s) de arquivo que serão aceitos para envio.

✅

✅

maxFileSize

número

Define o limite máximo em KB do arquivo a ser enviado.

✅

✅

DocumentDetectorStyle

Campo
Tipo
Descrição
Android
iOS

primaryColor

string

Define a cor principal do SDK.

Veja o exemplo

Use cores hexadecimais. Exemplo: #34d690.

feedbackColors

DocumentFeedbackColors

Cores da área de feedback.

Veja o exemplo

Use cores hexadecimais. Exemplo: #34d690.

uploadBackgroundColor

string

Cor de fundo do fluxo de envio.

Veja o exemplo

Use cores hexadecimais. Exemplo: #34d690.

previewBackgroundColor

string

Cor de fundo da tela de pré-visualização.

Veja o exemplo

Use cores hexadecimais. Exemplo: #ffffff.

DocumentFeedbackColors

Campo
Tipo
Descrição
Android
iOS

defaultColor

string

Define a cor padrão para o feedback padrão.

Veja o exemplo

✅

errorColor

string

define a cor de erro quando ocorre um erro ao capturar o documento.

Veja o exemplo

✅

successColor

string

Define a cor de sucesso quando o documento é capturado.

Veja o exemplo

✅

DocumentDetectorSecuritySettings

Campo
Tipo
Descrição
Android
iOS

useDevelopmentMode

booleano

Ativa o modo de desenvolvedor no dispositivo físico.

✅

❌

useAdb

booleano

Ativa o Android Debug Bridge (ADB).

✅

❌

useDebug

booleano

Ativa o modo de depuração para Android.

✅

❌

Enumerações

Documento

Campo
Descrição
Android
iOS

RG_FRONT

Frente do RG, parte onde fica a foto.

✅

✅

RG_BACK

Verso do RG, onde ficam os dados.

✅

✅

RG_FULL

RG aberto, mostrando frente e verso.

✅

✅

CNH_FRONT

Frente da CNH, parte onde fica a foto.

✅

✅

CNH_BACK

Verso da CNH, parte onde fica a assinatura.

✅

✅

CNH_FULL

CNH aberta, mostrando frente e verso.

✅

✅

CRLV

CRLV.

✅

✅

RNE_FRONT

Frente do RNE e do RNM, onde ficam os dados.

✅

✅

RNE_BACK

Verso do RNE e do RNM, onde fica a foto.

✅

✅

PASSPORT

Passaporte, apenas um lado, mostrando todos os dados.

✅

✅

CTPS_FRONT

Frente da CTPS, onde fica a foto.

✅

✅

CTPS_BACK

Verso da CTPS, onde ficam os dados.

✅

✅

OUTROS

Outros documentos de identificação em geral, como RNE, identidade militar, OAB e CRLV.

✅

✅

QUALQUER

Permite o envio de qualquer tipo de documento, incluindo todos os mencionados acima, bem como qualquer outro documento, já que não são feitas tipificações.

✅

✅

CaptureMode

Campo
Descrição
Android
iOS

AUTOMATIC

Digitaliza o documento automaticamente.

✅

❌

MANUAL

Digitalize o documento manualmente.

✅

❌

Etapa

Campo
Descrição
Android
iOS

BETA

Ambiente de beta.

✅

✅

PROD

Ambiente de produção.

✅

✅

Resolução

Campo
Descrição
Android
iOS

FULL_HD

1920 x 1080

✅

✅

QUAD_HD

2560 x 1440

✅

❌

ULTRA_HD

3840 x 2160

✅

✅

CountryCodes

Veja a lista completa em: ISO 3166-1 alpha-3. Exemplo: CountryCodes.BRA.

FileFormat

Campo
Descrição
Android
iOS

PNG

image/png

✅

✅

JPG

image/jpg

✅

❌

JPEG

image/jpeg

✅

✅

PDF

image/pdf

✅

✅

HEIF

image/heif

✅

❌

Error

Campo
Descrição
Android
iOS

PermissionReason

Está faltando alguma permissão obrigatória para executar o SDK.

✅

✅

NetworkReason

Indica que ocorreu uma exceção relacionada à rede durante a verificação.

✅

✅

ServerReason

Indica que ocorreu uma exceção no servidor durante a verificação.

✅

✅

InvalidTokenReason

Indica um problema com o token usado para verificação.

✅

✅

SecurityReason

Quando o SDK não pode ser iniciado por um motivo de segurança.

✅

✅

StorageReason

Quando uma biblioteca interna do SDK não pode ser iniciada.

✅

✅

LibraryReason

Não há espaço no armazenamento interno do dispositivo do usuário.

✅

✅

UnexpectedReason

Ocorreu um erro inesperado.

✅

✅

Atualizado