OCR (Reconhecimento Ótico de Caracteres)

A API de OCR Assíncrono permite o reconhecimento e extração assíncrona de dados de documentos.

info

Veja também: Autenticação

Requisição HTTP

POST https://api.santoid.com.br/api/v1/ocr-async/ocr

Corpo da Requisição

{
    "imageFile": "<multipart/image>",
    "track": "<string>",
    "template": "<string>",
    "customerRequestId": "<string>"
}

Estrutura de Dados

Campo	Descrição
imageFile	multipart/image Imagem no formato multipart/form-data.
track	string ID da track (processo) que deseja solicitar.
template	string Nome do template base para processamento OCR.
customerRequestId	string Identificador externo definido pelo cliente (múltiplas requisições podem usar o mesmo customerRequestId).

atenção

Ao usar templates de "IA Generativa" para extrair documentos contendo listas, ative a opção "Resposta em lista" no frontend da aplicação (https://app.santoid.com.br).

Figura 1: Ativar resposta em lista.

Exemplos de Requisição

info

Página com exemplos de requisições clique aqui.

Resposta via Webhook

clique aqui.

Melhores Práticas

1. Template Adequado: Selecione o template que melhor corresponde ao tipo de documento
2. Monitoramento: Acompanhe os resultados através do customerRequestId ou requestiD
3. Tratamento de Erros: Implemente lógica para reprocessamento em caso de falhas

💡 Dica profissional: Para documentos complexos, considere processar em etapas (tipificação → OCR → validação)