Skip to main content
GET
Get the member flow status
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, which notifies the member on every credential read. All member endpoints authenticate with the member’s connection token from Verify the code, kept fresh with Refresh the connection.

Authorizations

Authorization
string
header
required

The user's connection access_token (user authentication), or an org-minted buy_token for org-owned accounts.

Response

The flow status.

Where this member is in the add-a-card -> create-a-card flow, with the one next action.

object
string
Example:

"flow_status"

status
enum<string>
Available options:
no_card_attached,
attach_pending,
attach_failed,
ready,
approval_pending,
card_ready
next_action
object | null
attached_cards
object[]
card
object

A one-time virtual card created against the member's added card.

reason
string

Only on attach_failed: the ineligible reason.

message
string

Only on attach_failed: human-readable copy for the member.