> ## 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.

# Set your branding

> Set your ScripX white-label branding: brand name, legal name, an https logo, support contact, a hex accent colour and a footer note, validated so a stored value can never become an XSS or SSRF vector.

Set your desk's white-label branding. Any valid key may write (no scope required); a broker edits only its own record. The body is a partial update: send the fields you want to change. Returns the updated record.

Every field is validated so a stored value can never become an injection vector on a page that renders it:

* **URLs** (`logo_url`, `support_url`) must be `https://` and length-capped. `http:`, `javascript:` and `data:` are rejected with `400`.
* **`accent_color`** must be a hex colour like `#4F7CFF`; anything else is rejected (it lands in CSS).
* **Text** fields are trimmed and length-capped.

### Request example

```bash theme={"dark"}
curl -X PUT "https://api.scripxhq.com/v1/branding" \
  -H "X-ScripX-Key: <YOUR_API_KEY>" \
  -H "Content-Type: application/json" \
  -d '{
    "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."
  }'
```

### Response example

```json theme={"dark"}
{
  "updated": true,
  "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"
}
```

### Errors

* `400 bad_request`, a non-`https` URL or a malformed `accent_color`.
* `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

* [Get your branding](/api-reference/account/branding) to read it back.


## OpenAPI

````yaml PUT /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:
    put:
      tags:
        - Account
      summary: Set your white-label branding
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BrandingRequest'
      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:
    BrandingRequest:
      type: object
      properties:
        brand_name:
          type: string
        legal_name:
          type: string
        logo_url:
          type: string
          format: uri
          description: https only
        support_email:
          type: string
        support_url:
          type: string
          format: uri
        accent_color:
          type: string
          example: '#4F7CFF'
        footer_note:
          type: string
    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.

````