Skip to main content
GET
/
extract
/
{requestId}
Status e resultado de uma requisição
curl --request GET \
  --url https://api.scanify.com.br/extract/{requestId} \
  --header 'Authorization: Bearer <token>'
{
  "request_id": "<string>",
  "document_type": "<string>",
  "status": "<string>",
  "current_step": "<string>",
  "callback_url": "<string>",
  "reference_id": "<string>",
  "validation_errors": [
    {}
  ],
  "payload": {
    "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>"
  },
  "metadata": {},
  "created_at": "2023-11-07T05:31:56Z",
  "completed_at": "2023-11-07T05:31:56Z",
  "processed_at": "2023-11-07T05:31:56Z",
  "markdown_generated_at": "2023-11-07T05:31:56Z"
}

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.

Consulta o status e o resultado de uma extração. Veja também GET /extract/{requestId}/markdown (texto em markdown) e GET /extract/{requestId}/bounding-box (coordenadas dos campos).

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
requestId
string
required

Identificador da requisição.

Response

Estado da requisição.

​
request_id
string
​
document_type
string | null
​
status
string
​
current_step
string | null
​
callback_url
string | null
​
reference_id
string | null
​
validation_errors
object[] | null

Resultados de validação por campo (field, error, etc.). Para a visão consolidada, prefira fields e scanify.

​
payload
object

Quando status === 'completed' (ou 'success'/'partial_success'/'failed' no terminal), contém o ExtractionResult completo. Enquanto a requisição ainda está em processamento, é null.

​
metadata
object
​
created_at
string<date-time> | null
​
completed_at
string<date-time> | null
​
processed_at
string<date-time> | null
​
markdown_status
enum<string> | null
Available options:
pending,
success,
failed
​
markdown_generated_at
string<date-time> | null