Skip to main content
GET
https://api.useadam.io/v1/adam
/
banks
/
{uuid}
Get bank
curl --request GET \
  --url https://api.useadam.io/v1/adam/banks/{uuid} \
  --header 'X-API-Key: <api-key>'
{
  "status": "success",
  "message": "Bank retrieved successfully",
  "data": {
    "uuid": "bank-uuid",
    "name": "Chase Bank",
    "nuban": "1234567890",
    "account_name": "Business Account",
    "currency": "USD",
    "country": "US",
    "balance": 10000,
    "opening_balance": 5000
  }
}

Authorizations

X-API-Key
string
header
default:your_tyms_sk_or_partner_key
required

Business secret tyms_sk_... for all routes except Register business, which expects your partner secret.

Path Parameters

uuid
string
required

Response

200 - application/json

Single bank account

status
string
required
Example:

"success"

message
string
required
data
any

Single resource, array of resources, statement sections, or async job metadata — see each operation's example.

meta
object

Pagination (page, limit, total) and/or report range (from, to). Cash flow may include previous_period_end.