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

# Get customer abilities

> Retrieve the abilities/capabilities for a specific customer by ID




## OpenAPI

````yaml /spec.yaml get /customers/{id}/abilities
openapi: 3.1.0
info:
  description: The Stablecoin Payment Network
  title: Iron API - Sandbox
  version: 1.0-17078
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: 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:
  /customers/{id}/abilities:
    get:
      tags:
        - Customer
      summary: Get customer abilities
      description: |
        Retrieve the abilities/capabilities for a specific customer by ID
      operationId: getCustomerAbilities
      parameters:
        - deprecated: false
          description: >-
            Optional sub-partner UUID, if provided, the customer will be
            filtered for the sub-partner
          explode: true
          in: header
          name: X-SUB-PARTNER-ID
          required: false
          schema:
            type: string
        - deprecated: false
          description: the ID of the Customer to GET abilities for
          explode: true
          in: path
          name: id
          required: true
          schema:
            format: uuid
            type: string
        - $ref: '#/components/parameters/XApiVersion'
      responses:
        '200':
          content:
            application/json; charset=utf-8:
              schema:
                $ref: '#/components/schemas/CustomerAbilities'
          description: GET Customer Abilities Succeeded
        '401':
          content:
            application/json; charset=utf-8:
              schema:
                type: string
          description: GET Customer Abilities Failed (Unauthorized)
        '404':
          content:
            application/json; charset=utf-8:
              schema:
                type: string
          description: GET Customer Abilities Failed (Not Found)
        '500':
          content:
            application/json; charset=utf-8:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: GET Customer Abilities Failed (Internal Error)
      security:
        - ApiKeyAuth: []
