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

# Get a user's balance

> Read what a user can spend from their own balance.

What one user can spend from their own balance.


## OpenAPI

````yaml openapi.json GET /api/v2/wallet
openapi: 3.1.0
info:
  title: Agentcard API
  version: 2.0.0
  description: >-
    The Agentcard v2 API — connect your users and verify their identity from
    your own backend. Every call is authenticated with a platform access token
    minted from your `client_id` + `client_secret`.
servers:
  - url: https://api.agentcard.sh
    description: >-
      There is one base URL. Sandbox vs production is decided by the client
      credential you use, never by the host.
security:
  - platformToken: []
tags:
  - name: Authentication
    description: >-
      Exchange your client credentials for a platform access token, and
      introspect what a token acts as.
  - name: Connect
    description: >-
      Connect a user to your platform: send a one-time code, verify it, record
      consent, and keep the connection alive.
  - name: Identity verification
    description: >-
      Verify a connected user's identity: upload their ID, submit any extra
      fields we ask for, then show a short face scan.
paths:
  /api/v2/wallet:
    get:
      tags:
        - User balance
      summary: Get a user's balance
      description: What one user can spend from their own balance.
      operationId: walletGet
      parameters:
        - name: user_id
          in: query
          required: true
          description: The connected user.
          schema:
            type: string
      responses:
        '200':
          description: The user's balance.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserWallet'
        '400':
          description: '`invalid_request`: `user_id` is missing.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          description: '`connection_not_found`: no connection for that user in this mode.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - platformToken: []
components:
  schemas:
    UserWallet:
      type: object
      required:
        - object
        - user_id
        - status
      properties:
        object:
          type: string
          description: Always `wallet`.
          enum:
            - wallet
        user_id:
          type: string
          description: The connected user.
        livemode:
          type: boolean
          description: '`false` on a sandbox user.'
        spending_power_usdc:
          type: string
          description: What the user can spend, in dollars.
        status:
          type: string
          description: '`active` once the balance can be used.'
    Error:
      type: object
      description: Every v2 error uses the same envelope.
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              description: A stable, machine-readable string (snake_case). Branch on this.
            message:
              type: string
              description: A human-readable explanation, safe to log.
            docs:
              type: string
              description: A link back to the reference.
            field_errors:
              type: object
              additionalProperties:
                type: string
              description: Only on `invalid_fields` — names each field to fix.
            warnings:
              type: array
              items:
                type: string
              description: >-
                Only on document upload errors — actionable feedback safe to
                show the user.
  responses:
    Unauthorized:
      description: >-
        `unauthorized` — the platform access token is missing or expired.
        Exchange your client credentials for a fresh one.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    platformToken:
      type: http
      scheme: bearer
      description: >-
        A platform access token. Get one on the **Create an access token**
        endpoint by exchanging your `client_id` + `client_secret`, then send it
        as `Authorization: Bearer <token>`. Tokens live one hour.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.