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

# Get your branding

> Read your ScripX white-label branding: the brand name, logo, support contact, accent colour and footer note that render on client-facing surfaces carrying your desk identity.

Your desk's white-label branding. Any valid key can read it (no scope required); a broker only ever sees its own. Always returns a record, defaulted to the ScripX brand until you set your own.

### Request example

```bash theme={"dark"}
curl "https://api.scripxhq.com/v1/branding" \
  -H "X-ScripX-Key: <YOUR_API_KEY>"
```

### Response example

```json theme={"dark"}
{
  "branding": {
    "iec": "0512345678",
    "brand_name": "Acme Trade Desk",
    "legal_name": "Acme Fintech Pvt Ltd",
    "logo_url": "https://cdn.acme.example/logo.svg",
    "support_email": "support@acme.example",
    "support_url": "https://acme.example/support",
    "accent_color": "#4F7CFF",
    "footer_note": "Trades settle on ScripX.",
    "is_white_labelled": true
  },
  "as_of": "2026-07-25T14:32:00+05:30"
}
```

| Field                           | Meaning                                 |
| ------------------------------- | --------------------------------------- |
| `brand_name`                    | The name shown on branded surfaces      |
| `legal_name`                    | Your registered legal entity            |
| `logo_url`                      | An `https://` logo URL                  |
| `support_email` / `support_url` | Where your clients reach support        |
| `accent_color`                  | A `#rrggbb` hex accent                  |
| `footer_note`                   | A short line rendered in the footer     |
| `is_white_labelled`             | `true` once a brand name or logo is set |

<Note>
  ScripX is always present to your clients: verification, settlement, payout and the audit trail carry ScripX regardless of branding. Branding personalises the surface, it does not hide who runs the market.
</Note>

### Errors

* `401` / `429`, the standard [auth errors](/authentication#authentication-errors).

**Terms used here:** [IEC](/annexure/terminology#iec), [API key](/annexure/terminology#api-key), [scope](/annexure/terminology#scope). Full list in the [terminology annexure](/annexure/terminology).

### Next steps

* [Set your branding](/api-reference/account/branding-set) with a `PUT`.


## OpenAPI

````yaml GET /v1/branding
openapi: 3.1.0
info:
  title: ScripX Partner API
  version: 1.2.0
  description: >-
    Automate duty-credit-scrip trading: quote, order, positions, market,
    webhooks. Auth: `X-ScripX-Key: scripx_live_…`. Money = integer paise; price
    = bps of face.
  contact:
    name: ScripX API Support
    email: amin@eximfiles.io
    url: https://scripxhq.com
servers:
  - url: https://api.scripxhq.com
    description: >-
      Production and sandbox share one host; a scripx_test_ key selects the
      sandbox.
security:
  - ApiKeyAuth: []
tags:
  - name: Firms
    description: >-
      client-firm lifecycle: register, verify, authorize, credits, update,
      offboard
  - name: Trading
    description: quote, orders, positions, market
  - name: Group
    description: intra-group netting + positions (enterprise/broker)
  - name: Cross
    description: 'broker cross-desk: block deals + intra-group transfers'
  - name: Webhooks
    description: event subscriptions + delivery
  - name: Account
    description: usage + metering
  - name: Keys
    description: self-serve scoped child keys (sub-accounts)
paths:
  /v1/branding:
    get:
      tags:
        - Account
      summary: Your white-label branding
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Branding'
        '401':
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - ApiKeyAuth: []
components:
  schemas:
    Branding:
      type: object
      properties:
        branding:
          type: object
    Error:
      type: object
      properties:
        error:
          type: string
        code:
          type: string
          description: stable machine code
          enum:
            - bad_request
            - unauthorized
            - forbidden
            - not_found
            - conflict
            - unprocessable
            - rate_limited
            - internal
        message:
          type: string
        detail:
          type: object
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-ScripX-Key
      description: >-
        Your API key, e.g. `scripx_live_…`. Bound to one firm; tenant isolation
        is enforced.

````