> ## Documentation Index
> Fetch the complete documentation index at: https://docs.westhetics.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Baixar o PDF

> Um endereço de 5 minutos para o PDF protegido; assinado o documento, o PDF assinado (montado na hora, quando ainda não estava guardado). O documento da anamnese traz as respostas: o app precisa de `anamneses:answers`, e a pessoa, do perfil que lê a anamnese (403). Assinado na Autentique, o arquivo dela chega em alguns minutos: até lá, 409.

**Escopo do app:** `documents:read`. Pelo OAuth, vale o perfil da pessoa.



## OpenAPI

````yaml /api-reference/openapi.json get /v1/documents/{id}/file
openapi: 3.1.0
info:
  title: API da Westhetics
  version: 1.0.0
  description: >-
    A API pública da Westhetics: pacientes, anamneses, contratos e assinaturas
    da clínica, com eventos por webhook. Autentique com a chave do app
    (`Authorization: Bearer wx_…`), criada pela gestora em Integrações, ou com o
    token OAuth da pessoa. Respostas em JSON, mensagens em pt-BR. Guias em
    https://docs.westhetics.io.
  contact:
    name: Westhetics
    url: https://docs.westhetics.io
    email: suporte@westhetics.com.br
servers:
  - url: https://api.westhetics.io
    description: Produção
security:
  - apiKey: []
  - oauth2: []
tags:
  - name: Conta
    description: Quem chama e a clínica.
  - name: Pacientes
    description: O cadastro da paciente.
  - name: Anamneses
    description: Enviar, acompanhar e ler a anamnese.
  - name: Catálogo
    description: Procedimentos, prestadores e modelos.
  - name: Contratos e assinaturas
    description: Gerar o contrato e os termos e enviar para assinatura.
  - name: Eventos
    description: O que aconteceu na clínica, por consulta ou por webhook.
  - name: Webhooks
    description: Os endereços que recebem os eventos do app.
paths:
  /v1/documents/{id}/file:
    get:
      tags:
        - Contratos e assinaturas
      summary: Baixar o PDF
      description: >-
        Um endereço de 5 minutos para o PDF protegido; assinado o documento, o
        PDF assinado (montado na hora, quando ainda não estava guardado). O
        documento da anamnese traz as respostas: o app precisa de
        `anamneses:answers`, e a pessoa, do perfil que lê a anamnese (403).
        Assinado na Autentique, o arquivo dela chega em alguns minutos: até lá,
        409.


        **Escopo do app:** `documents:read`. Pelo OAuth, vale o perfil da
        pessoa.
      operationId: getDocumentFile
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: Sucesso.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/DocumentFile'
                required:
                  - data
              example:
                data:
                  url: >-
                    https://zosqwpksgewzphikvgfz.supabase.co/storage/v1/object/sign/documents/…
                  expiresAt: '2026-10-15T14:35:00Z'
                  isSigned: true
                  hash: >-
                    a3f9c1e7d2b84f6a9e0c1d2b3a4f5e6d7c8b9a0f1e2d3c4b5a6978877665544
        '401':
          description: Sem chave, chave que não confere, revogada ou token vencido.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: O app não tem o escopo, ou a pessoa não pode pelo perfil.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Não existe nesta clínica.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '409':
          description: >-
            Conflito com o estado atual (já existe, já enviado, outra alteração
            chegou antes, ou a mesma Idempotency-Key ainda em andamento).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: Passou de 100 chamadas por minuto; veja `Retry-After`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    DocumentFile:
      type: object
      properties:
        url:
          type: string
          description: Endereço assinado do PDF protegido, válido por 5 minutos.
        expiresAt:
          type: string
          description: Data e hora ISO 8601, em UTC.
        isSigned:
          type: boolean
        hash:
          anyOf:
            - type: string
            - type: 'null'
      required:
        - url
        - expiresAt
        - isSigned
        - hash
      additionalProperties: false
      description: O endereço temporário do PDF.
    Error:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              enum:
                - bad_request
                - unauthenticated
                - forbidden
                - not_found
                - conflict
                - validation_failed
                - rate_limited
                - unavailable
                - internal_error
            message:
              type: string
              description: A causa e o caminho, em pt-BR.
            fields:
              description: 'No 422: a mensagem de cada campo.'
              type: object
              propertyNames:
                type: string
              additionalProperties:
                type: string
            requestId:
              type: string
          required:
            - code
            - message
            - requestId
          additionalProperties: false
      required:
        - error
      additionalProperties: false
      description: O envelope de erro.
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer
      bearerFormat: wx_<64 hex>
      description: >-
        A chave do app de integração, criada em Integrações. Escopos:
        `patients:read` (Listar, buscar e ler pacientes; os eventos patient.*.);
        `patients:write` (Criar e editar pacientes. Inclui ler.);
        `anamneses:read` (Listar e ler anamneses, sem as respostas; os eventos
        anamnesis.*.); `anamneses:write` (Enviar, reenviar e cancelar anamnese.
        Inclui ler.); `anamneses:answers` (Ler as respostas da anamnese
        preenchida. É dado de saúde.); `documents:read` (Atendimentos,
        documentos, status da assinatura e o PDF; os eventos appointment.* e
        signature_request.*.); `documents:write` (Gerar contrato e termos e
        enviar para assinatura, reenviar e cancelar. Inclui ler.);
        `catalog:read` (Procedimentos, prestadores e modelos de documento da
        clínica.); `webhooks:write` (Criar, alterar e remover os webhooks do
        próprio app pela API.)
    oauth2:
      type: oauth2
      description: >-
        Token OAuth 2.1 da pessoa (código com PKCE), emitido a um aplicativo
        conectado. Vale o perfil da pessoa na clínica da conexão, por 12 horas.
      flows:
        authorizationCode:
          authorizationUrl: https://zosqwpksgewzphikvgfz.supabase.co/auth/v1/oauth/authorize
          tokenUrl: https://zosqwpksgewzphikvgfz.supabase.co/auth/v1/oauth/token
          refreshUrl: https://zosqwpksgewzphikvgfz.supabase.co/auth/v1/oauth/token
          scopes:
            openid: Identidade.
            email: O e-mail.
            profile: O nome.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.