Disconnect a user

curl -X DELETE https://api.agentcard.sh/api/v2/vault_users/usr_8f3k2m/connection \
  -H "Authorization: Bearer $ORG_TOKEN"

{
  "object": "vault_user_connection",
  "user_id": "usr_8f3k2m",
  "connected": false,
  "revoked_tokens": 2,
  "revoked_wallet_links": 0,
  "revoked_sessions": 1,
  "test_mode": false
}

DELETE

api

vault_users

{user_id}

connection

curl -X DELETE https://api.agentcard.sh/api/v2/vault_users/usr_8f3k2m/connection \
  -H "Authorization: Bearer $ORG_TOKEN"

{
  "object": "vault_user_connection",
  "user_id": "usr_8f3k2m",
  "connected": false,
  "revoked_tokens": 2,
  "revoked_wallet_links": 0,
  "revoked_sessions": 1,
  "test_mode": false
}

Call it when the user asks your app to forget them. Every token your app holds for the user stops working, links you sent them stop opening, and the user’s cards stay in their Vault.

curl -X DELETE https://api.agentcard.sh/api/v2/vault_users/usr_8f3k2m/connection \
  -H "Authorization: Bearer $ORG_TOKEN"

{
  "object": "vault_user_connection",
  "user_id": "usr_8f3k2m",
  "connected": false,
  "revoked_tokens": 2,
  "revoked_wallet_links": 0,
  "revoked_sessions": 1,
  "test_mode": false
}

After the call, List a user’s vaulted cards answers 404 connection_not_found for the user, and a checkout authorization for them is refused. To work with the user again, send them a new vault session. Call it as often as you like. A second call answers 200 with every count at 0.

Errors

A user your app never connected is refused, so the call tells you nothing about anyone else’s users:

HTTP 404
{
  "error": {
    "code": "connection_not_found",
    "message": "No production connection exists for that user under this client.",
    "docs": "https://docs.agentcard.sh"
  }
}

The tokens stop working before the user’s auto-approval for your app does. While the second half is still in flight, the call answers:

HTTP 503
{
  "error": {
    "code": "partner_disconnect_pending",
    "message": "The connection is off. The payment authority has not confirmed yet: call again to check.",
    "docs": "https://docs.agentcard.sh"
  }
}

Code	Meaning	What to do
`404 connection_not_found`	Your app holds no connection to that user in this mode.	Check the `user_id`, and that you called with the token of the mode the user connected in.
`503 partner_disconnect_pending`	The tokens are off. The user’s auto-approval for your app is not yet.	Call again until it answers `200`. The tokens stay off either way.

Deleting one vault session with DELETE /api/v2/vault_sessions/{id} ends only that link and the token it gave you. The user stays connected to your app.

Authorizations

Authorization

string

header

required

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.

Path Parameters

user_id

string

required

The user's id, as your app stored it when they connected.

Maximum string length: 64

Response

The user is disconnected from your app.

object

enum<string>

Available options:

vault_user_connection

user_id

string

connected

enum<boolean>

Available options:

false

revoked_tokens

integer

Tokens your app held for the user that stopped working on this call.

revoked_wallet_links

integer

Wallet links your app sent the user that stopped working on this call.

revoked_sessions

integer

Vault session links the user had not opened yet. A disconnected user who taps one gets nothing.

test_mode

boolean

Overview

Access tokens

Connections

Vault

Purchases

Cards

Identity verification

Webhook endpoints

Blooio connection

Errors

Authorizations

Path Parameters

Response

​Errors

Authorizations

Path Parameters

Response

Errors