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

# Validate withdrawal address

> Check that a wallet address is correctly formed for a token and network before you submit a withdrawal. This is a format check only — it does not confirm the address exists, is reachable, or is permitted. A withdrawal to an address that passes here can still be rejected for other reasons.



## OpenAPI

````yaml /api-reference/openapi.json post /payments/wallet-addresses/validate
openapi: 3.0.0
info:
  title: BREET PUBLIC API
  version: 1.0.0
  license:
    name: Proprietary
    url: https://breet.io/terms
servers:
  - url: https://api.breet.io/v1
security:
  - appId: []
    appSecret: []
    breetEnv: []
tags:
  - name: Crypto Wallet
    description: Generate and manage crypto wallet addresses for receiving deposits.
    x-group: Wallets and Deposits
  - name: Withdrawals
    description: >-
      ## Withdrawals


      To help protect your funds, withdrawals support an additional security
      layer through **IP whitelisting**.


      ### IP Whitelisting


      When IP whitelisting is enabled, all withdrawal requests must originate
      from an approved IP address. Any withdrawal request coming from an IP not
      on the whitelist will be automatically blocked.


      You can add up to **7 IP addresses** from your dashboard.


      This feature is recommended for:


      - Production servers
          
      - Preventing unauthorized withdrawal attempts
          

      ### How it works


      - Enable IP whitelisting from your dashboard
          
      - Add up to 7 trusted IP addresses
          
      - Only requests from those IPs will be allowed to initiate withdrawals
          

      If IP whitelisting is disabled, withdrawals can be initiated from any IP
      address.
  - name: Banks
    description: List, validate, add, and remove bank accounts for fiat withdrawals.
  - name: Transactions
    description: Retrieve deposit and trade transaction history.
  - name: Webhooks
    description: >-
      Inspect and retry **outgoing** webhooks we send to your server (trade and
      withdrawal events). Requires an active integration with API access (VIP
      partners). For **incoming** payload shapes and verification, see the
      Webhooks guide in the Guides tab.
  - name: Assets
    description: >-
      Retrieve the list of supported deposit/sell assets and their
      configuration.
  - name: Rates and Prices
    description: >-
      Get live market prices and calculate conversion rates. These endpoints are
      public and do not require authentication.
  - name: Account
    description: Retrieve and update integration account details and preferences.
  - name: Testing
    description: Endpoints for testing your integration in the sandbox environment.
  - name: Conversion
    description: >-
      Convert between USD and local fiat (NGN | GHS). Available for both user
      and integration (business) flows.
  - name: Withdrawal addresses
    description: >-
      Add and remove withdrawal (payout) wallet addresses. If the same address,
      network, and token are sent with a different label, the existing address
      is updated.
paths:
  /payments/wallet-addresses/validate:
    post:
      tags:
        - Withdrawal addresses
      summary: Validate withdrawal address
      description: >-
        Check that a wallet address is correctly formed for a token and network
        before you submit a withdrawal. This is a format check only — it does
        not confirm the address exists, is reachable, or is permitted. A
        withdrawal to an address that passes here can still be rejected for
        other reasons.
      operationId: validateWithdrawalAddress
      requestBody:
        content:
          application/json:
            schema:
              type: object
              required:
                - address
                - token
              properties:
                address:
                  type: string
                  description: The wallet address to check.
                  example: TQn9Y2khEsLJW1ChVWFMSMeRDow5KcbLSE
                token:
                  type: string
                  description: Token symbol.
                  enum:
                    - USDT
                    - USDC
                    - BTC
                    - LTC
                    - DOGE
                    - BCH
                network:
                  type: string
                  description: >-
                    Blockchain network. Required for stablecoins. Omit it for
                    the UTXOs BTC, LTC, DOGE, and BCH, which run on a single
                    chain.
                  enum:
                    - ERC20
                    - TRC20
                    - BSC
                    - SOL
                    - TON
                    - BASE
            examples:
              stablecoin:
                summary: Stablecoin — network required
                value:
                  address: TQn9Y2khEsLJW1ChVWFMSMeRDow5KcbLSE
                  token: USDT
                  network: TRC20
              utxo:
                summary: UTXO — no network
                value:
                  address: bc1qar0srrr7xfkvy5l643lydnw9re59gtzzwf5mdq
                  token: BTC
      responses:
        '200':
          description: The address is valid for the token and network
          content:
            application/json:
              example:
                message: wallet address is valid
                success: true
                data:
                  address: TQn9Y2khEsLJW1ChVWFMSMeRDow5KcbLSE
                  token: USDT
                  network: TRC20
                  valid: true
                meta: {}
                summary: {}
                stats: {}
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '422':
          description: >-
            The address is invalid, or the token and network combination is not
            supported
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                invalidAddress:
                  summary: Address is not valid for the token and network
                  value:
                    success: false
                    message: validation errors
                    meta: {}
                    errors:
                      - message: invalid wallet address
                        field: address
                        location: body
                    data: {}
                missingNetwork:
                  summary: Network omitted for a stablecoin
                  value:
                    success: false
                    message: validation errors
                    meta: {}
                    errors:
                      - message: network is required
                        field: network
                        location: body
                    data: {}
                networkOnUtxo:
                  summary: Network sent with a UTXO token
                  value:
                    success: false
                    message: validation errors
                    meta: {}
                    errors:
                      - message: BTC does not support a network
                        field: network
                        location: body
                    data: {}
        '500':
          $ref: '#/components/responses/InternalServerError'
components:
  responses:
    Unauthorized:
      description: Invalid or missing API credentials
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            notAuthenticated:
              summary: Missing credentials
              value:
                success: false
                message: you're not authenticated
                meta: {}
                errors: []
                data: {}
            wrongCredentials:
              summary: Invalid app ID or secret
              value:
                success: false
                message: wrong app id and secret combination
                meta: {}
                errors: []
                data: {}
    Forbidden:
      description: The integration is inactive or the action is not permitted
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            success: false
            message: you do not have api access
            meta: {}
            errors: []
            data: {}
    InternalServerError:
      description: An unexpected server error occurred
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            success: false
            message: something went wrong!
            meta: {}
            errors: []
            data: {}
  schemas:
    ErrorResponse:
      type: object
      required:
        - success
        - message
      properties:
        success:
          type: boolean
          enum:
            - false
        message:
          type: string
        meta:
          type: object
        errors:
          type: array
          items:
            type: object
        data:
          type: object
  securitySchemes:
    appId:
      type: apiKey
      in: header
      name: x-app-id
      description: Your application ID from the Breet dashboard
    appSecret:
      type: apiKey
      in: header
      name: x-app-secret
      description: Your application secret from the Breet dashboard
    breetEnv:
      type: apiKey
      in: header
      name: X-Breet-Env
      description: 'Environment selector: sandbox or production'

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.