Skip to main content
POST
Enviar Documentos para OCR
Diferente da análise de documentos, o OCR aceita documentos não identificados: você não precisa informar qual é a frente, o verso ou o tipo de cada arquivo. Quando souber o tipo, você pode informá-lo por documento em typeAlias.

Request Body

string
CPF do titular dos documentos. Opcional. Quando informado, aceita 11 dígitos, com ou sem máscara, e os dígitos verificadores precisam ser válidos.Quando omitido, o documento é registrado sem CPF e o campo cpf retorna null nas consultas e no webhook.Exemplo: 12345678909
array
required
Lista de documentos. Envie de 1 a 20 documentos por requisição.Cada item pode ser a string em data URI base64 ou um objeto com o arquivo e o tipo do documento. Os dois formatos podem ser combinados na mesma lista.Limite de 10 MB por arquivo. Formatos: JPG, JPEG, PNG e PDF.Exemplo: ["data:image/jpeg;base64,/9j/4AAQSkZJRgABAQAAAQ...", { "file": "data:image/jpeg;base64,/9j/4AAQSkZJRgABAQAAAQ...", "typeAlias": "cnh" }]
string
Alias do preset de workflow de OCR. Quando omitido, o preset configurado no projeto é aplicado.Consulte os valores disponíveis em Listar Presets de Workflow, filtrando por process=ocr.Exemplo: ocr_auto_2min
O tamanho máximo do corpo da requisição não deve ultrapassar 50 MB.

Response

string
Identificador da requisição.Exemplo: 7d7a6f2b-8d9f-4f55-9a2d-ec8e7b4f1d0c
string
Identificador do documento criado. Use-o para consultar status e dados extraídos.Exemplo: 123e4567-e89b-12d3-a456-426614174000
string
Identificador externo do lote enviado para extração.Exemplo: 7d7a6f2b-8d9f-4f55-9a2d-ec8e7b4f1d0c
string
Identificador do lote gerado no processamento.Exemplo: 229462
object
Retorno do serviço de processamento no envio do lote.

Erros

Respostas de erro possíveis neste endpoint: Veja o envelope de cada resposta e o significado dos códigos em Erros e Autenticação.