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

# Get the client's details

> Retrieves the details of the current client, including information about
associated wallets, backup share pairs, and signing share pairs.




## OpenAPI

````yaml /openapi/client-api.yaml get /clients/me
openapi: 3.1.0
info:
  title: Portal Client API
  version: '3.0'
  description: >
    The Portal Client API provides endpoints for managing wallets, building
    transactions,

    and interacting with blockchain networks. All endpoints require
    authentication via a

    Client API Key or Client Session Token (CST) passed as a Bearer token.


    ## Base URL

    `https://api.portalhq.io/api/v3`


    ## Authentication

    Include your Client API Key or Client Session Token as a Bearer token in the

    `Authorization` header of every request.


    ## Chain ID Format

    Chain parameters use either friendly names (e.g. `ethereum`, `solana`) or
    CAIP-2 format

    (e.g. `eip155:1`, `solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp`). When using
    CAIP-2 format

    in URLs, ensure the colon is URI-encoded (`%3A`).
servers:
  - url: https://api.portalhq.io/api/v3
    description: Production
security:
  - bearerAuth: []
tags:
  - name: Clients
    description: Core client management endpoints
  - name: Wallet
    description: >-
      Read wallet state — balances, NFTs, transaction history, capabilities, and
      transaction details
  - name: Transactions
    description: Build, broadcast, and evaluate blockchain transactions
  - name: Funding
    description: Fund wallets with testnet tokens
  - name: Wallet Shares
    description: Manage signing and backup share pairs
  - name: Delegations
    description: Manage token approvals, revocations, and delegated transfers
  - name: Session Keys
    description: Manage EIP-7702 session keys for smart accounts
  - name: 0x
    description: Token swap endpoints powered by the 0x protocol
  - name: Yield.xyz
    description: Yield opportunities and staking actions powered by Yield.xyz
  - name: Li.Fi
    description: Cross-chain swaps and bridging powered by Li.Fi
  - name: Blockaid
    description: Transaction and address security scanning powered by Blockaid
  - name: Hypernative
    description: >-
      Transaction, address, token, and NFT security scanning powered by
      Hypernative
  - name: Noah
    description: KYC onboarding, payins, and payouts powered by Noah
  - name: Meld
    description: Buy and sell crypto with fiat through aggregated providers powered by Meld
  - name: EIP-7702
    description: EIP-7702 account type detection and authorization management
  - name: Deprecated
    description: >-
      Legacy endpoints scheduled for removal. Use the newer equivalents listed
      in each endpoint's description.
