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

# Look up a PIX key.

> Utility endpoint to resolve the holder/bank info a PIX key points to,
without registering anything. Useful to preview a destination before
`POST /addresses/pix`.



## OpenAPI

````yaml https://api.sandbox.iron.xyz/spec/2026-08-01 get /pix-key-info
openapi: 3.1.0
info:
  description: The Stablecoin Payment Network
  title: Iron API - Sandbox
  version: '2026-08-01'
servers:
  - url: https://api.sandbox.iron.xyz/api
security: []
tags:
  - description: >-
      Wallet and bank account registration


      Every wallet address that interacts with Iron must be registered (linked)
      to a customer **before** it can be used in any flow — onramp, offramp, or
      swap. This is a regulatory requirement under the **Travel Rule**, which
      obliges Virtual Asset Service Providers to exchange originator and
      beneficiary information for crypto transfers.


      Iron supports two wallet types:


      - **Self-hosted wallets** — the customer controls the private key.
      Registration requires a signed proof-of-ownership message.

      - **Hosted wallets** — the wallet is custodied by another VASP (e.g.
      Coinbase, Kraken). Registration requires the VASP's DID so Iron can
      exchange travel-rule data with the custodian.


      Similarly, fiat bank accounts must be registered before they can receive
      offramp payouts.
    name: Addresses
  - description: Operations on Autoramp
    name: Autoramp
  - description: Operations on Chronicle collateral
    name: ChronicleCollateral
  - description: Operations on Currencies
    name: Currencies
  - description: >-
      Custody wallet, balance, and deposit-address operations, as well as
      transactional data
    name: Custody
  - description: Operations on Customers
    name: Customer
  - description: Operations on Exchange Rate
    name: ExchangeRate
  - description: Operations on Fee Profiles
    name: FeeProfiles
  - description: Operations for Sandbox Testing
    name: Sandbox
  - description: Operations on SSE
    name: Sse
  - description: Operations on Terms and Conditions
    name: TermsAndConditions
  - description: Operations on Webhooks
    name: Webhooks
paths:
  /pix-key-info:
    get:
      tags:
        - Addresses
      summary: Look up a PIX key.
      description: |-
        Utility endpoint to resolve the holder/bank info a PIX key points to,
        without registering anything. Useful to preview a destination before
        `POST /addresses/pix`.
      operationId: getPixKeyInfo
      parameters:
        - deprecated: false
          description: Which PIX key format `pix_key` is
          explode: true
          in: query
          name: pix_key_type
          required: true
          schema:
            $ref: '#/components/schemas/ApiPixKeyType'
        - deprecated: false
          description: The PIX key to resolve, in the format `pix_key_type` declares
          explode: true
          in: query
          name: pix_key
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/XApiVersion'
      responses:
        '200':
          content:
            application/json; charset=utf-8:
              schema:
                $ref: '#/components/schemas/PixKeyInfo'
          description: Lookup succeeded
        '400':
          content:
            application/json; charset=utf-8:
              schema:
                type: string
          description: Bad request (e.g. pix_key doesn't match pix_key_type's format)
        '401':
          description: Unauthorized
        '404':
          content:
            application/json; charset=utf-8:
              schema:
                type: string
          description: The PIX key could not be resolved
        '500':
          content:
            application/json; charset=utf-8:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Failed to look up the PIX key
      security:
        - ApiKeyAuth: []
components:
  schemas:
    ApiPixKeyType:
      description: >-
        PIX Key Type


        Which of the five PIX key formats `pix_key` is, for `GET /pix-key-info`.

        Declared explicitly by the caller rather than guessed from the string's

        shape, mirroring the tags `ApiPixAccountIdentifier` uses at
        registration.
      enum:
        - CPF
        - CNPJ
        - EMAIL
        - PHONE
        - EVP
      type: string
    PixKeyInfo:
      description: |-
        PIX Key Info

        Holder/bank info a PIX key resolves to.
      properties:
        bank_name:
          description: Receiving bank's name
          type: string
        ispb:
          description: 8-digit ISPB bank code
          type: string
        name:
          description: Account holder's full name
          type: string
      required:
        - name
        - bank_name
        - ispb
      title: PixKeyInfo
      type: object
    ApiError:
      description: |-
        Standard error response returned to API clients for server errors.
        Includes a trace_id that clients can reference when reporting issues.
      properties:
        message:
          description: Human-readable error message
          type: string
        trace_id:
          description: Trace ID that can be used to look up request details in logs
          type: string
      required:
        - message
        - trace_id
      title: ApiError
      type: object
  parameters:
    XApiVersion:
      description: >-
        Selects the API version for this request, as an ISO date (`YYYY-MM-DD`).
        Omit to use the default version (`2025-03-13`). Supported versions:
        2025-03-13, 2026-07-01, 2026-08-01.
      in: header
      name: X-API-Version
      required: false
      schema:
        type: string
        x-default: '2026-08-01'
  securitySchemes:
    ApiKeyAuth:
      description: API Key
      in: header
      name: X-API-Key
      type: apiKey

````