Bridge Liquidation Addresses API

openapi: 3.2.0
info:
  title: Bridge API Keys Liquidation Addresses API
  description: APIs to move into, out of, and between any form of a dollar
  version: '1'
servers:
- url: https://api.bridge.xyz/v0
  description: The base path for all resources
security:
- ApiKey: []
tags:
- name: Liquidation Addresses
paths:
  /customers/{customerID}/liquidation_addresses:
    post:
      summary: Create a Liquidation Address
      tags:
      - Liquidation Addresses
      parameters:
      - $ref: '#/components/parameters/CustomerIDParameter'
      - $ref: '#/components/parameters/IdempotencyKeyParameter'
      requestBody:
        description: Liquidation Address object to be created
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateLiquidationAddress'
      responses:
        '201':
          description: Liquidation Address object created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateLiquidationAddressResponse'
              examples:
                SuccessfulLiquidationAddressCreateResponse:
                  $ref: '#/components/examples/SuccessfulLiquidationAddressCreateResponse'
                SuccessfulSepaLiquidationAddressCreateResponse:
                  $ref: '#/components/examples/SuccessfulSepaLiquidationAddressCreateResponse'
        '401':
          $ref: '#/components/responses/AuthenticationError'
        '400':
          $ref: '#/components/responses/BadRequestError'
        '500':
          $ref: '#/components/responses/UnexpectedError'
    get:
      summary: Get all Liquidation Addresses for a customer
      description: Get Liquidation Addresses
      tags:
      - Liquidation Addresses
      parameters:
      - $ref: '#/components/parameters/CustomerIDParameter'
      - $ref: '#/components/parameters/LimitParameter'
      - $ref: '#/components/parameters/LiquidationScheduleStartingAfterParameter'
      - $ref: '#/components/parameters/LiquidationScheduleEndingBeforeParameter'
      responses:
        '200':
          description: List of Liquidation Addresses (the returned list is empty if none found)
          content:
            application/json:
              schema:
                title: Liquidation Addresses
                type: object
                required:
                - count
                - data
                properties:
                  count:
                    description: total number of items in data
                    type: integer
                  data:
                    type: array
                    minItems: 0
                    items:
                      $ref: '#/components/schemas/LiquidationAddress'
        '401':
          $ref: '#/components/responses/AuthenticationError'
        '400':
          $ref: '#/components/responses/BadRequestError'
        '500':
          $ref: '#/components/responses/UnexpectedError'
  /liquidation_addresses:
    get:
      summary: Get all Liquidation Addresses
      description: Get Liquidation Addresses
      tags:
      - Liquidation Addresses
      parameters:
      - $ref: '#/components/parameters/LimitParameter'
      - $ref: '#/components/parameters/LiquidationScheduleStartingAfterParameter'
      - $ref: '#/components/parameters/LiquidationScheduleEndingBeforeParameter'
      responses:
        '200':
          description: List of Liquidation Addresses (the returned list is empty if none found)
          content:
            application/json:
              schema:
                title: Liquidation Addresses
                type: object
                required:
                - count
                - data
                properties:
                  count:
                    description: total number of items in data
                    type: integer
                  data:
                    type: array
                    minItems: 0
                    items:
                      $ref: '#/components/schemas/LiquidationAddress'
        '401':
          $ref: '#/components/responses/AuthenticationError'
        '400':
          $ref: '#/components/responses/BadRequestError'
        '500':
          $ref: '#/components/responses/UnexpectedError'
  /customers/{customerID}/liquidation_addresses/{liquidationAddressID}:
    get:
      summary: Get a Liquidation Address
      description: Retrieve a Liquidation Address for the specified Liquidation Address ID
      tags:
      - Liquidation Addresses
      parameters:
      - $ref: '#/components/parameters/CustomerIDParameter'
      - $ref: '#/components/parameters/LiquidationAddressIDParameter'
      responses:
        '200':
          description: A Liquidation Address object response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LiquidationAddress'
              examples:
                SuccessfulLiquidationAddressGetResponse:
                  $ref: '#/components/examples/SuccessfulLiquidationAddressGetResponse'
                SuccessfulSepaLiquidationAddressGetResponse:
                  $ref: '#/components/examples/SuccessfulSepaLiquidationAddressGetResponse'
        '401':
          $ref: '#/components/responses/AuthenticationError'
        '400':
          $ref: '#/components/responses/BadRequestError'
        '404':
          $ref: '#/components/responses/NotFoundError'
        '500':
          $ref: '#/components/responses/UnexpectedError'
    put:
      summary: Update a Liquidation Address
      description: Update a Liquidation Address for the specified liquidation address ID. Note that `external_account_id` and `custom_developer_fee_percent` can be updated independently and are not both required.
      tags:
      - Liquidation Addresses
      parameters:
      - $ref: '#/components/parameters/CustomerIDParameter'
      - $ref: '#/components/parameters/LiquidationAddressIDParameter'
      requestBody:
        description: Liquidation Address details to be updated
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateLiquidationAddress'
      responses:
        '200':
          description: Updated Liquidation Address object
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LiquidationAddress'
              examples:
                SuccessfulLiquidationAddressUpdateResponse:
                  $ref: '#/components/examples/SuccessfulLiquidationAddressGetResponse'
                SuccessfulSepaLiquidationAddressUpdateResponse:
                  $ref: '#/components/examples/SuccessfulSepaLiquidationAddressGetResponse'
        '401':
          $ref: '#/components/responses/AuthenticationError'
        '400':
          $ref: '#/components/responses/BadRequestError'
        '500':
          $ref: '#/components/responses/UnexpectedError'
  /customers/{customerID}/liquidation_addresses/{liquidationAddressID}/drains:
    get:
      summary: Get drain history of a Liquidation Address
      description: Get drain history of a Liquidation Address
      tags:
      - Liquidation Addresses
      parameters:
      - $ref: '#/components/parameters/CustomerIDParameter'
      - $ref: '#/components/parameters/LiquidationAddressIDParameter'
      - $ref: '#/components/parameters/TxHashParameter'
      - $ref: '#/components/parameters/LimitParameter'
      - $ref: '#/components/parameters/DrainStartingAfterParameter'
      - $ref: '#/components/parameters/DrainEndingBeforeParameter'
      - $ref: '#/components/parameters/UpdatedAfterMsParameter'
      - $ref: '#/components/parameters/UpdatedBeforeMsParameter'
      - $ref: '#/components/parameters/DrainIDQueryParameter'
      responses:
        '200':
          description: List of drains (the returned list is empty if none found)
          content:
            application/json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/Drain'
              examples:
                DrainsToCryptoFound:
                  $ref: '#/components/examples/SuccessfulLiquidationAddressDrainsToCryptoResponse'
                DrainsToFiatFound:
                  $ref: '#/components/examples/SuccessfulLiquidationAddressDrainsToFiatResponse'
        '401':
          $ref: '#/components/responses/AuthenticationError'
        '400':
          $ref: '#/components/responses/BadRequestError'
        '500':
          $ref: '#/components/responses/UnexpectedError'
  /customers/{customerID}/liquidation_addresses/{liquidationAddressID}/drains/{drainID}/execute:
    parameters:
    - $ref: '#/components/parameters/CustomerIDParameter'
    - $ref: '#/components/parameters/LiquidationAddressIDParameter'
    - name: drainID
      in: path
      required: true
      schema:
        $ref: '#/components/schemas/Id'
    post:
      summary: Execute a pending USDT trade on a drain
      description: 'Force-executes a stuck USDT-to-USD trade at the current market rate. The drain must have a pending trade (i.e. appear in `GET /liquidation_addresses/drains/pending`).


        After execution, the drain will continue processing normally with the executed market rate.

        '
      tags:
      - Liquidation Addresses
      parameters:
      - $ref: '#/components/parameters/IdempotencyKeyParameter'
      responses:
        '200':
          description: Drain with trade execute at market rate enabled successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Drain'
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/AuthenticationError'
        '404':
          $ref: '#/components/responses/NotFoundError'
        '500':
          $ref: '#/components/responses/UnexpectedError'
  /customers/{customerID}/liquidation_addresses/{liquidationAddressID}/balances:
    get:
      summary: Get the balance of a Liquidation Address (deprecated)
      description: Get the balance of a Liquidation Address. Note that most Liquidation Addresses no longer hold a balance. To check recent activity on a Liquidation Address, use the `/customers/{customerID}/liquidation_addresses/{liquidationAddressID}/drains` endpoint.
      deprecated: true
      tags:
      - Liquidation Addresses
      parameters:
      - $ref: '#/components/parameters/CustomerIDParameter'
      - $ref: '#/components/parameters/LiquidationAddressIDParameter'
      responses:
        '200':
          description: Get the current balance of a Liquidation Address
          content:
            application/json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/Balance'
              examples:
                DrainsFound:
                  $ref: '#/components/examples/SuccessfulLiquidationAddressBalanceResponse'
        '401':
          $ref: '#/components/responses/AuthenticationError'
        '400':
          $ref: '#/components/responses/BadRequestError'
        '500':
          $ref: '#/components/responses/UnexpectedError'
  /liquidation_addresses/drains:
    get:
      summary: Liquidation Address Activity Across All Customers
      description: History of activity across all customers and Liquidation Addresses
      tags:
      - Liquidation Addresses
      parameters:
      - $ref: '#/components/parameters/TxHashParameter'
      - $ref: '#/components/parameters/LimitParameter'
      - $ref: '#/components/parameters/DrainStartingAfterParameter'
      - $ref: '#/components/parameters/DrainEndingBeforeParameter'
      - $ref: '#/components/parameters/UpdatedAfterMsParameter'
      - $ref: '#/components/parameters/UpdatedBeforeMsParameter'
      - $ref: '#/components/parameters/DrainIDQueryParameter'
      responses:
        '200':
          description: List of drains for all liquidation addresses (the returned list is empty if none found)
          content:
            application/json:
              schema:
                title: Liquidation Address history
                type: object
                required:
                - count
                - data
                properties:
                  count:
                    type: integer
                    description: The number of events returned
                  data:
                    type: array
                    minItems: 0
                    items:
                      $ref: '#/components/schemas/Drain'
              examples:
                DrainsToCryptoFound:
                  $ref: '#/components/examples/SuccessfulLiquidationAddressDrainsToCryptoResponse'
                DrainsToFiatFound:
                  $ref: '#/components/examples/SuccessfulLiquidationAddressDrainsToFiatResponse'
        '401':
          $ref: '#/components/responses/AuthenticationError'
        '400':
          $ref: '#/components/responses/BadRequestError'
        '500':
          $ref: '#/components/responses/UnexpectedError'
  /liquidation_addresses/drains/pending:
    get:
      summary: List drains with pending USDT trades
      description: 'Returns drains that have a stuck USDT-to-USD trade awaiting execution. Results are sorted by creation time (newest first) and paginated.


        Use `POST /customers/{customerID}/liquidation_addresses/{liquidationAddressID}/drains/{drainID}/execute` to force-execute a pending trade at the current market rate.

        '
      tags:
      - Liquidation Addresses
      parameters:
      - $ref: '#/components/parameters/LimitParameter'
      - $ref: '#/components/parameters/DrainStartingAfterParameter'
      - $ref: '#/components/parameters/DrainEndingBeforeParameter'
      - $ref: '#/components/parameters/UpdatedAfterMsParameter'
      - $ref: '#/components/parameters/UpdatedBeforeMsParameter'
      responses:
        '200':
          description: List of drains with pending trades (the returned list is empty if none found)
          content:
            application/json:
              schema:
                title: PendingDrains
                type: object
                required:
                - count
                - data
                properties:
                  count:
                    type: integer
                    description: The number of drains returned
                  data:
                    type: array
                    minItems: 0
                    items:
                      $ref: '#/components/schemas/Drain'
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/AuthenticationError'
        '500':
          $ref: '#/components/responses/UnexpectedError'
