MOST Docs
mostValid
Authenticate (Get JWT)
Método para obter um token de autenticação a partir da client key.
:::warning
Para elevar a segurança, utilizamos o padrão JWT, com a implementação de tokens únicas e temporárias. Desta forma será necessário obter um novo token de autenticação para cada requisição.
Ele só poderá ser utilizado uma única vez e seu tempo de expiração é de 10 minutos.
:::
sequenceDiagram
client backend->> authenticate: POST (clientkey)
authenticate--)client backend: Return 200 (bearer token)
client backend->> service route: POST (bearer token, parameters)
service route--)client backend: Return 200 (result content)
box mostValid
participant authenticate
participant service route
end
Content Extraction
Rota assíncrona que permite a extração e complementação do conteúdo textual de arquivos.
Diferente da requisição de Extração de Documentos Síncrona, o serviço de Extração de Documentos Assíncrona do mostValid permite que o cliente receba os dados extraídos de sua imagem de maneira assíncrona em um servidor de sua escolha (servidor de callback).
No término do processo de extração e complementação, é enviada uma requisição com todos os dados extraídos para o servidor do cliente, sinalizando o término do processo assíncrono.
Serão enviadas ao servidor de callback do cliente requisições de dois tipos:
:::highlight blue
- Extração: Mensagem que indica o término do processo e apresenta todos os dados extraídos do arquivo/imagem enviado pelo cliente.
- Alerta: Mensagem que indica o término do processo e que houve alguma falha durante a execução do mesmo.
:::
Esta rota permite dois tipos de fluxo de extração:
1 - Fluxo de única requisição
O fluxo de única requisição permite o envio de arquivo, em uma única requisição, ao qual será executada a extração dos dados do(s) documento(s) presente(s) no arquivo e abertura da tarefa de análise humana, caso o melhor documento se enquadre em alguma regra de validação do cliente.
2 - Fluxo de múltiplas requisições
O fluxo de múltiplas requisições foi projetado para auxiliar nos processos de integração (onboarding), nos quais o responsável pela captura das imagens dos documentos precisa ter a flexibilidade de fazer várias tentativas. Cada tentativa será tratada como um processo (identificado pelo processId) em uma mesma operação (atributo operation), antes de abrir uma tarefa de análise humana no mostValid.
Finalizada as tentativas de captura da operation, o processo, com a extração do documento da melhor captura (score mais alto), segue abrindo normalmente a tarefa de análise humana, caso o melhor documento se enquadre em alguma regra de validação do cliente.
O produto da rota é um código de processo, processId, único por requisição enviada, e um código operationId, no caso do uso do fluxo de múltiplas requisições.
Process Status
Rota para consultar o status do processamento do arquivo enviado na rota de extração do mostValid.
O cliente poderá realizar consultas manuais periodicamente nesta rota até obter o resultado da extração.
:::note
O resultado do processo estará disponível para consulta por um tempo máximo de uma hora após a sua conclusão. Esse período é contado a partir do momento em que a situação do processo é definida como um dos estados finais: FINISHED, CANCELED ou ERROR.
:::
Uma tarefa de validação permanecerá na fila do mostValid pelo período máximo de 30 dias corridos, a contar da data de sua abertura. Caso não seja realizada dentro deste prazo, o status da tarefa e o processStatus serão atualizados automaticamente para CANCELED.
Caso o processStatus apresentado seja ERROR, o cliente poderá entrar em contato com o suporte informando o processId da requisição através do e-mail suporte@most.com.br.
Status do processo
Abaixo tabela com os possíveis status do processo retornado no campo processStatus.
| Nome | Descrição |
|---|---|
| IN_PROCESS | O arquivo enviado está sendo tipificado e processado para verificar se necessita de complementação. |
| WAITING_OPERATION_FINISH | Representa que há uma operação (operation) em andamento e é necessário o envio de outro arquivo para que o processo continue ou seja finalizado. |
| CANCELED | Representa que o processo foi cancelado, em um fluxo de múltiplas requisições (operation), devido o processamento de algum outro arquivo em que não foi necessário gerar tarefa OU que houve a abertura de tarefa para outro processo da mesma operation. |
| ERROR | Indica que ocorreu um erro durante uma ou mais etapas do processo. |
| TO_ANALYSIS | O arquivo necessita de complementação e está aguardando para ser analisado. |
| IN_ANALYSIS | O arquivo necessita de complementação e está sendo analisado por um complementador. |
| FINISHED | O arquivo foi analisado com sucesso e retornou o resultado, com complementação ou não. |
Status dos atributos
Lista de status retornados pelo campo status dos atributos e seus significados, onde contexto pode se referir ao campo, célula da tabela, cabeçalho da tabela ou o documento.
| Status | Descrição |
|---|---|
| MOSTQIIOCR | O item não foi enviado para validação pelo revisor, pois conforme as regras do cliente, a extração feita já é considerada válida. |
| MODIFIED | O item foi enviado para validação, pois foi verificado que ele necessitava de revisão, conforme as regras definidas pelo cliente, e o seu conteúdo original foi modificado pelo revisor. |
| UNREADABLE | O item foi enviado para validação, pois foi verificado que ele necessitava de revisão, conforme as regras definidas pelo cliente; sendo marcado como ilegível pelo revisor. |
| REVIEWED | O item foi enviado para validação, pois foi verificado que ele necessitava de revisão, conforme as regras definidas pelo cliente, e o seu conteúdo original não foi modificado pelo revisor. |
| DEPRECATED | Trata-se de um item com nome do campo depreciado e que não será exibido no Portal mostValid para análise durante a tarefa de revisão. Recomenda-se considerar os nomes de campos correspondentes atualizados. Confira a listagem atualizada de documentos e respectivos campos aqui. |