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

# Get Subaccount

> Retrieve the details of a specific subaccount using its ID.



## OpenAPI

````yaml /api-reference/openapi.json get /v1/ramp/subaccount/{subaccountId}
openapi: 3.0.0
info:
  title: Bullring Finance API
  description: >-
    The Bullring Finance API allows you to build powerful cross-border payment
    solutions.
  version: 1.0.0
servers:
  - url: https://api.bullring.finance
    description: Production Server
  - url: https://staging-api.bullring.finance
    description: Sandbox Server
security:
  - x-api-key: []
tags:
  - name: Subaccounts
    description: Operations related to user subaccounts.
  - name: Verification
    description: Endpoints for subaccount verification, including KYC and KYB processes.
  - name: Balances
    description: Endpoints for retrieving account balances.
  - name: Deposits
    description: Endpoints for handling deposits into subaccounts.
  - name: Recipients
    description: Manage payment recipients for withdrawals.
  - name: Withdrawals
    description: Endpoints for handling withdrawals from subaccounts.
  - name: Conversions
    description: Endpoints for currency conversions.
  - name: Rates
    description: Endpoints for currency conversion rates.
  - name: Fees
    description: Endpoints for checking transaction fees.
  - name: Offramp
    description: Endpoints for handling offramp operations.
  - name: Onramp
    description: Endpoints for handling onramp operations.
