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

# Health check

> Verifica se a API está disponível. Endpoint público que não requer autenticação.



## OpenAPI

````yaml GET /health
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:
  /health:
    get:
      summary: Health check
      description: >-
        Verifica se a API está disponível. Endpoint público que não requer
        autenticação.
      operationId: healthCheck
      responses:
        '200':
          description: API disponível.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HealthResult'
      security: []
components:
  schemas:
    HealthResult:
      type: object
      properties:
        status:
          type: string
          example: ok
        timestamp:
          type: string
          format: date-time
  securitySchemes:
    apiKeyAuth:
      type: http
      scheme: bearer
      description: >-
        Chave de API enviada no cabeçalho Authorization no formato:
        Authorization: Bearer <API_KEY>.

````