Get a vault item, its currently available operations, and optionally expanded live data

The response advertises operations that are valid in the item’s current state and live data that can be requested through expand. Read each operation’s description before using it. Expanded data is fetched from the provider and is not persisted in the vault item. Requesting an unavailable expansion returns 409 instead of a partial item. Pending credential items return a collection action. Kernel-hosted active collection links are renewed atomically on expiry for ready or pending items without changing the item version. Invoke collect to open a form for a ready item without clearing values. Sensitive credential values are never returned.

GET /vaults/{id_or_name}/items/{key}

Get a vault item, its currently available operations, and optionally expanded live data

cURL

curl --request GET \
  --url https://api.onkernel.com/vaults/{id_or_name}/items/{key} \
  --header 'Authorization: Bearer <token>'

200

{
  "available_expansions": [
    {
      "description": "<string>",
      "type": "payment_methods"
    }
  ],
  "available_operations": [
    {
      "description": "<string>",
      "type": "authorize"
    }
  ],
  "created_at": "2023-11-07T05:31:56Z",
  "id": "<string>",
  "key": "<string>",
  "spec": {
    "authorization": {
      "client": {
        "type": "kernel_managed"
      },
      "method": "oauth"
    },
    "provider": "link"
  },
  "state": {
    "provider": "link",
    "status": "pending_authorization",
    "status_reason": "<string>"
  },
  "type": "wallet",
  "updated_at": "2023-11-07T05:31:56Z",
  "action": {
    "name": "link_oauth",
    "url": "<string>"
  },
  "expanded": {
    "payment_methods": [
      {
        "capabilities": {
          "single_use_card": {
            "eligible": true,
            "reasons": [
              "<string>"
            ]
          }
        },
        "display": {
          "brand": "<string>",
          "label": "<string>",
          "last4": "<string>"
        },
        "id": "<string>",
        "is_default": true,
        "provider": "<string>",
        "type": "<string>"
      }
    ]
  },
  "expires_at": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id_or_name · string · required

key · string · required

Required string length: 1 - 255

Query Parameters

wait · integer · default: 0

Hold for up to this many seconds while the item is pending authorization, approval, or credential collection. Return the current item when ready or when the wait elapses. This does not wait for edits to an already-ready credential; poll GET without wait and compare version to observe changes after collect.

Required range: 0 <= x <= 60

expand · enum<string>[]

Live fields advertised by available_expansions to include in expanded.

Available options: payment_methods

Response

200

application/json

Vault item

Option 1

Option 2

Option 3

available_expansions · object[] · required

Show child attributes

available_operations · object[] · required

Show child attributes

created_at · string<date-time> · required

id · string · required

key · string · required

Immutable item key assigned when the item is created.

spec · object · required

Option 1

Option 2

Show child attributes

state · object · required

Option 1

Option 2

Show child attributes

type · enum<string> · required

Available options: wallet

updated_at · string<date-time> · required

action · object

Option 1

Option 2

Option 3

Option 4

Option 5

Option 6

Option 7

Show child attributes

expanded · object

Live, non-persisted data requested through the item GET expand parameter.

Show child attributes

expires_at · string<date-time>