Disponível somente em ambiente de produção.

Este endpoint permite consultar o status de processamento de um documento enviado via /v1/ocr/upload para o fluxo de OCR (Reconhecimento Óptico de Caracteres).

Os possíveis valores do campo status_code são:

• processing: o documento está em processamento.
• success: o documento foi processado com sucesso.
• error: ocorreu uma falha durante o processamento.

Quando status_code for error, o campo error_code poderá indicar o tipo de erro ocorrido. Atualmente, os valores possíveis são:

• DOCUMENT_RESTRICTED: município bloqueado para processamento via OCR. Para mais informações, entre em contato com o time de atendimento.
• DOCUMENT_NOT_ENABLED: documento não habilitado para sua conta. Verifique a habilitação junto ao time de atendimento.
• INVALID_FILE: arquivo inválido. Certifique-se de que é um PDF válido e que não excede o limite de 10 páginas permitidas.
• INVALID_NFSE: documento não reconhecido como uma NFS-e válida. O documento enviado atende aos critérios de processamento, mas não foi identificado como uma NFS-e válida.
• MANUAL_REVIEW_REQUIRED: documento em análise manual. Aguarde o processamento por nossa equipe de operações.
• UNAUTHENTICATED_NFSE: nfse não autenticada na prefeitura. Não foi possível confirmar a validade do documento. Tente validá-lo diretamente na prefeitura ou entre em contato com o time de atendimento.
• INTERNAL_ERROR: erro genérico interno. Recomendamos tentar novamente ou entrar em contato com o time de atendimento.

Novos códigos poderão ser adicionados futuramente para representar erros mais específicos.

Para documentos do tipo NFS-e, a resposta de sucesso também incluí os campos adicionais document_id e role, que indicam, respectivamente, o identificador interno do documento e o papel do cliente (emitente ou destinatário). Com base no valor de role, é possível utilizar os endpoints /v1/nfse/received ou /v1/nfse/emitted para obter o XML ABRASF.

{
  "data": {
    "document_type": "\"NFSE\""
  }
}