components:
  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.
      in: header
      name: X-API-Version
      required: false
      schema:
        type: string
  schemas:
    CustomerAbilities:
      description: |
        Customer Abilities

        Represents the abilities/capabilities that a customer has
      properties:
        currencies:
          description: >-
            What the customer can do with each currency (mint / redeem / onramp
            /

            offramp / swap). Only currencies the customer can currently use are
            listed.
          items:
            $ref: '#/components/schemas/CurrencyAbility'
          type: array
        fiat_deposit:
          $ref: '#/components/schemas/ApiFiatAbilities'
        fiat_payout:
          $ref: '#/components/schemas/ApiFiatAbilities'
      required:
        - fiat_deposit
        - fiat_payout
        - currencies
      title: CustomerAbilities
      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
    CurrencyAbility:
      description: >-
        What a customer can do with a single currency.


        `currency` reuses the shared `ApiCurrency` type; `flows` reuses
        `AutorampType`.

        The flow rules live in `currency_abilities.rs` (assembled there).
      properties:
        counterparts:
          description: >-
            Valid mint/redeem counterpart currencies (the other side of the
            pair).

            Populated only for mint-only brand tokens (PYUSDx, M0 extensions);
            empty

            for every other currency. Mint and redeem are symmetric — same set.
          items:
            $ref: '#/components/schemas/Currency'
          type: array
        currency:
          $ref: '#/components/schemas/Currency'
        flows:
          description: The flows available for this currency.
          items:
            $ref: '#/components/schemas/AutorampType'
          type: array
      required:
        - currency
        - flows
        - counterparts
      title: CurrencyAbility
      type: object
    ApiFiatAbilities:
      description: |-
        Fiat rails
        Customer's ability to use fiat deposit and payout rails
      properties:
        eur:
          $ref: '#/components/schemas/EurAbilities'
        gbp:
          $ref: '#/components/schemas/GbpAbilities'
        usd:
          $ref: '#/components/schemas/UsdAbilities'
      required:
        - eur
        - gbp
        - usd
      title: ApiFiatAbilities
      type: object
    Currency:
      anyOf:
        - $ref: '#/components/schemas/Currency_Crypto'
        - $ref: '#/components/schemas/Currency_Fiat'
      description: |
        Currency

        Can be either crypto or fiat
      discriminator:
        mapping:
          Crypto:
            $ref: '#/components/schemas/Currency_Crypto'
          Fiat:
            $ref: '#/components/schemas/Currency_Fiat'
        propertyName: type
      type: object
    AutorampType:
      description: |-
        Autoramp type

        The type (onramp, offramp, swap) of an autoramp
      enum:
        - Onramp
        - Offramp
        - Swap
        - Mint
        - Redeem
      type: string
    EurAbilities:
      properties:
        sepa:
          $ref: '#/components/schemas/AbilityStatus'
        sepa_thirdparty:
          $ref: '#/components/schemas/AbilityStatus'
        swift:
          $ref: '#/components/schemas/AbilityStatus'
        swift_thirdparty:
          $ref: '#/components/schemas/AbilityStatus'
      required:
        - sepa
        - sepa_thirdparty
        - swift
        - swift_thirdparty
      title: EurAbilities
      type: object
    GbpAbilities:
      properties:
        chaps:
          $ref: '#/components/schemas/AbilityStatus'
        chaps_thirdparty:
          $ref: '#/components/schemas/AbilityStatus'
        fps:
          $ref: '#/components/schemas/AbilityStatus'
        fps_thirdparty:
          $ref: '#/components/schemas/AbilityStatus'
        swift:
          $ref: '#/components/schemas/AbilityStatus'
        swift_thirdparty:
          $ref: '#/components/schemas/AbilityStatus'
      required:
        - fps
        - fps_thirdparty
        - chaps
        - chaps_thirdparty
        - swift
        - swift_thirdparty
      title: GbpAbilities
      type: object
    UsdAbilities:
      properties:
        ach:
          $ref: '#/components/schemas/AbilityStatus'
        ach_thirdparty:
          $ref: '#/components/schemas/AbilityStatus'
        fednow:
          $ref: '#/components/schemas/AbilityStatus'
        fednow_thirdparty:
          $ref: '#/components/schemas/AbilityStatus'
        rtp:
          $ref: '#/components/schemas/AbilityStatus'
        rtp_thirdparty:
          $ref: '#/components/schemas/AbilityStatus'
        swift:
          $ref: '#/components/schemas/AbilityStatus'
        swift_thirdparty:
          $ref: '#/components/schemas/AbilityStatus'
        wire:
          $ref: '#/components/schemas/AbilityStatus'
        wire_thirdparty:
          $ref: '#/components/schemas/AbilityStatus'
      required:
        - ach
        - ach_thirdparty
        - wire
        - wire_thirdparty
        - swift
        - swift_thirdparty
        - rtp
        - rtp_thirdparty
        - fednow
        - fednow_thirdparty
      title: UsdAbilities
      type: object
    Currency_Crypto:
      allOf:
        - properties:
            type:
              enum:
                - Crypto
              example: Crypto
              type: string
          required:
            - type
          type: object
        - $ref: '#/components/schemas/Crypto'
      description: |
        Currency

        Can be either crypto or fiat
    Currency_Fiat:
      allOf:
        - properties:
            type:
              enum:
                - Fiat
              example: Fiat
              type: string
          required:
            - type
          type: object
        - $ref: '#/components/schemas/Fiat'
      description: |
        Currency

        Can be either crypto or fiat
    AbilityStatus:
      description: The current status of the ability
      enum:
        - Active
        - Pending
        - Unavailable
        - Blocked
        - Maintenance
      type: string
    Crypto:
      description: A cryptocurrency
      example:
        blockchain: Solana
        token: USDC
      properties:
        blockchain:
          $ref: '#/components/schemas/Blockchain'
        token:
          description: The ticker of the token e.g. 'USDC'
          type: string
      required:
        - token
        - blockchain
      title: Crypto
      type: object
    Fiat:
      description: A fiat currency
      example:
        code: USD
      properties:
        code:
          description: The code of the currency e.g. 'USD'
          type: string
      required:
        - code
      title: Fiat
      type: object
    Blockchain:
      description: |
        Blockchain

        A type of blockchain
      enum:
        - Solana
        - Ethereum
        - Polygon
        - Arbitrum
        - Base
        - Stellar
        - Citrea
        - Plasma
        - Avalanche
        - Moca
        - Tempo
        - Tron
        - Bsc
      type: string
  securitySchemes:
    ApiKeyAuth:
      description: API Key
      in: header
      name: X-API-Key
      type: apiKey

````