> ## 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.
# Extração síncrona
> Extrai os campos de um documento de forma síncrona, aguardando o processamento concluir e retornando o resultado completo na mesma requisição. Use o parâmetro timeout para controlar o tempo máximo de espera.
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
```bash cURL theme={"dark"}
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
}'
```
```javascript Node.js (axios) theme={"dark"}
import axios from 'axios';
const { data } = await axios.post(
'https://api.scanify.com.br/extract/sync',
{
file: {
fileUrl: 'https://exemplo.com/documento.pdf',
},
documentType: 'NFE',
includeMarkdown: false,
timeout: 60000,
},
{
headers: {
Authorization: 'Bearer SUA_CHAVE_DE_API',
},
},
);
console.log(data.fields);
```
```python Python (requests) theme={"dark"}
import requests
response = requests.post(
"https://api.scanify.com.br/extract/sync",
headers={"Authorization": "Bearer SUA_CHAVE_DE_API"},
json={
"file": {
"fileUrl": "https://exemplo.com/documento.pdf",
},
"documentType": "NFE",
"includeMarkdown": False,
"timeout": 60000,
},
timeout=70,
)
response.raise_for_status()
print(response.json()["fields"])
```
## OpenAPI
````yaml POST /extract/sync
openapi: 3.0.0
info:
title: API Scanify
version: 1.0.0
description: >-
API do Scanify para extração e classificação de dados de documentos. Esta
API permite enviar arquivos (via URL, base64 ou upload multipart) para
extração estruturada de campos.
contact:
name: Suporte Scanify
url: https://scanify.com.br/support
email: suporte@scanify.com.br
license:
name: Proprietary
url: https://scanify.com.br/terms
servers:
- url: https://api.scanify.com.br
security:
- apiKeyAuth: []
paths:
/extract/sync:
post:
summary: Extração síncrona
description: >-
Extrai os campos de um documento de forma síncrona, aguardando o
processamento concluir e retornando o resultado completo na mesma
requisição. Use o parâmetro timeout para controlar o tempo máximo de
espera.
operationId: extractSync
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/SyncExtractRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/SyncExtractMultipartRequest'
responses:
'200':
description: Extração concluída.
content:
application/json:
schema:
$ref: '#/components/schemas/ExtractionResult'
'400':
$ref: '#/components/responses/ValidationError'
'401':
$ref: '#/components/responses/Unauthorized'
'408':
description: O processamento excedeu o timeout informado.
content:
application/json:
schema:
$ref: '#/components/schemas/SyncTimeoutError'
security:
- apiKeyAuth: []
components:
schemas:
SyncExtractRequest:
type: object
required:
- file
properties:
file:
$ref: '#/components/schemas/FileInput'
documentType:
$ref: '#/components/schemas/DocumentType'
referenceId:
type: string
description: Identificador externo para rastreamento.
metadata:
type: object
additionalProperties: true
description: Metadados arbitrários associados à requisição.
includeMarkdown:
type: boolean
default: false
description: Inclui o markdown do documento no resultado.
timeout:
type: integer
minimum: 10000
maximum: 300000
default: 60000
description: Tempo máximo de espera em milissegundos.
SyncExtractMultipartRequest:
type: object
required:
- file
properties:
file:
type: string
format: binary
description: Arquivo do documento. Alternativamente, informe o campo fileUrl.
fileUrl:
type: string
format: uri
documentType:
$ref: '#/components/schemas/DocumentType'
referenceId:
type: string
metadata:
type: string
description: Metadados como string JSON.
includeMarkdown:
type: boolean
default: false
timeout:
type: integer
minimum: 10000
maximum: 300000
default: 60000
ExtractionResult:
type: object
description: Resultado completo de uma extração síncrona.
properties:
request_id:
type: string
document_type:
$ref: '#/components/schemas/DocumentType'
status:
type: string
enum:
- success
- partial_success
- failed
fields:
type: object
additionalProperties:
$ref: '#/components/schemas/Field'
description: Mapa de nome do campo para o valor extraído.
processed_at:
type: string
format: date-time
scanify:
type: object
description: Metadados de qualidade da extração.
properties:
reliability_score:
type: number
reliability_level:
type: string
enum:
- high
- medium
- low
missing_fields:
type: array
items:
type: string
inconsistencies:
type: array
items:
type: string
description: >-
Avisos curtos em português descrevendo inconsistências
detectadas nos campos.
summary:
type: string
description: Resumo textual do documento em português.
schema_version:
type: string
confidence_heatmap:
type: object
additionalProperties:
type: number
minimum: 0
maximum: 100
description: Confiança por campo (0–100), com chave igual ao nome do campo.
document_type_detection:
$ref: '#/components/schemas/DocumentTypeDetection'
markdown:
type: string
description: Markdown do documento, presente quando includeMarkdown=true.
SyncTimeoutError:
type: object
properties:
success:
type: boolean
enum:
- false
status:
type: string
enum:
- failed
code:
type: string
enum:
- SYNC_TIMEOUT
message:
type: string
request_id:
type: string
FileInput:
type: object
description: >-
Origem do arquivo. Forneça fileUrl OU fileBase64 (com filename
obrigatório), nunca ambos.
properties:
fileUrl:
type: string
format: uri
description: URL pública do arquivo a ser baixado.
fileBase64:
type: string
description: Conteúdo do arquivo codificado em base64. Requer filename.
filename:
type: string
description: Nome do arquivo. Obrigatório quando usar fileBase64.
DocumentType:
type: string
description: >-
Tipo de documento. Quando omitido na extração, o tipo é detectado
automaticamente.
enum:
- 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
Field:
type: object
description: Valor extraído de um campo do documento.
properties:
value:
description: Valor do campo (tipo varia conforme o campo).
confidence_score:
type: number
description: Confiança da extração do campo, quando disponível.
error:
type: string
description: Mensagem de erro de validação do campo, quando houver.
DocumentTypeDetection:
type: object
properties:
source:
type: string
enum:
- provided
- detected
provided_document_type:
type: string
nullable: true
detected_document_type:
type: string
nullable: true
confidence:
type: number
nullable: true
threshold:
type: number
accepted:
type: boolean
reason:
type: string
nullable: true
Error:
type: object
properties:
message:
type: string
request_id:
type: string
description: Presente em alguns erros de processamento.
required:
- message
UnauthorizedError:
type: object
properties:
error:
type: string
example: Unauthorized
responses:
ValidationError:
description: Requisição inválida (dados ou arquivo inválidos).
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
Unauthorized:
description: Chave de API ausente ou inválida.
content:
application/json:
schema:
$ref: '#/components/schemas/UnauthorizedError'
securitySchemes:
apiKeyAuth:
type: http
scheme: bearer
description: >-
Chave de API enviada no cabeçalho Authorization no formato:
Authorization: Bearer .
````