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

# Update a Payee's Address

> Change an address. Send only the fields you want to update — the rest are kept.


## OpenAPI

````yaml PATCH /v1/platform/payees/addresses/{payee_id}/{address_id}
openapi: 3.1.0
info:
  title: Finogate Platform API v1
  version: 0.1.0
servers:
  - url: https://api-sandbox.finogates.com
    description: Sandbox
  - url: https://api.finogates.com
    description: Production
security: []
tags:
  - name: auth
  - name: users
  - name: payees
  - name: verification
  - name: bank accounts
  - name: card processing
  - name: digital-assets
  - name: international
  - name: fees
  - name: onboarding
  - name: pending-applications
  - name: wallets
  - name: payments
  - name: document mailing
  - name: merchant onboarding
  - name: catalog
  - name: webhooks
  - name: screening
  - name: Platform - File Scanning
  - name: phone-numbers
  - name: sms
  - name: calls
  - name: listings
  - name: Card Transfers
  - name: embed-tokens
paths:
  /v1/platform/payees/addresses/{payee_id}/{address_id}:
    patch:
      tags:
        - payees
      summary: Update a Payee's Address
      description: >-
        Change an address. Send only the fields you want to update — the rest
        are kept.
      operationId: >-
        update_address_v1_platform_payees_addresses__payee_id___address_id__patch
      parameters:
        - name: payee_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
            title: Payee Id
        - name: address_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
            title: Address Id
        - name: user_id
          in: query
          required: false
          schema:
            anyOf:
              - type: string
                format: uuid
              - type: 'null'
            description: >-
              Optional. The unique ID of the user who owns this payee. Omit to
              look the payee up by its ID within your tenant.
            examples:
              - b3a9b622-cc63-4d3c-aad6-2d8e29e6f9d4
            title: User Id
          description: >-
            Optional. The unique ID of the user who owns this payee. Omit to
            look the payee up by its ID within your tenant.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PayeeAddressUpdate'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonResponse_PayeeAddressRead_'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - _AuthenticatedBearer: []
components:
  schemas:
    PayeeAddressUpdate:
      properties:
        label:
          anyOf:
            - type: string
              maxLength: 120
            - type: 'null'
          title: Label
        address_type:
          anyOf:
            - type: string
              maxLength: 30
            - type: 'null'
          title: Address Type
        line1:
          anyOf:
            - type: string
              maxLength: 255
            - type: 'null'
          title: Line1
        line2:
          anyOf:
            - type: string
              maxLength: 255
            - type: 'null'
          title: Line2
        city:
          anyOf:
            - type: string
              maxLength: 120
            - type: 'null'
          title: City
        state:
          anyOf:
            - type: string
              maxLength: 120
            - type: 'null'
          title: State
        postal_code:
          anyOf:
            - type: string
              maxLength: 20
            - type: 'null'
          title: Postal Code
        phone:
          anyOf:
            - type: string
              maxLength: 40
            - type: 'null'
          title: Phone
        doc_number:
          anyOf:
            - type: string
              maxLength: 100
            - type: 'null'
          title: Doc Number
        doc_type:
          anyOf:
            - type: string
              maxLength: 50
            - type: 'null'
          title: Doc Type
        doc_issue_country:
          anyOf:
            - type: string
              maxLength: 10
            - type: 'null'
          title: Doc Issue Country
        doc_issue_date:
          anyOf:
            - type: string
              maxLength: 20
            - type: 'null'
          title: Doc Issue Date
        doc_due_date:
          anyOf:
            - type: string
              maxLength: 20
            - type: 'null'
          title: Doc Due Date
        doc_issuer:
          anyOf:
            - type: string
              maxLength: 255
            - type: 'null'
          title: Doc Issuer
        is_default:
          type: boolean
          title: Is Default
          default: false
        country:
          anyOf:
            - type: string
            - type: 'null'
          title: Country
      type: object
      title: PayeeAddressUpdate
      description: >-
        Update a payee address (PATCH — only provided fields change).


        The service applies ``model_dump(exclude_unset=True)`` so an omitted
        field

        is left untouched (including ``is_default``, which carries a default
        here).
    CommonResponse_PayeeAddressRead_:
      properties:
        status_code:
          type: integer
          title: Status Code
          description: HTTP status code for the response.
        data:
          $ref: '#/components/schemas/PayeeAddressRead'
          description: Payload or error details.
        query_generated_time:
          type: integer
          title: Query Generated Time
          description: >-
            UTC timestamp (milliseconds since epoch) when response was
            generated.
      type: object
      required:
        - status_code
        - data
        - query_generated_time
      title: CommonResponse[PayeeAddressRead]
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    PayeeAddressRead:
      properties:
        id:
          type: string
          format: uuid
          title: Id
        label:
          anyOf:
            - type: string
            - type: 'null'
          title: Label
        address_type:
          anyOf:
            - type: string
            - type: 'null'
          title: Address Type
        line1:
          anyOf:
            - type: string
            - type: 'null'
          title: Line1
        line2:
          anyOf:
            - type: string
            - type: 'null'
          title: Line2
        city:
          anyOf:
            - type: string
            - type: 'null'
          title: City
        state:
          anyOf:
            - type: string
            - type: 'null'
          title: State
        postal_code:
          anyOf:
            - type: string
            - type: 'null'
          title: Postal Code
        country:
          anyOf:
            - type: string
            - type: 'null'
          title: Country
        phone:
          anyOf:
            - type: string
            - type: 'null'
          title: Phone
        doc_number:
          anyOf:
            - type: string
            - type: 'null'
          title: Doc Number
        doc_type:
          anyOf:
            - type: string
            - type: 'null'
          title: Doc Type
        doc_issue_country:
          anyOf:
            - type: string
            - type: 'null'
          title: Doc Issue Country
        doc_issue_date:
          anyOf:
            - type: string
            - type: 'null'
          title: Doc Issue Date
        doc_due_date:
          anyOf:
            - type: string
            - type: 'null'
          title: Doc Due Date
        doc_issuer:
          anyOf:
            - type: string
            - type: 'null'
          title: Doc Issuer
        is_default:
          type: boolean
          title: Is Default
          default: false
        status:
          type: string
          title: Status
        created_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Created At
        updated_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Updated At
      type: object
      required:
        - id
        - status
      title: PayeeAddressRead
      description: |-
        Response shape for a payee address. ``status`` is surfaced as its label
        (``active`` / ``disabled`` / …) rather than the stored integer.
    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
  securitySchemes:
    _AuthenticatedBearer:
      type: oauth2
      flows:
        password:
          scopes: {}
          tokenUrl: /v1/platform/auth/token

````