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

> Update the existing **check mailing address** for a specific user.

This endpoint:
- Applies partial or full updates to the saved mailing address
- Returns the updated address in a standardized response


## OpenAPI

````yaml PATCH /api/platform/check/update-address/{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-address/{user_id}:
    patch:
      tags:
        - Platform Check
      summary: Update a user's check mailing address
      description: |-
        Update the existing **check mailing address** for a specific user.

        This endpoint:
        - Applies partial or full updates to the saved mailing address
        - Returns the updated address in a standardized response
      operationId: >-
        update_user_check_address_api_platform_check_update_address__user_id__patch
      parameters:
        - name: user_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
            description: >-
              Unique identifier (UUID) of the user whose check address is being
              created.
            title: User Id
          description: >-
            Unique identifier (UUID) of the user whose check address is being
            created.
          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/ExternalCheckAddressUpdate'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonResponse_ExternalCheckAddressRead_'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    ExternalCheckAddressUpdate:
      properties:
        name:
          anyOf:
            - type: string
              maxLength: 180
              minLength: 2
            - type: 'null'
          title: Name
          description: Display name shown on checks (e.g., company or account label).
          example: John Doe
        address_line_1:
          anyOf:
            - type: string
              maxLength: 64
            - type: 'null'
          title: Address Line 1
          description: Primary street address, including suite/apartment if applicable.
          example: 123 Market St, Suite 500
        address_line_2:
          anyOf:
            - type: string
              maxLength: 64
            - type: 'null'
          title: Address Line 2
          description: Secondary address line (optional).
          example: Building B, Floor 3
        city:
          anyOf:
            - type: string
              maxLength: 40
            - type: 'null'
          title: City
          description: City name.
          example: San Francisco
        state:
          anyOf:
            - type: string
              maxLength: 30
            - type: 'null'
          title: State
          description: State, province, or region.
          example: CA
        zipcode:
          anyOf:
            - type: string
              maxLength: 10
              minLength: 5
            - type: 'null'
          title: Zipcode
          description: Postal or ZIP code.
          example: '94103'
        country:
          anyOf:
            - type: string
              maxLength: 40
            - type: 'null'
          title: Country
          description: Country name.
          example: United States
      type: object
      title: ExternalCheckAddressUpdate
    CommonResponse_ExternalCheckAddressRead_:
      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/ExternalCheckAddressRead'
            - 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[ExternalCheckAddressRead]
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ExternalCheckAddressRead:
      properties:
        name:
          anyOf:
            - type: string
              maxLength: 100
              minLength: 2
            - type: 'null'
          title: Name
          description: Full name of the receiving person or business.
          example: John Smith
        address_line_1:
          type: string
          maxLength: 64
          title: Address Line 1
          description: Secondary address line (optional).
          example: Building B, Floor 3
        address_line_2:
          anyOf:
            - type: string
              maxLength: 64
            - type: 'null'
          title: Address Line 2
          description: Primary street address, including suite/apartment if applicable.
          example: 123 Market St, Suite 500
        city:
          type: string
          maxLength: 40
          title: City
          description: City name.
          example: San Francisco
        state:
          type: string
          maxLength: 30
          title: State
          description: State, province, or region.
          example: CA
        zipcode:
          type: string
          maxLength: 10
          minLength: 5
          title: Zipcode
          description: Postal or ZIP code.
          example: '94103'
        country:
          type: string
          maxLength: 40
          title: Country
          description: Country name.
          example: United States
        address_id:
          type: string
          format: uuid4
          title: Address Id
          description: Unique identifier (UUID) for this address record.
          example: a1b2c3d4-****-****-****-e5f6g7h8i9j0
        created_at:
          type: string
          format: date-time
          title: Created At
          description: ISO 8601 timestamp when this address was created.
          example: '2024-01-15T10:30:00Z'
        updated_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Updated At
          description: ISO 8601 timestamp when this address was last updated.
          example: '2024-02-10T14:05:22Z'
      type: object
      required:
        - address_line_1
        - city
        - state
        - zipcode
        - country
        - address_id
        - created_at
      title: ExternalCheckAddressRead
    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

````