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

# Client configuration

> Retrieve mandatory customer fields, test-period status, and subscription availability.

## GET `/client-config`

Retrieve mandatory customer fields, test-period status, and subscription availability.

Send `Authorization: Bearer YOUR_API_KEY` and `X-Device-ID: YOUR_DEVICE_ID`. See [authentication](https://tapcoupon.mintlify.site/authentication.md).

Map `mandatoryCustomerFields.name` to `customer.contact.fullName` and `phone` to `customer.contact.phone`. The `address` flag requires the nested address data. See [customer data](https://tapcoupon.mintlify.site/customer-data.md).

`hasSubscription` reports whether the subscription status is active. `testPeriodStatus` reports whether the test window is open, how many cards have been used, the maximum count, and its expiration. Check these values before offering test or real card issuance.

### Example request

```bash theme={null}
curl "https://tapcoupon.at/api/v1/client-config" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "X-Device-ID: YOUR_DEVICE_ID"
```

### Example response

```json theme={null}
{
  "mandatoryCustomerFields": {
    "email": true,
    "name": true,
    "phone": false,
    "address": false,
    "birthdate": false
  },
  "testPeriodStatus": {
    "inTestWindow": true,
    "testCardsUsed": 2,
    "maxTestCards": 10,
    "testPeriodExpiresAt": "2026-10-15T12:00:00Z"
  },
  "hasSubscription": false
}
```


## OpenAPI

````yaml api-reference/openapi.json GET /client-config
openapi: 3.1.0
info:
  title: TapCoupon POS and partner API
  version: 1.0.0
  description: >-
    API-key POS operations, customer card views, and partner payment sessions.
    Verified against the tap_coupon backend on 2026-10-02. Dashboard /clients
    and administrative routes use separate authentication and are outside this
    reference.
servers:
  - url: https://tapcoupon.at/api/v1
security: []
paths:
  /client-config:
    get:
      tags:
        - Other
      summary: Client configuration
      description: >-
        Retrieve mandatory customer fields, test-period status, and subscription
        availability.
      operationId: other_client_config
      parameters:
        - name: X-Device-ID
          in: header
          required: true
          description: Stable device identifier. API key binds to this value on first use.
          schema:
            type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClientConfig'
              example:
                mandatoryCustomerFields:
                  email: true
                  name: true
                  phone: false
                  address: false
                  birthdate: false
                testPeriodStatus:
                  inTestWindow: true
                  testCardsUsed: 2
                  maxTestCards: 10
                  testPeriodExpiresAt: '2026-10-15T12:00:00Z'
                hasSubscription: false
        '401':
          description: >-
            Missing or invalid API key, device id, employee token, or
            credentials.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: >-
            Device binding mismatch, archived location, employee location
            restriction, or account restriction.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: >-
            Rate limit exceeded. The response body is determined by the
            rate-limit middleware.
        '500':
          description: Internal server error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - bearerAuth: []
components:
  schemas:
    ClientConfig:
      type: object
      properties:
        mandatoryCustomerFields:
          type: object
          properties:
            email:
              type: boolean
            name:
              type: boolean
            phone:
              type: boolean
            address:
              type: boolean
            birthdate:
              type: boolean
        testPeriodStatus:
          type: object
          properties:
            inTestWindow:
              type: boolean
            testCardsUsed:
              type: integer
            maxTestCards:
              type: integer
            testPeriodExpiresAt:
              type: string
              format: date-time
        hasSubscription:
          type: boolean
    Error:
      type: object
      properties:
        error:
          type: string
          description: Human-readable error.
        errorCode:
          type: string
          description: >-
            Handler errors include a machine-readable code; middleware errors
            may omit it.
      required:
        - error
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Location API key. Also requires X-Device-ID.

````

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