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

Video ID Resultado

Lista de parâmetros de saída do componente

finishStatus

Retorna um número do resultado da operação. Valores possíveis:

  • 1: A operação foi bem-sucedida.

  • 2: Ocorreu um erro, o qual será indicado no string errorType e, opcionalmente, será exibida uma mensagem de informação extra na propriedade errorMessage.

finishStatusDescription

Retorna uma descrição do resultado da operação. Valores possíveis:

  • STATUS_OK: A operação foi bem-sucedida.

  • STATUS_ERROR: Ocorreu um erro, o qual será indicado no string errorType(errorDiagnostic para Flutter) e, opcionalmente, será exibida uma mensagem de informação extra na propriedade errorMessage.

errorType ou errorDiagnostic(apenas para Flutter)

Indica por que o componente falhou.

errorMessage

Indica uma mensagem de erro adicional. É um valor opcional.

frontDocumentData

Dados da frente do documento. Inclui:

  • documentImage: Imagem do documento

  • documentFullImage: Imagem completa capturada

  • documentFaceImage: Se uma face for encontrada no documento, a imagem dela é retornada.

  • iqaOverExposure: Valor numérico entre 0 e 1 que indica o nível de superexposição da imagem; um valor alto sugere que a imagem está iluminada demais, o que pode dificultar a leitura do documento.

  • iqaReadable: Valor numérico entre 0 e 1 que indica a legibilidade do texto do documento; valores mais altos implicam que o texto está mais claro e fácil de reconhecer.

  • iqaSharpness: Valor numérico entre 0 e 1 que indica a nitidez da imagem do documento; valores altos refletem uma imagem mais focada, o que melhora a capacidade de extração de dados.

  • documentFaceImageTokenized: Se uma face for encontrada no documento, a imagem criptografada dela é retornada.

backDocumentData

Dados do verso do documento. Inclui:

  • documentImage: Imagem do documento

  • documentFullImage: Imagem completa capturada

  • documentFaceImage: Se uma face for encontrada no documento, a imagem dela é retornada.

  • iqaOverExposure: Valor numérico entre 0 e 1 que indica o nível de superexposição da imagem; um valor alto sugere que a imagem está iluminada demais, o que pode dificultar a leitura do documento.

  • iqaReadable: Valor numérico entre 0 e 1 que indica a legibilidade do texto do documento; valores mais altos implicam que o texto está mais claro e fácil de reconhecer.

  • iqaSharpness: Valor numérico entre 0 e 1 que indica a nitidez da imagem do documento; valores altos refletem uma imagem mais focada, o que melhora a capacidade de extração de dados.

  • documentFaceImageTokenized: Se uma face for encontrada no documento, a imagem criptografada dela é retornada.

faceImage

Imagem do usuário capturada na primeira seção do processo.

ocrMap

Mapa do OCR extraído do documento.

ocrDiagnostic

Dicionário com o diagnóstico OCR do documento. As chaves são os campos a validar e os valores são instâncias de OcrDiagnostic.

Diagnóstico OCR extraído do documento.

  • OK: O OCR está correto.

  • NOT_FOUND: A chave OCR não foi encontrada.

  • TOLERANCE_ERROR: O OCR não está correto.

  • WARNING: O OCR não está correto, mas é apenas um aviso porque é um campo opcional.

matchingSidesScore

Valor numérico entre 0 e 1 que estima o nível de correspondência entre as faces do documento (frente e verso).

documentType

Tipo de documento obtido.

personalData

Conjunto reduzido de dados obtidos do usuário:

  • issuer

  • documentNumber

  • issueDate

  • expiryDate

  • name

  • surname

  • fullName

  • gender

  • birthDate

  • birthPlace

  • nationality

  • address

  • nfcKey

  • numSupport

  • mrz

speechText

Texto que o usuário deverá pronunciar durante a gravação do vídeo.

faceImageTokenized

Imagem criptografada do usuário capturada na primeira seção do processo.

Atualizado