components:
  parameters:
    TxHashParameter:
      name: tx_hash
      in: query
      required: false
      schema:
        type: string
      description: The hash of the transaction
    DrainIDQueryParameter:
      name: drain_id
      in: query
      required: false
      schema:
        type: string
      description: If specified, results will be filtered to the given drain id only
    DrainStartingAfterParameter:
      in: query
      name: starting_after
      schema:
        type: string
      description: This is a drain id. If this is specified, the next page that starts with a drain right AFTER the specified drain id on the drain timeline, which is always ordered from the newest to the oldest by creation time, will be returned. This also implies that drains older than the specified drain id will be returned (shouldn't be set if ending_before is set)
    UpdatedBeforeMsParameter:
      in: query
      name: updated_before_ms
      schema:
        type: integer
      description: This is a unix timestamp in milliseconds. If this is specified, objects updated BEFORE the specified timestamp will be returned
    IdempotencyKeyParameter:
      in: header
      name: Idempotency-Key
      required: true
      schema:
        type: string
    LiquidationAddressIDParameter:
      name: liquidationAddressID
      in: path
      required: true
      schema:
        $ref: '#/components/schemas/Id'
    LiquidationScheduleStartingAfterParameter:
      in: query
      name: starting_after
      schema:
        type: string
      description: This is a liquidation address id. If this is specified, the next page that starts with a liquidation address right AFTER the specified liquidation address id on the liquidation address timeline, which is always ordered from the newest to the oldest by creation time, will be returned. This also implies that liquidation address older than the specified liquidation address id will be returned (shouldn't be set if ending_before is set)
    DrainEndingBeforeParameter:
      in: query
      name: ending_before
      schema:
        type: string
      description: This is a drain id. If this is specified, the previous page that ends with a drain right BEFORE the specified drain id on the drain timeline, which is always ordered from the newest to the oldest by creation time, will be returned. This also implies that drains newer than the specified drain id will be returned (shouldn't be set if starting_after is set)
    LiquidationScheduleEndingBeforeParameter:
      in: query
      name: ending_before
      schema:
        type: string
      description: This is a liquidation address id. If this is specified, the previous page that ends with a liquidation address right BEFORE the specified liquidation address id on the liquidation address timeline, which is always ordered from the newest to the oldest by creation time, will be returned. This also implies that liquidation address newer than the specified liquidation address id will be returned (shouldn't be set if starting_after is set)
    LimitParameter:
      in: query
      name: limit
      schema:
        type: integer
        minimum: 1
        maximum: 100
        default: 10
      description: The number of items to return (min 1, default 10, max 100)
    CustomerIDParameter:
      name: customerID
      in: path
      required: true
      schema:
        $ref: '#/components/schemas/Id'
    UpdatedAfterMsParameter:
      in: query
      name: updated_after_ms
      schema:
        type: integer
      description: This is a unix timestamp in milliseconds. If this is specified, objects updated AFTER the specified timestamp will be returned
  examples:
    SuccessfulLiquidationAddressBalanceResponse:
      summary: A successful get request for a Liquidation Address's balance
      value:
        active_balance: '0'
        pending_balance: '100.25'
    SuccessfulLiquidationAddressDrainsToCryptoResponse:
      summary: A successful get request for a Liquidation Address's drain to crypto
      value:
        count: 1
        data:
        - id: la_123
          amount: '100.25'
          customer_id: cust_123
          liquidation_address_id: la_456
          currency: usdc
          state: funds_received
          created_at: '2020-01-01T00:00:00.000Z'
          updated_at: '2020-01-01T00:00:00.000Z'
          deposit_tx_hash: '0xc13d7905be5c989378a945487cd2a1193627ae606009e28e296d48ddaec66162'
          destination:
            payment_rail: ethereum
            currency: usdt
            to_address: '0xb794f5ea0ba39494ce839613fffba74279579268'
          destination_tx_hash: '0xdeadbeef'
          receipt:
            initial_amount: '100.25'
            developer_fee: '0.2'
            subtotal_amount: '100.05'
            exchange_rate: '1.000000'
            converted_amount: '100.05'
            outgoing_amount: '100.05'
            destination_currency: usd
            url: https://dashboard.bridge.xyz/transaction/00000000-0000-0000-0000-000000000000/receipt/00000000-0000-0000-0000-000000000000
    SuccessfulSepaLiquidationAddressGetResponse:
      summary: A successful get response for a SEPA Liquidation Address
      value:
        id: la_123
        chain: ethereum
        customer_id: cust_123
        external_account_id: ext_123
        address: '0x4d0280da2f2fDA5103914bCc5aad114743152A9c'
        currency: usdc
        destination_payment_rail: sepa
        destination_currency: eur
        destination_sepa_reference: a SEPA reference
        state: active
        created_at: '2023-11-22T21:31:30.515Z'
        updated_at: '2023-11-22T21:31:30.515Z'
    SuccessfulSepaLiquidationAddressCreateResponse:
      summary: A creation response using SEPA as the destination rail
      value:
        id: la_123
        chain: ethereum
        customer_id: cust_123
        external_account_id: ext_123
        address: '0x4d0280da2f2fDA5103914bCc5aad114743152A9c'
        currency: usdc
        destination_sepa_reference: SEPA reference
        destination_payment_rail: sepa
        destination_currency: eur
        state: active
        created_at: '2023-11-22T21:31:30.515Z'
        updated_at: '2023-11-22T21:31:30.515Z'
    SuccessfulLiquidationAddressCreateResponse:
      summary: A successful Liquidation Address creation response
      value:
        id: la_123
        chain: ethereum
        customer_id: cust_123
        external_account_id: ext_123
        address: '0x4d0280da2f2fDA5103914bCc5aad114743152A9c'
        currency: usdc
        state: active
        created_at: '2023-11-22T21:31:30.515Z'
        updated_at: '2023-11-22T21:31:30.515Z'
    SuccessfulLiquidationAddressGetResponse:
      summary: A successful get response for a Liquidation Address
      value:
        id: la_123
        chain: ethereum
        customer_id: cust_123
        external_account_id: ext_123
        address: '0x4d0280da2f2fDA5103914bCc5aad114743152A9c'
        currency: usdc
        destination_payment_rail: wire
        destination_currency: usd
        destination_wire_message: a wire message
        state: active
        created_at: '2023-11-22T21:31:30.515Z'
        updated_at: '2023-11-22T21:31:30.515Z'
    SuccessfulLiquidationAddressDrainsToFiatResponse:
      summary: A successful get request for a Liquidation Address's drain to fiat
      value:
        count: 1
        data:
        - id: la_123
          amount: '100.25'
          customer_id: cust_123
          liquidation_address_id: la_456
          currency: usdc
          state: funds_received
          created_at: '2020-01-01T00:00:00.000Z'
          updated_at: '2020-01-01T00:00:00.000Z'
          deposit_tx_hash: '0xc13d7905be5c989378a945487cd2a1193627ae606009e28e296d48ddaec66162'
          destination:
            payment_rail: wire
            currency: usd
            external_account_id: ext_acct_789
            wire_message: a wire message
            imad: '123456'
          receipt:
            initial_amount: '100.25'
            developer_fee: '0.2'
            subtotal_amount: '100.05'
            exchange_rate: '1.000000'
            converted_amount: '100.05'
            outgoing_amount: '100.05'
            destination_currency: usd
            url: https://dashboard.bridge.xyz/transaction/00000000-0000-0000-0000-000000000000/receipt/00000000-0000-0000-0000-000000000000
  schemas:
    TravelRuleWalletAttestedOwnershipAt:
      type: string
      format: date-time
      description: Required when `wallet_type` is `self-custodied` or `hosted`. Must be a timestamp in the past indicating when wallet ownership was attested.
    LiquidationAddressSourceChain:
      type: string
      enum:
      - arbitrum
      - avalanche_c_chain
      - base
      - celo
      - ethereum
      - optimism
      - polygon
      - solana
      - stellar
      - tempo
      - tron
      - evm
    Currency:
      type: string
      enum:
      - usdb
      - usdc
      - usdt
      - usd
      - pyusd
    TransactionStatus:
      type: string
      enum:
      - awaiting_funds
      - in_review
      - funds_received
      - payment_submitted
      - payment_processed
      - canceled
      - error
      - undeliverable
      - returned
      - refund_in_flight
      - refund_failed
      - refunded
    TravelRuleData:
      type: object
      description: Travel Rule data for a crypto movement. Send this on create or update when the same counterparty should apply to every future use of a reusable resource, or send the same payload with `POST /travel_rule_data/{id}` when it belongs to one specific movement.
      properties:
        originator:
          description: The party sending the crypto.
          allOf:
          - $ref: '#/components/schemas/TravelRuleOriginator'
        beneficiary:
          description: The party receiving the crypto.
          allOf:
          - $ref: '#/components/schemas/TravelRuleBeneficiary'
      example:
        originator:
          name: Jane Smith
          address:
            street_line_1: 123 Market St
            street_line_2: null
            city: San Francisco
            state: CA
            postal_code: '94105'
            country: USA
          identifying_information:
            type: national_id
            number: '1234567890'
            issuing_country: USA
          birth_date: '2000-01-31'
          place_of_birth:
            city: San Francisco
            country: USA
          wallet_type: self_custodied
          wallet_attested_ownership_at: '2026-04-01T12:00:00Z'
        beneficiary:
          is_self: true
          wallet_type: external
    EuroInclusiveCurrency:
      type: string
      enum:
      - brl
      - cop
      - eur
      - eurc
      - gbp
      - mxn
      - pyusd
      - usd
      - usdb
      - usdc
      - usdt
    SepaSwiftInclusivePaymentRail:
      type: string
      enum:
      - ach
      - wire
      - ach_push
      - ach_same_day
      - arbitrum
      - avalanche_c_chain
      - base
      - bre_b
      - co_bank_transfer
      - celo
      - ethereum
      - faster_payments
      - fiat_deposit_return
      - optimism
      - pix
      - polygon
      - sepa
      - solana
      - spei
      - stellar
      - swift
      - tempo
      - tron
    DrainReceipt:
      required:
      - initial_amount
      - developer_fee
      - exchange_rate
      - subtotal_amount
      - converted_amount
      - outgoing_amount
      - destination_currency
      properties:
        initial_amount:
          description: The initial amount of the drain, denominated in the fiat currency to which the currency of the Liquidation Address is pegged. Examples include "100.25", "0.1", "1.234567", "1.000000000000000001" etc.
          type: string
        developer_fee:
          description: The developer fee, denominated in the fiat currency to which the currency of the Liquidation Address is pegged. This fee is a specific amount deducted from the initial total before conversion, rather than a percentage.
          type: string
        subtotal_amount:
          description: The initial amount of the drain less the `developer_fee`, denominated in the fiat currency to which the Liquidation Address currency is pegged. Examples include "100.25", "0.1", "1.234567", "1.000000000000000001" etc.
          type: string
        gas_fee:
          description: The fee that is deducted from the withdrawn amount to pay for gas.  Only included for crypto withdrawals that cost gas (e.g. USDT). It's denominated in the fiat currency to which the destination currency is pegged.
          type: string
        converted_amount:
          description: The converted amount of the drain. It's denominated in the destination currency or its pegged fiat currency.
          type: string
        exchange_rate:
          description: The effective exchange rate that can be calculated by dividing the converted amount by the amount available for conversion after deducting the developer fee.
        outgoing_amount:
          description: The final amount of the drain, equal to the `converted_amount` minus any gas fees. It's denominated in the destination currency or its pegged fiat currency.
          type: string
        destination_currency:
          $ref: '#/components/schemas/Currency'
          description: The currency of the fund sent to the customer.
        url:
          description: The URL of a user-facing copy of the receipt.
          type: string
    SepaReference:
      description: A reference message to be sent with a SEPA transaction. We recommend you set a unique value to help you and your customers track payments end to end. It must be from 6 to 140 characters. The allowed characters are `a-z`, `A-Z`, `0-9`, spaces, ampersand (`&`), hyphen (`-`), full stop (`.`), and solidus (`/`). If not populated, the default value is "Payment via Bridge {unique_token}".
      type: string
      minLength: 6
      maxLength: 140
    IdentifyingInformation:
      writeOnly: true
      type: array
      title: Identification Information
      items:
        type: object
        required:
        - issuing_country
        - type
        properties:
          type:
            type: string
            description: 'Tax identification number type or government-issued ID document type (see enum). Country-specific tax and national ID lists: [Individuals](https://apidocs.bridge.xyz/docs/individual-tax-identification-numbers-by-country), [Businesses](https://apidocs.bridge.xyz/docs/business-tax-identification-numbers-by-country).


              **EEA / BBSA (policy in `eea_requirements.rb`):** In-scope individuals and UBOs need **both** a valid national-ID-type entry and a valid TIN per [EEA updated requirements](https://apidocs.bridge.xyz/platform/customers/customers/eea-updated-requirements). In-scope businesses need business registration **and** business tax ID types per country tables there. **TIN issuing country** must match residence (individuals) or incorporation (businesses). **Foreign tax** outside the incorporation country: set `has_foreign_tax_registration` on the business customer and add TIN objects per jurisdiction ([foreign tax / tax residency](https://apidocs.bridge.xyz/platform/customers/customers/eea-updated-requirements#tax-residency-status-foreign-tax-registry)).

              '
            enum:
            - drivers_license
            - matriculate_id
            - military_id
            - national_id
            - passport
            - permanent_residency_id
            - state_or_provincial_id
            - visa
            - abn
            - acn
            - ahv
            - ak
            - aom
            - arbn
            - avs
            - bc
            - bce
            - bin
            - bir
            - bp
            - brn
            - bsn
            - bvn
            - cc
            - cdi
            - cedula_juridica
            - cf
            - cif
            - cin
            - cipc
            - cn
            - cnp
            - cnpj
            - cpf
            - cpr
            - crc
            - crib
            - crn
            - cro
            - cui
            - cuil
            - curp
            - cuit
            - cvr
            - edrpou
            - ein
            - embg
            - emirates_id
            - en
            - fin
            - fn
            - gstin
            - gui
            - hetu
            - hkid
            - hn
            - ic
            - ico
            - id
            - id_broj
            - idno
            - idnp
            - idnr
            - if
            - iin
            - ik
            - inn
            - ird
            - itin
            - itr
            - iva
            - jmbg
            - kbo
            - kvk
            - matricule
            - mf
            - mn
            - ms
            - mst
            - nic
            - nicn
            - nie
            - nif
            - nin
            - nino
            - nip
            - nipc
            - nipt
            - nit
            - npwp
            - nric
            - nrn
            - nrt
            - ntn
            - nuit
            - nzbn
            - oib
            - orgnr
            - other
            - pan
            - partita_iva
            - pesel
            - pib
            - pin
            - pk
            - ppsn
            - qid
            - rc
            - regon
            - rfc
            - ricn
            - rif
            - rn
            - rnc
            - rnokpp
            - rp
            - rrn
            - rtn
            - ruc
            - rut
            - si
            - sin
            - siren
            - siret
            - spi
            - ssm
            - ssn
            - steuer_id
            - strn
           

# --- truncated at 32 KB (63 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/bridge/refs/heads/main/openapi/bridge-liquidation-addresses-api-openapi.yml