paths:
  /clients/me:
    get:
      tags:
        - Clients
      summary: Get the client's details
      description: |
        Retrieves the details of the current client, including information about
        associated wallets, backup share pairs, and signing share pairs.
      operationId: getClientDetails
      responses:
        '200':
          description: Client details retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClientDetails'
              example:
                createdAt: '2024-04-16T21:15:06.443Z'
                custodian:
                  id: custodianId
                  name: Custodian Name
                ejectedAt: null
                environment:
                  id: environmentId
                  name: Development
                  backupWithPortalEnabled: true
                  isMultiBackupEnabled: false
                id: clientId
                isAccountAbstracted: false
                metadata:
                  namespaces:
                    eip155:
                      address: '0x0f3f5cea9784e254972d915695dbc9bc2a395faf'
                      curve: SECP256K1
                    solana:
                      address: BrGo1hFAL8MpudNQ6K4YWDaFB838uboUcCpm8C9uyC4R
                      curve: ED25519
                    bip122:
                      address: ''
                      curve: SECP256K1
                      bitcoin:
                        p2wpkh:
                          mainnet: bc1qpl54na90wlmdxj5z4wtz7cpp6p32dc9th54w0m
                          testnet: tb1qpl54na90wlmdxj5z4wtz7cpp6p32dc9tajwa5g
                    stellar:
                      address: GCQTIL5333ASTDBXAJYDIAFRWXYGMR2KPGUNIDNSHOMBINTAMPZJFOKT
                      curve: ED25519
                    tron:
                      address: TBMq3UK8JNvauSc7sPUp7fkoSzTN4PZhP2
                      curve: SECP256K1
                wallets:
                  - createdAt: '2024-04-16T21:15:45.144Z'
                    curve: SECP256K1
                    id: walletId
                    ejectableUntil: null
                    publicKey: '{"x":"...","y":"..."}'
                    backupSharePairs:
                      - backupMethod: PASSWORD
                        createdAt: '2024-04-16T21:15:45.144Z'
                        id: backupSharePairId
                        status: completed
                    signingSharePairs:
                      - createdAt: '2024-04-16T21:15:45.144Z'
                        id: signingSharePairId
                        status: completed
        '400':
          description: Bad request - client, custodian, or environment not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized - invalid or missing authentication token
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  schemas:
    ClientDetails:
      type: object
      properties:
        createdAt:
          type: string
          format: date-time
          description: When the client was created
        custodian:
          type: object
          properties:
            id:
              type: string
              description: Custodian ID
            name:
              type: string
              description: Custodian name
        ejectedAt:
          type: string
          format: date-time
          nullable: true
          description: When the client was ejected, or null if not ejected
        environment:
          type: object
          properties:
            id:
              type: string
              description: Environment ID
            name:
              type: string
              description: Environment name (e.g. "Development", "Production")
            backupWithPortalEnabled:
              type: boolean
              description: Whether Portal-managed backups are enabled
            isMultiBackupEnabled:
              type: boolean
              description: Whether multi-backup is enabled
        id:
          type: string
          description: Client ID
        isAccountAbstracted:
          type: boolean
          description: Whether the client uses account abstraction (EIP-7702)
        metadata:
          type: object
          properties:
            namespaces:
              type: object
              description: >
                Chain-keyed map of wallet addresses and metadata. Keys are chain

                namespaces (e.g. `eip155`, `solana`, `bip122`, `stellar`,
                `tron`).
              additionalProperties:
                type: object
                properties:
                  address:
                    type: string
                    description: Wallet address on this chain
                  curve:
                    type: string
                    enum:
                      - SECP256K1
                      - ED25519
                    description: Cryptographic curve used for this chain
        wallets:
          type: array
          items:
            $ref: '#/components/schemas/Wallet'
    ErrorResponse:
      type: object
      properties:
        error:
          type: string
          description: Error message describing what went wrong
    Wallet:
      type: object
      properties:
        createdAt:
          type: string
          format: date-time
        curve:
          type: string
          enum:
            - SECP256K1
            - ED25519
          description: Cryptographic curve
        id:
          type: string
          description: Wallet ID
        ejectableUntil:
          type: string
          format: date-time
          nullable: true
          description: Deadline until which the wallet can be ejected, or null
        publicKey:
          type: string
          nullable: true
          description: JSON-stringified public key
        backupSharePairs:
          type: array
          items:
            $ref: '#/components/schemas/BackupSharePair'
        signingSharePairs:
          type: array
          items:
            $ref: '#/components/schemas/SigningSharePair'
    BackupSharePair:
      type: object
      properties:
        backupMethod:
          type: string
          enum:
            - CUSTOM
            - GDRIVE
            - ICLOUD
            - PASSWORD
            - PASSKEY
            - UNKNOWN
          description: Backup method used
        createdAt:
          type: string
          format: date-time
        id:
          type: string
          description: Backup share pair ID
        status:
          type: string
          enum:
            - completed
            - incomplete
            - STORED_CLIENT_BACKUP_SHARE
            - STORED_CLIENT_BACKUP_SHARE_KEY
            - STORED_CUSTODIAN_BACKUP_SHARE
            - UNKNOWN
          description: Current status of the backup share pair
    SigningSharePair:
      type: object
      properties:
        createdAt:
          type: string
          format: date-time
        id:
          type: string
          description: Signing share pair ID
        status:
          type: string
          enum:
            - completed
            - incomplete
            - STORED_DATABASE
            - STORED_CLIENT
          description: Current status of the signing share pair
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >
        Client API Key or Client Session Token (CST). Pass as a Bearer token in
        the

        Authorization header.

````