Coletando os Retornos

A Web OCR SDK devolve uma Promise que, em caso de sucesso, retorna um array de objetos, onde cada objeto representa um lado do documento capturado (frente e/ou verso). Em caso de erro, a Promise é rejeitada com uma string descrevendo o problema.

Abaixo está um exemplo de como mapear cada caso e coletar seus resultados:

<script>
    webOCR.initialize(allowed_templates)
    .then((ocr_results) => {
        console.log(ocr_results)
        // Exemplo de retorno:
        // [
        //   { template: "rg_front", ocr_key: "abc123...", document_capture_session_key: "uuid..." },
        //   { template: "rg_back",  ocr_key: "def456...", document_capture_session_key: "uuid..." }
        // ]
    })
    .catch((error) => {
        console.log(error)
    })
</script>

Descrição do retorno da Web OCR

Sucesso

O retorno de sucesso é um array de objetos, um por lado do documento capturado:

Atributo	Tipo	Descrição
ocr_results	Array	Lista de objetos com as informações de cada captura realizada.

Atributos de cada objeto no array

Atributo	Tipo	Descrição
ocr_key	String	Chave de identificação da imagem capturada. Pode ser utilizada em qualquer outro serviço do sistema QI Tech.
template	String	Tipo e lado do documento capturado (ex: rg_front, rg_back, cnh_front, cnh_back, cin_digital).
document_capture_session_key	String	Chave que identifica a sessão de captura do documento.

Tipos de Erro

Erro	Descrição
Invalid Web Token! Please verify your Web Token.	Web Token utilizado é inválido. Caso tenha certeza que esteja utilizando corretamente o Web Token provido pela QI Tech, entre em contato com nosso suporte (suporte.caas@qitech.com.br).
Invalid Document Type! Please provide a valid document type.	Tipo de documento passado para WebOCR.initialize() não é válido. Verifique os tipos permitidos na página da função initialize.
User left Web OCR.	O usuário saiu da Web OCR SDK antes de concluir o envio do documento.