OCR (Reconhecimento Ótico de Caracteres)
A API de OCR Assíncrono permite o reconhecimento e extração assíncrona de dados de documentos.
Veja também: Autenticação
Requisição HTTP (Assíncrona)
POST https://api.santoid.com.br/api/v1/ocr-async/ocr
Requisição HTTP (Síncrona) 🆕
Este recurso é desabilitado por padrão. Para utilizá-lo, entre em contato com o suporte para solicitar a ativação.
Se você deseja receber o resultado imediatamente na mesma conexão, utilize o endpoint síncrono.
POST https://api.santoid.com.br/api/v1/ocr-sync/ocr
O modo síncrono elimina a necessidade de configurar um Webhook para receber os resultados, sendo ideal para fluxos onde o usuário aguarda a extração em tempo real. A estrutura da resposta é idêntica à detalhada em Estruturas de Resposta.
Corpo da Requisição
{
"imageFile": "<multipart/image>",
"track": "<string>",
"template": "<string>",
"customerRequestId": "<string>"
}
Estrutura de Dados
| Campo | Descrição |
|---|---|
| imageFile | multipart/image Arquivo no formato multipart/form-data. Formatos aceitos: PDF, JPG, PNG, TIFF, TIF, JPEG. Tamanho máximo: 15MB. |
| 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). |
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
Página com exemplos de requisições clique aqui.
Melhores Práticas
- Template Adequado: Selecione o template que melhor corresponde ao tipo de documento
- Monitoramento: Acompanhe os resultados através do customerRequestId ou requestiD
- 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)