Mensagens

Aqui está uma lista de todos os parâmetros aceitos no mensagens objeto presente nas opções do Document Detector.

Aprimorado na v6.8.3: A configuração de mensagens agora usa um formato de objeto aninhado para melhor organização e legibilidade.

O mensagens o objeto é opcional. Se você não o passar, o SDK usará as mensagens padrão com base no language parâmetro (os valores padrão listados abaixo são para o idioma inglês).

Parâmetro	Tipo
geral Personalização das mensagens gerais exibidas.	Geral
captura Personalização das mensagens exibidas (modos de captura "manual" e "automático").	Captura
envio Personalização das mensagens exibidas (modo de captura "upload").	Envio

Formato de configuração

As opções de mensagens usam um formato de objeto aninhado para melhor organização:

messages: {
  general: {
    wait: "Por favor, aguarde...",
    errors: {
      poorQuality: "A qualidade da imagem está muito baixa. Tente novamente.",
      documentNotFound: "Documento não encontrado. Tente novamente.",
      invalidDocument: "Este documento não é válido.",
      generic: "Algo deu errado. Tente novamente."
    }
  },
  capture: {
    title: "Capture seu documento",
    errors: {
      captureFailed: "Captura falhou. Tente novamente."
    }
  },
  upload: {
    title: "Envie seu documento", // Observação: Para os lados frente/verso, isso se torna "Envie seu documento - Frente" ou "Envie seu documento - Verso"
    details: "Selecione um documento para enviar",
    button: "Enviar",
    success: "Documento enviado com sucesso!",
    errors: {
      generic: {
        title: "Falha no upload",
        details: "Tente novamente.",
        button: "Tentar novamente"
      },
      invalidFileFormat: {
        title: "Formato inválido",
        details: "Use os formatos JPG, PNG ou PDF."
      },
      invalidDocument: {
        title: "Documento inválido",
        details: "Este documento não é válido."
      }
    }
  }
}

Se você estiver atualizando de uma versão anterior, suas configurações existentes com notação pontuada (por exemplo, "general.wait": "Por favor, aguarde...") continuarão funcionando, mas recomendamos migrar para o formato de objeto aninhado mostrado acima.

Geral

Parâmetro	Tipo	Valor Padrão
aguarde Mensagem de carregamento. Exemplo: general: { wait: "Por favor, aguarde..." }	string	"Aguarde..."
errors.poorQuality Mensagem exibida quando a imagem capturada tem baixa qualidade. Exemplo: general: { errors: { poorQuality: "Qualidade muito baixa..." } }	string	"A qualidade da captura não foi boa. Certifique-se de estar em um ambiente bem iluminado e tente novamente."
errors.documentNotFound Mensagem exibida quando o documento não é encontrado. Exemplo: general: { errors: { documentNotFound: "Documento não encontrado..." } }	string	"Ops, parece que este documento não é compatível."
errors.invalidDocument Mensagem exibida quando o documento não é compatível. Exemplo: "Ops, este documento não é "Frente do RG"" Exemplo: general: { errors: { invalidDocument: "Documento inválido..." } }	string	"Ops, este documento não é "${expectedDocumentLabel}""
errors.generic Mensagem de erro genérica. Exemplo: general: { errors: { generic: "Algo deu errado..." } }	string	"Ops, algo deu errado, tente novamente"

Captura

Parâmetro	Tipo	Valor Padrão
título Título da captura. Exemplo: capture: { title: "Capture seu documento" }	string	O rótulo do documento esperado (por exemplo, "Frente do RG")
errors.captureFailed Mensagem exibida quando a captura falha. Exemplo: capture: { errors: { captureFailed: "Captura falhou..." } }	string	"Ops! Tivemos um problema ao processar sua imagem."

Envio

Comportamento importante para títulos de upload: Quando o SDK é configurado para capturar lados específicos do documento (frente ou verso), ele adiciona automaticamente um sufixo de lado ao título do upload. Por exemplo, se você definir upload.title como "Envie seu documento", os títulos exibidos de fato serão:

• Lado da frente: "Envie seu documento - Frente"
• Lado de trás: "Envie seu documento - Verso"
• Ambos os lados: Usa seu título personalizado como está

Isso garante que os usuários sempre saibam qual lado do documento precisam enviar, mesmo com títulos personalizados.

Parâmetro	Tipo	Valor Padrão
título Personalização do título da tela de upload. Importante: Ao capturar lados específicos do documento (frente/verso), o SDK adiciona automaticamente o sufixo do lado ao seu título personalizado (por exemplo, "Seu título personalizado - Frente" ou "Seu título personalizado - Verso"). Exemplo: upload: { title: "Enviar documento" }	string	"Anexar documento" (ou com sufixo de lado: "Anexar documento - Frente", "Anexar documento - Verso")
detalhes Personalização da mensagem abaixo do título da tela de upload. Exemplo: upload: { details: "Selecione um documento..." }	string	"Permita o acesso às suas fotos e anexe seu documento"
botão Personalização do texto do botão de upload. Exemplo: upload: { button: "Enviar" }	string	"Selecionar arquivo"
sucesso Personalização do título exibido na tela quando o arquivo foi enviado com sucesso. Exemplo: upload: { success: "Sucesso!" }	string	"Foto enviada com sucesso!"
errors.generic.title Personalização do título exibido na tela quando ocorreu um erro genérico no processo de upload. Exemplo: upload: { errors: { generic: { title: "Erro" } } }	string	"Erro ao enviar o arquivo"
errors.generic.details Personalização da mensagem abaixo do título exibido na tela quando ocorreu um erro genérico no processo de upload. Exemplo: upload: { errors: { generic: { details: "Tente novamente..." } } }	string	"Ops, algo deu errado ao enviar seu arquivo. Tente novamente."
errors.generic.button Personalização do texto do botão para fazer o upload novamente. Exemplo: upload: { errors: { generic: { button: "Tentar novamente" } } }	string	"Tente novamente"
errors.invalidFileFormat.title Personalização do título exibido na tela quando ocorreu um erro no formato do arquivo enviado. Exemplo: upload: { errors: { invalidFileFormat: { title: "Formato inválido" } } }	string	"Formato inválido"
errors.invalidFileFormat.details Personalização da mensagem abaixo do título exibido na tela quando ocorreu um erro no formato do arquivo enviado. Exemplo: upload: { errors: { invalidFileFormat: { details: "Use JPG, PNG ou PDF" } } }	string	"Parece que o formato da sua foto não é compatível. Tente enviar novamente nos formatos JPG, PNG ou PDF."
errors.invalidDocument.title Personalização do título exibido na tela quando um documento inválido é enviado. Exemplo: upload: { errors: { invalidDocument: { title: "Documento inválido" } } }	string	"Documento inválido"
errors.invalidDocument.details Personalização da mensagem abaixo do título exibido na tela quando um documento inválido é enviado. Exemplo: upload: { errors: { invalidDocument: { details: "Documento não válido..." } } }	string	"Ops, este documento não é ..."