Pular para o conteúdo principal

Status de Processamento

Ao ser enviado o documento e retornado o protocolo do mesmo, o documento segue para uma fila de melhoria de imagem e em seguida para as próximas etapas de processamento. Assim, é possível utilizar o endpoint de status junto ao protocolo recebido para verificar o status de andamento do documento em questão.

Alguns processamentos podem ser mais demorados que outros devido a tamanho do arquivo ou estruturação e pesquisa textual por Deep Learning desenvolvidos pela empresa.

→ [POST] Status​

Esse endpoint retorna o status do processamento com base no protocolo enviado.

  • path: /api/v1/process

Request Body:

{
  "protocol_num": "string"
}

É possível receber os status indicados abaixo:

Status
  • VALIDATION: All stages completed;
  • False: Protocol not found;

Response Body:

200 Success
{
  "status": boolean,
  "stage": "string",
  "msg": "string"
}
400 Bad Request
"Bad request, when the required fields are not provided or invalid."