> ## 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.

# Get the member flow status

> One read that answers "what should happen next for this member": add a card, create a card, share an approval link, or fetch the open card. Authenticated with the member's connection token from [Verify the code](/companies/api/reference/connect-verify).

One read that answers "what happens next for this member", with the single
`next_action` to take: hand them an add-a-card link, create a card, share an
approval link, or fetch the open card. Poll this between steps instead of
polling [Get a card](/companies/api/reference/member-card-get), which
notifies the member on every credential read.

All member endpoints authenticate with the member's connection token from
[Verify the code](/companies/api/reference/connect-verify), kept fresh with
[Refresh the connection](/companies/api/reference/connect-refresh).


## OpenAPI

````yaml openapi.json GET /api/v2/flow_status
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/flow_status:
    get:
      tags:
        - Member cards
      summary: Get the member flow status
      description: >-
        One read that answers "what should happen next for this member": add a
        card, create a card, share an approval link, or fetch the open card.
        Authenticated with the member's connection token from [Verify the
        code](/companies/api/reference/connect-verify).
      operationId: memberFlowStatus
      responses:
        '200':
          description: The flow status.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FlowStatus'
              example:
                object: flow_status
                status: ready
                next_action:
                  type: create_card
                attached_cards:
                  - id: ca_123
                    status: active
                    network: visa
                    brand: Visa
                    last4: '4242'
                    art_url: null
        '401':
          $ref: '#/components/responses/Unauthorized'
      security:
        - userAccessToken: []
components:
  schemas:
    FlowStatus:
      type: object
      description: >-
        Where this member is in the add-a-card -> create-a-card flow, with the
        one next action.
      properties:
        object:
          type: string
          example: flow_status
        status:
          type: string
          enum:
            - no_card_attached
            - attach_pending
            - attach_failed
            - ready
            - approval_pending
            - card_ready
        next_action:
          type: object
          nullable: true
          properties:
            type:
              type: string
              enum:
                - attach_card
                - create_card
                - share_approval_url
                - get_card
            id:
              type: string
            url:
              type: string
              description: >-
                The link to hand the member (add-a-card page, or the approval
                page).
            expires_at:
              type: string
              format: date-time
        attached_cards:
          type: array
          items:
            $ref: '#/components/schemas/AttachedCard'
        card:
          $ref: '#/components/schemas/MemberCard'
        reason:
          type: string
          description: 'Only on `attach_failed`: the ineligible reason.'
        message:
          type: string
          description: 'Only on `attach_failed`: human-readable copy for the member.'
    AttachedCard:
      type: object
      description: A card the member added to their wallet (an attachment).
      properties:
        id:
          type: string
          description: The attachment id.
        status:
          type: string
          enum:
            - pending
            - active
            - ineligible
            - revoked
        network:
          type: string
          nullable: true
          example: visa
        brand:
          type: string
          nullable: true
        last4:
          type: string
          nullable: true
        art_url:
          type: string
          nullable: true
          description: The issuing bank's card art, when the network provides it.
    MemberCard:
      type: object
      description: A one-time virtual card created against the member's added card.
      properties:
        object:
          type: string
          example: card
        id:
          type: string
        status:
          type: string
          enum:
            - approval_pending
            - open
            - in_use
            - paused
            - closed
          description: >-
            Envelope status. `open` carries credentials; `approval_pending`
            carries `approval_url`.
        spend_limit_cents:
          type: integer
        balance_cents:
          type: integer
        connected_card_id:
          type: string
          nullable: true
          description: The attachment this card draws on.
        last4:
          type: string
        expiry:
          type: string
          example: 12/30
        created_at:
          type: string
          format: date-time
        approval_url:
          type: string
          description: >-
            Only while `approval_pending`: the page where the member approves
            this purchase with a passkey.
        expires_at:
          type: string
          format: date-time
          description: 'Only while `approval_pending`: when the approval window closes.'
        closed_reason:
          type: string
          description: 'Only when `closed`: `used`, `canceled`, `expired`, or `declined`.'
        credentials:
          type: object
          description: >-
            Only on an `open` card: the one-time credential to key into a
            checkout. Never persist it.
          properties:
            number:
              type: string
            exp_month:
              type: integer
              nullable: true
            exp_year:
              type: integer
              nullable: true
            cvc:
              type: string
        credentials_status:
          type: string
          description: >-
            `protected` when the member requires an approval per reveal; `retry`
            when the credential read should be retried.
    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.
    userAccessToken:
      type: http
      scheme: bearer
      description: >-
        The user's connection access_token (user authentication), or an
        org-minted buy_token for org-owned accounts.

````