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

# Get workspace configuration

> Returns the workspace settings including flow type, verification mode, and age thresholds.



## OpenAPI

````yaml /openapi.json get /workspace
openapi: 3.1.0
info:
  title: API Reference
  version: 1.0.0
  description: >-
    ProofAge is an identity verification and age estimation API. Use this API to
    create verification sessions, upload media (selfies and documents), and
    receive decisions via webhooks.
servers:
  - url: https://api.proofage.net/v1
    description: API
security:
  - apiKey: []
    hmacSignature: []
paths:
  /workspace:
    get:
      tags:
        - Workspace
      summary: Get workspace configuration
      description: >-
        Returns the workspace settings including flow type, verification mode,
        and age thresholds.
      operationId: getWorkspace
      responses:
        '200':
          description: '`WorkspaceResource`'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkspaceResource'
components:
  schemas:
    WorkspaceResource:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        flow_type:
          type: string
        mode:
          type: string
        age_mode:
          type:
            - string
            - 'null'
        age_threshold:
          type:
            - integer
            - 'null'
        verification_type:
          type: string
        redirect_url:
          type:
            - string
            - 'null'
        webhook_url:
          type:
            - string
            - 'null'
        allow_expired_documents:
          type: boolean
        allow_duplicate_accounts:
          type: boolean
      required:
        - id
        - name
        - flow_type
        - mode
        - age_mode
        - age_threshold
        - verification_type
        - redirect_url
        - webhook_url
        - allow_expired_documents
        - allow_duplicate_accounts
      title: WorkspaceResource
  securitySchemes:
    apiKey:
      type: apiKey
      description: Your workspace public key (pk_test_… or pk_live_…).
      in: header
      name: X-API-Key
    hmacSignature:
      type: apiKey
      description: >-
        HMAC-SHA256 of the request, hex-encoded, keyed with the workspace secret
        key. See API authentication.
      in: header
      name: X-HMAC-Signature

````

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