Get an account Vault

Get account vault

curl --request GET \
  --url https://prod-api.stableyard.fi/v2/accounts/{accountId}/vault \
  --header 'Authorization: Basic <encoded-value>'

import requests

url = "https://prod-api.stableyard.fi/v2/accounts/{accountId}/vault"

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://prod-api.stableyard.fi/v2/accounts/{accountId}/vault', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://prod-api.stableyard.fi/v2/accounts/{accountId}/vault",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic <encoded-value>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://prod-api.stableyard.fi/v2/accounts/{accountId}/vault"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Basic <encoded-value>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://prod-api.stableyard.fi/v2/accounts/{accountId}/vault")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic <encoded-value>'

response = http.request(request)
puts response.read_body

{
  "id": "vault_123",
  "accountId": "acct_123",
  "chainId": 42161,
  "ownershipMode": "external",
  "status": "pending_authorization",
  "safeAddress": null,
  "predictedSafeAddress": null,
  "rolesModuleAddress": null,
  "monitoring": {
    "provider": "example",
    "status": "registered",
    "registeredAt": null
  },
  "earning": {
    "enabled": true,
    "provider": "none",
    "currentApyBps": null,
    "earnedAmountRaw": null
  },
  "resourceVersion": 1,
  "createdAt": "2026-08-28T10:00:00.000Z",
  "updatedAt": "2026-08-28T10:00:00.000Z"
}

{
  "error": {
    "code": "bad_request",
    "message": "The request is invalid"
  }
}

{
  "error": {
    "code": "unauthorized",
    "message": "Authentication is required"
  }
}

{
  "error": {
    "code": "forbidden",
    "message": "The credential does not allow this operation"
  }
}

{
  "error": {
    "code": "not_found",
    "message": "The resource was not found"
  }
}

{
  "error": {
    "code": "idempotency_conflict",
    "message": "The Idempotency-Key was already used with a different request"
  }
}

{
  "error": {
    "code": "chain_config_missing",
    "message": "The requested network is not configured for this environment"
  }
}

{
  "error": {
    "code": "rate_limited",
    "message": "Too many requests"
  }
}

GET

accounts

{accountId}

vault

Get account vault

curl --request GET \
  --url https://prod-api.stableyard.fi/v2/accounts/{accountId}/vault \
  --header 'Authorization: Basic <encoded-value>'

import requests

url = "https://prod-api.stableyard.fi/v2/accounts/{accountId}/vault"

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://prod-api.stableyard.fi/v2/accounts/{accountId}/vault', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://prod-api.stableyard.fi/v2/accounts/{accountId}/vault",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic <encoded-value>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://prod-api.stableyard.fi/v2/accounts/{accountId}/vault"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Basic <encoded-value>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://prod-api.stableyard.fi/v2/accounts/{accountId}/vault")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic <encoded-value>'

response = http.request(request)
puts response.read_body

{
  "id": "vault_123",
  "accountId": "acct_123",
  "chainId": 42161,
  "ownershipMode": "external",
  "status": "pending_authorization",
  "safeAddress": null,
  "predictedSafeAddress": null,
  "rolesModuleAddress": null,
  "monitoring": {
    "provider": "example",
    "status": "registered",
    "registeredAt": null
  },
  "earning": {
    "enabled": true,
    "provider": "none",
    "currentApyBps": null,
    "earnedAmountRaw": null
  },
  "resourceVersion": 1,
  "createdAt": "2026-08-28T10:00:00.000Z",
  "updatedAt": "2026-08-28T10:00:00.000Z"
}

{
  "error": {
    "code": "bad_request",
    "message": "The request is invalid"
  }
}

{
  "error": {
    "code": "unauthorized",
    "message": "Authentication is required"
  }
}

{
  "error": {
    "code": "forbidden",
    "message": "The credential does not allow this operation"
  }
}

{
  "error": {
    "code": "not_found",
    "message": "The resource was not found"
  }
}

{
  "error": {
    "code": "idempotency_conflict",
    "message": "The Idempotency-Key was already used with a different request"
  }
}

{
  "error": {
    "code": "chain_config_missing",
    "message": "The requested network is not configured for this environment"
  }
}

{
  "error": {
    "code": "rate_limited",
    "message": "Too many requests"
  }
}

Returns the account Vault, its active policy, current 30-day spend usage, pending actions, mandates and audit-facing state. Fund or use the Vault only once status is active.

Authorizations

Authorization

string

header

required

HTTP Basic auth. Username is the Stableyard app ID. Password is the app secret. The optional Stableyard-Version request header must match the environment pin.

Headers

Stableyard-Version

enum<string>

Optional contract-version assertion. Omit it to use the app environment's pinned version. A different supported version is accepted only after that environment is explicitly migrated.

Available options:

2026-09-09

Path Parameters

accountId

string

required

Canonical account id returned by the Accounts API.

Example:

"acct_123"

Response

Vault

string

required

Example:

"vault_123"

accountId

string

required

Example:

"acct_123"

chainId

integer

required

Example:

42161

ownershipMode

enum<string>

required

Available options:

external,

stableyard

status

enum<string>

required

Available options:

pending_authorization,

provisioning,

awaiting_policy,

active,

suspended,

failed,

requires_intervention

monitoring

object

required

Show child attributes

earning

object

required

Show child attributes

resourceVersion

integer

required

Required range: x >= 1

createdAt

string<date-time>

required

updatedAt

string<date-time>

required

safeAddress

string | null

The Vault's smart-account address once it is deployed.

predictedSafeAddress

string | null

Allocated Vault address. It is not evidence of deployment or readiness to receive funds. Wait for status active before funding or using the Vault.

rolesModuleAddress

string | null

Address of the Vault's on-chain policy module.

activePolicyId

string | null

activePolicy

Active Vault policy · object | null

Show child attributes

latestPolicy

Latest Vault policy · object | null

Show child attributes

nextAction

Vault action required · object | null

Show child attributes

pendingActions

object[]

Show child attributes

spendUsage

object

Show child attributes

mandates

object[]

failureCode

string | null

Introduction

Onboarding

Accounts

Money movement

Activity

Vaults

Client & checkout

Platform

Get an account Vault

Authorizations

Headers

Path Parameters

Response