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

# Introspect credential

> Returns the organization and mode your token acts as. Useful as a health check and to confirm you're pointed at the right credential.



## OpenAPI

````yaml openapi.json GET /api/v2
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.
  - name: Wallet funding
    description: >-
      Fund a connected user's wallet from your own UI — request a payment link,
      relay the phone verification code, and poll until the funds land.
  - name: Withdrawals
    description: >-
      Move money out of a connected user's wallet — to a saved bank account or a
      crypto address on Base. Transfers are processed manually by the Agentcard
      team, usually within 1-3 business days.
paths:
  /api/v2:
    get:
      tags:
        - Authentication
      summary: Introspect credential
      description: >-
        Returns the organization and mode your token acts as. Useful as a health
        check and to confirm you're pointed at the right credential.
      operationId: introspectCredential
      responses:
        '200':
          description: The organization and mode behind the token.
          content:
            application/json:
              schema:
                type: object
                properties:
                  object:
                    type: string
                    enum:
                      - api_v2
                  organization_id:
                    type: string
                    description: The organization the token belongs to.
                  test_mode:
                    type: boolean
                    description: >-
                      `true` when the token acts in test mode, `false` in
                      production. Decided by the client the token was minted
                      from. Prefer this over the deprecated `mode` field.
                  mode:
                    type: string
                    enum:
                      - sandbox
                      - production
                    deprecated: true
                    description: >-
                      Deprecated — `sandbox` is the legacy wire name for test
                      mode; read `test_mode` instead. Kept unchanged so existing
                      integrations never break.
                required:
                  - object
                  - organization_id
                  - test_mode
              example:
                object: api_v2
                organization_id: org_a1b2c3
                mode: sandbox
                test_mode: true
        '401':
          $ref: '#/components/responses/Unauthorized'
components:
  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'
  schemas:
    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.
  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.

````