paths:
  /v1/ramp/subaccount/{subaccountId}:
    get:
      tags:
        - Subaccounts
      summary: Get Subaccount
      description: Retrieve the details of a specific subaccount using its ID.
      parameters:
        - name: subaccountId
          in: path
          schema:
            type: string
            format: uuid
            example: 6a0fd7af-181d-4c0f-b24b-b8cfb739d67a
          required: true
          description: The unique identifier of the subaccount
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                    format: uuid
                    description: Unique identifier for the subaccount
                  email:
                    type: string
                    format: email
                    description: Email address of the subaccount
                  status:
                    type: string
                    description: Current status of the subaccount
                    enum:
                      - created
                      - approved
                      - review
                  createdAt:
                    type: string
                    format: date-time
                    description: Subaccount creation timestamp
                  firstName:
                    type: string
                    nullable: true
                    description: First name of the subaccount holder
                  lastName:
                    type: string
                    nullable: true
                    description: Last name of the subaccount holder
                  phone:
                    type: string
                    nullable: true
                    description: Phone number of the subaccount holder
                  type:
                    type: string
                    description: Type of the subaccount
                    enum:
                      - individual
                      - business
                  kyc:
                    type: object
                    description: KYC verification status across different countries
                    properties:
                      profiles:
                        type: array
                        items:
                          type: object
                          properties:
                            country:
                              type: string
                              description: ISO 3166-1 alpha-2 country code
                            status:
                              type: string
                              description: KYC verification status for this country
                              enum:
                                - pending
                                - approved
                                - rejected
                  capabilities:
                    type: object
                    description: Available capabilities for this subaccount
                    properties:
                      currencies:
                        type: object
                        description: >-
                          Per-currency capability details. Each key is a
                          currency code.
                        additionalProperties:
                          type: object
                          properties:
                            status:
                              type: string
                              description: Currency access status
                              enum:
                                - approved
                                - locked
                                - pending
                            canOnramp:
                              type: boolean
                              description: >-
                                Whether the subaccount can convert crypto to
                                this currency
                            canOfframp:
                              type: boolean
                              description: >-
                                Whether the subaccount can convert this currency
                                to crypto
                            canDeposit:
                              type: boolean
                              description: >-
                                Whether the subaccount can receive deposits in
                                this currency
                            canWithdraw:
                              type: boolean
                              description: >-
                                Whether the subaccount can withdraw in this
                                currency
                            requiredKyc:
                              type: string
                              description: >-
                                Description of additional KYC required to unlock
                                this currency
                            rails:
                              type: object
                              description: >-
                                Available payment rails for this currency. Each
                                key is a rail name and the value indicates
                                availability.
                              additionalProperties:
                                type: boolean
                            requiredActions:
                              type: array
                              description: >-
                                Actions the user must complete to unlock this
                                currency
                              items:
                                type: object
                                properties:
                                  type:
                                    type: string
                                    description: Type of required action
                                    enum:
                                      - kyc
                                  description:
                                    type: string
                                    description: >-
                                      Human-readable description of the required
                                      action
                                  url:
                                    type: string
                                    format: uri
                                    description: URL to complete the required action
                      assets:
                        type: object
                        description: >-
                          Supported crypto assets and their available networks.
                          Each key is an asset symbol.
                        additionalProperties:
                          type: object
                          properties:
                            networks:
                              type: array
                              description: Blockchain networks available for this asset
                              items:
                                type: string
              example:
                id: a2e211aa-72d6-4ac2-a9ad-9bde8a77a3c3
                email: johnanisere+9056@gmail.com
                status: approved
                createdAt: '2025-07-18T17:46:05.150Z'
                firstName: null
                lastName: null
                phone: null
                type: individual
                kyc:
                  profiles:
                    - country: GH
                      status: approved
                    - country: ZM
                      status: approved
                    - country: BR
                      status: approved
                capabilities:
                  currencies:
                    USD:
                      status: locked
                      canOnramp: false
                      canOfframp: false
                      canDeposit: false
                      canWithdraw: false
                      requiredKyc: Additional Verification required for USD operations
                      rails:
                        wire: false
                        ach: false
                        swift: false
                      requiredActions:
                        - type: kyc
                          description: Complete verification
                          url: https://in.sumsub.com/websdk/p/0k9A7pIrtmbDR4PD
                    NGN:
                      status: locked
                      canOnramp: false
                      canOfframp: false
                      canDeposit: false
                      canWithdraw: false
                      requiredKyc: Additional Verification required for NGN operations
                      rails:
                        banktransfer: false
                      requiredActions:
                        - type: kyc
                          description: Complete verification
                          url: https://in.sumsub.com/websdk/p/0k9A7pIrtmbDR4PD
                    BRL:
                      status: approved
                      canOnramp: true
                      canOfframp: true
                      canDeposit: true
                      canWithdraw: true
                      rails:
                        pix: true
                    EUR:
                      status: locked
                      canOnramp: false
                      canOfframp: false
                      canDeposit: false
                      canWithdraw: false
                      requiredKyc: Additional Verification required for EUR operations
                      rails:
                        sepa: false
                      requiredActions:
                        - type: kyc
                          description: Complete verification
                          url: https://in.sumsub.com/websdk/p/0k9A7pIrtmbDR4PD
                    GHS:
                      status: approved
                      canOnramp: true
                      canOfframp: true
                      canDeposit: true
                      canWithdraw: true
                      rails:
                        momo: true
                    ZMW:
                      status: approved
                      canOnramp: true
                      canOfframp: true
                      canDeposit: true
                      canWithdraw: true
                      rails:
                        momo: true
                    AED:
                      status: locked
                      canOnramp: false
                      canOfframp: false
                      canDeposit: false
                      canWithdraw: false
                      requiredKyc: Additional Verification required for AED operations
                      rails:
                        uaefts: false
                      requiredActions:
                        - type: kyc
                          description: Complete verification
                          url: https://in.sumsub.com/websdk/p/0k9A7pIrtmbDR4PD
                    USDCARD:
                      status: approved
                      canOnramp: true
                      canOfframp: true
                      canDeposit: true
                      canWithdraw: true
                      rails: {}
                  assets:
                    USDT:
                      networks:
                        - ETH
                        - SOL
                        - CELO
                    USDC:
                      networks:
                        - ETH
                        - SOL
                        - CELO
                        - POLY
                    EURC:
                      networks:
                        - ETH
                        - SOL
                        - CELO
                    BTC:
                      networks:
                        - LIGHTNING
        '401':
          description: Unauthorized - Invalid or missing API key
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  message:
                    type: string
              example:
                error: Unauthorized
                message: Invalid or missing API key
        '403':
          description: Forbidden - Insufficient permissions
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  message:
                    type: string
              example:
                error: Forbidden
                message: You do not have permission to access this resource
        '404':
          description: Not Found - Subaccount not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  message:
                    type: string
              example:
                error: Not Found
                message: Subaccount not found
components:
  securitySchemes:
    x-api-key:
      type: apiKey
      in: header
      name: x-api-key

````