Skip to main content
POST
Extração síncrona
Envia um documento e recebe o resultado completo na própria resposta, sem callback. Ideal para fluxos interativos. Use timeout para limitar a espera (10s–300s).

Exemplos

Authorizations

Authorization
string
header
required

Chave de API enviada no cabeçalho Authorization no formato: Authorization: Bearer <API_KEY>.

Body

file
object
required

Origem do arquivo. Forneça fileUrl OU fileBase64 (com filename obrigatório), nunca ambos.

documentType
enum<string>

Tipo de documento. Quando omitido na extração, o tipo é detectado automaticamente.

Available options:
NFE,
BOLETO,
CONTRATO,
RECIBO,
CNH,
RG,
COMPROVANTE_RESIDENCIA,
CONTRATO_SOCIAL,
IRPF,
CERTIDAO_NASCIMENTO,
CERTIDAO_CASAMENTO,
LAUDO_MEDICO,
CERTIDAO_OBITO,
PROCURACAO,
HOLERITE,
DOCUMENTO_VEICULAR,
DOCUMENTO_JURIDICO,
EXTRATO_BANCARIO,
INFORME_RENDIMENTOS_EMPREGADOR_INSS,
INFORME_RENDIMENTOS_BANCOS,
INFORME_RENDIMENTOS_CORRETORAS,
INFORME_PLANO_SAUDE,
DESPESA_MEDICA,
COMPROVANTE_EDUCACAO,
DECLARACAO_IR_ANTERIOR
referenceId
string

Identificador externo para rastreamento.

metadata
object

Metadados arbitrários associados à requisição.

includeMarkdown
boolean
default:false

Inclui o markdown do documento no resultado.

timeout
integer
default:60000

Tempo máximo de espera em milissegundos.

Required range: 10000 <= x <= 300000

Response

Extração concluída.

Resultado completo de uma extração síncrona.

request_id
string
document_type
enum<string>

Tipo de documento. Quando omitido na extração, o tipo é detectado automaticamente.

Available options:
NFE,
BOLETO,
CONTRATO,
RECIBO,
CNH,
RG,
COMPROVANTE_RESIDENCIA,
CONTRATO_SOCIAL,
IRPF,
CERTIDAO_NASCIMENTO,
CERTIDAO_CASAMENTO,
LAUDO_MEDICO,
CERTIDAO_OBITO,
PROCURACAO,
HOLERITE,
DOCUMENTO_VEICULAR,
DOCUMENTO_JURIDICO,
EXTRATO_BANCARIO,
INFORME_RENDIMENTOS_EMPREGADOR_INSS,
INFORME_RENDIMENTOS_BANCOS,
INFORME_RENDIMENTOS_CORRETORAS,
INFORME_PLANO_SAUDE,
DESPESA_MEDICA,
COMPROVANTE_EDUCACAO,
DECLARACAO_IR_ANTERIOR
status
enum<string>
Available options:
success,
partial_success,
failed
fields
object

Mapa de nome do campo para o valor extraído.

processed_at
string<date-time>
scanify
object

Metadados de qualidade da extração.

markdown
string

Markdown do documento, presente quando includeMarkdown=true.