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

# Read client settings

> Returns the stored client configuration — webhook URL/secret, sponsorship rules, source-token whitelist, and price-deviation guard — for the authenticated project.



## OpenAPI

````yaml https://raw.githubusercontent.com/rhinestonewtf/openapi/refs/heads/main/deposit-service.json get /setup
openapi: 3.1.0
info:
  title: Deposit Service API
  version: 1.0.0
  description: >-
    Cross-chain deposit processing service with automatic token bridging and gas
    sponsorship
servers:
  - url: https://v1.orchestrator.rhinestone.dev/deposit-processor
security: []
paths:
  /setup:
    get:
      tags:
        - Clients
      summary: Read client settings
      description: >-
        Returns the stored client configuration — webhook URL/secret,
        sponsorship rules, source-token whitelist, and price-deviation guard —
        for the authenticated project.
      parameters:
        - schema:
            type: string
            description: API key for authentication (omit when sending Authorization)
            example: your-api-key
          required: false
          description: API key for authentication (omit when sending Authorization)
          name: x-api-key
          in: header
        - schema:
            type: string
            description: >-
              Bearer platform token (e.g. forwarded by user-service). Takes
              precedence over `x-api-key` when both are present.
            example: Bearer eyJhbGciOi...
          required: false
          description: >-
            Bearer platform token (e.g. forwarded by user-service). Takes
            precedence over `x-api-key` when both are present.
          name: authorization
          in: header
      responses:
        '200':
          description: Client configuration
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetSetupResponse'
        '401':
          description: Authentication required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: API key lacks required deposits scope
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  schemas:
    GetSetupResponse:
      type: object
      properties:
        webhookUrl:
          type: string
        hasWebhookSecret:
          type: boolean
        sponsorship:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/ChainSponsorship'
        depositWhitelist:
          type: object
          additionalProperties:
            type: object
            additionalProperties:
              type: object
              properties:
                minAmount:
                  type: string
                maxAmount:
                  type: string
          description: >-
            Per-source-chain deposit allowlist keyed by CAIP-2 chain
            identifiers, each mapping allowed tokens to optional raw-unit
            min/max limits.
        maxPriceDeviationBps:
          type: number
        minDepositUsd:
          type: number
      required:
        - hasWebhookSecret
        - maxPriceDeviationBps
    ErrorResponse:
      type: object
      properties:
        error:
          type: string
        details:
          type: array
          items:
            type: object
            properties:
              message:
                type: string
              path:
                type: array
                items:
                  anyOf:
                    - type: string
                    - type: number
              code:
                type: string
            required:
              - message
      required:
        - error
    ChainSponsorship:
      type: object
      properties:
        gas:
          type: string
          enum:
            - all
            - none
            - deployed
          description: Gas sponsorship mode
          example: all
        swap:
          type: string
          enum:
            - all
            - none
          description: Fee sponsorship mode
          example: all
        bridging:
          type: string
          enum:
            - all
            - none
          description: Fee sponsorship mode
          example: all

````