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

# Update Check Config

> Update the **check settings** for a specific user, including branding and preferences used when mailing checks.

This endpoint:
- Requires platform API key authentication
- Ensures the `user_id` belongs to the requesting platform
- Updates settings such as check **logo**, **signature**, and related preferences
- Supports resetting the logo to the system default
- Returns the updated check settings in a standardized response



## OpenAPI

````yaml POST /api/platform/check/update-config/{user_id}
openapi: 3.1.0
info:
  title: paywint
  version: 0.1.0
servers:
  - url: http://localhost:8001
  - url: https://api.pw.wintpay.com
  - url: https://test.pw.wintpay.com
  - url: https://api.sandbox.paywint.com
security: []
paths:
  /api/platform/check/update-config/{user_id}:
    post:
      tags:
        - Platform Check
      summary: Update a user's check settings
      description: >-
        Update the **check settings** for a specific user, including branding
        and preferences used when mailing checks.


        This endpoint:

        - Requires platform API key authentication

        - Ensures the `user_id` belongs to the requesting platform

        - Updates settings such as check **logo**, **signature**, and related
        preferences

        - Supports resetting the logo to the system default

        - Returns the updated check settings in a standardized response
      operationId: update_user_check_config_api_platform_check_update_config__user_id__post
      parameters:
        - name: user_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
            description: >-
              Unique identifier (UUID) of the user whose check config is being
              updated.
            title: User Id
          description: >-
            Unique identifier (UUID) of the user whose check config is being
            updated.
          example: f47ac10b-****-****-****-0e02b2c3d479
        - name: X-Platform-ID
          in: header
          required: true
          schema:
            type: string
            format: uuid
            description: >-
              Unique platform identifier (UUID). You receive this during
              onboarding. Must be sent with every API request.
            title: X-Platform-Id
          description: >-
            Unique platform identifier (UUID). You receive this during
            onboarding. Must be sent with every API request.
        - name: X-Signature
          in: header
          required: true
          schema:
            type: string
            description: >-
              HMAC-SHA256 request signature for authentication. Use your
              platform secret key to compute it as: `METHOD + PATH + QUERY +
              BODY_HASH`.
            title: X-Signature
          description: >-
            HMAC-SHA256 request signature for authentication. Use your platform
            secret key to compute it as: `METHOD + PATH + QUERY + BODY_HASH`.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExternalCheckSettingsUpdate'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonResponse_ExternalCheckSettingsRead_'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    ExternalCheckSettingsUpdate:
      properties:
        logo_url:
          anyOf:
            - type: string
            - type: 'null'
          title: Logo Url
          description: >-
            Public HTTPS URL of the logo to use on checks. Ignored if
            `set_default_logo` is true.
          example: https://cdn.example.com/branding/acme-logo.png
        signature_url:
          anyOf:
            - type: string
            - type: 'null'
          title: Signature Url
          description: Public HTTPS URL of the signature image to use on checks.
          example: https://cdn.example.com/signatures/jane-doe-sign.png
        set_default_logo:
          type: boolean
          title: Set Default Logo
          description: When true, clears the custom logo and uses the paywint logo.
          default: false
          example: false
      type: object
      title: ExternalCheckSettingsUpdate
    CommonResponse_ExternalCheckSettingsRead_:
      properties:
        success:
          type: boolean
          title: Success
          description: Indicates whether the request was processed successfully.
          default: true
          example: true
        message:
          type: string
          title: Message
          description: >-
            A short, human-readable message describing the result of the
            request.
          default: Success
          example: Operation completed.
        data:
          anyOf:
            - $ref: '#/components/schemas/ExternalCheckSettingsRead'
            - type: 'null'
          description: The main response payload, if applicable
        queryGeneratedTime:
          anyOf:
            - type: number
            - type: 'null'
          title: Querygeneratedtime
          description: >-
            The Unix timestamp (in seconds) indicating when the response was
            generated.
          default: 1782303609.673092
          example: 1718006400
      type: object
      title: CommonResponse[ExternalCheckSettingsRead]
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ExternalCheckSettingsRead:
      properties:
        logo:
          anyOf:
            - type: string
            - type: 'null'
          title: Logo
          description: >-
            Stored URL of the logo used on printed checks. Null when using the
            system default.
          example: https://assets.internal/check-logos/USERID/logo.png
        signature:
          anyOf:
            - type: string
            - type: 'null'
          title: Signature
          description: Stored URL of the signature image used on checks.
          example: https://assets.internal/check-signatures/USERID/sign.png
      type: object
      title: ExternalCheckSettingsRead
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError

````