Skip to main content
POST
/
extract
/
sync
Extração síncrona
curl --request POST \
  --url https://api.scanify.com.br/extract/sync \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "file": {
    "fileUrl": "<string>",
    "fileBase64": "<string>",
    "filename": "<string>"
  },
  "referenceId": "<string>",
  "metadata": {},
  "includeMarkdown": false,
  "timeout": 60000
}
'
{
  "request_id": "<string>",
  "fields": {},
  "processed_at": "2023-11-07T05:31:56Z",
  "scanify": {
    "reliability_score": 123,
    "missing_fields": [
      "<string>"
    ],
    "inconsistencies": [
      "<string>"
    ],
    "summary": "<string>",
    "schema_version": "<string>",
    "confidence_heatmap": {},
    "document_type_detection": {
      "provided_document_type": "<string>",
      "detected_document_type": "<string>",
      "confidence": 123,
      "threshold": 123,
      "accepted": true,
      "reason": "<string>"
    }
  },
  "markdown": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.scanify.com.br/llms.txt

Use this file to discover all available pages before exploring further.

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

curl -X POST https://api.scanify.com.br/extract/sync \
  -H "Authorization: Bearer SUA_CHAVE_DE_API" \
  -H "Content-Type: application/json" \
  -d '{
    "file": {
      "fileUrl": "https://exemplo.com/documento.pdf"
    },
    "documentType": "NFE",
    "includeMarkdown": false,
    "timeout": 60000
  }'

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.