> ## 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.

# Consultar resultado

> Consulta o status atual e, quando concluído, o resultado de uma requisição de extração assíncrona.

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).


## OpenAPI

````yaml GET /extract/{requestId}
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/{requestId}:
    get:
      summary: Status e resultado de uma requisição
      description: >-
        Consulta o status atual e, quando concluído, o resultado de uma
        requisição de extração assíncrona.
      operationId: getRequest
      parameters:
        - $ref: '#/components/parameters/RequestIdPath'
      responses:
        '200':
          description: Estado da requisição.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RequestStatusResult'
        '400':
          $ref: '#/components/responses/ValidationError'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      security:
        - apiKeyAuth: []
components:
  parameters:
    RequestIdPath:
      name: requestId
      in: path
      required: true
      description: Identificador da requisição.
      schema:
        type: string
  schemas:
    RequestStatusResult:
      type: object
      properties:
        request_id:
          type: string
        document_type:
          type: string
          nullable: true
        status:
          type: string
        current_step:
          type: string
          nullable: true
        callback_url:
          type: string
          nullable: true
        reference_id:
          type: string
          nullable: true
        validation_errors:
          type: array
          nullable: true
          description: >-
            Resultados de validação por campo (`field`, `error`, etc.). Para a
            visão consolidada, prefira `fields` e `scanify`.
          items:
            type: object
            additionalProperties: true
        payload:
          type: object
          nullable: true
          allOf:
            - $ref: '#/components/schemas/ExtractionResult'
          description: >-
            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:
          type: object
          additionalProperties: true
          nullable: true
        created_at:
          type: string
          format: date-time
          nullable: true
        completed_at:
          type: string
          format: date-time
          nullable: true
        processed_at:
          type: string
          format: date-time
          nullable: true
        markdown_status:
          type: string
          enum:
            - pending
            - success
            - failed
          nullable: true
        markdown_generated_at:
          type: string
          format: date-time
          nullable: true
    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.
    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
    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
  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'
    NotFound:
      description: Requisição não encontrada.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    apiKeyAuth:
      type: http
      scheme: bearer
      description: >-
        Chave de API enviada no cabeçalho Authorization no formato:
        Authorization: Bearer <API_KEY>.

````