API REFERENCE

RESTful APIs for the AI economy

Complete API coverage for accounts, payments, cards, custody, credit scoring, and agent operations. Built for machines, documented for humans.

Install SDK Browse Endpoints
BASE https://api.probebanks.com/v2
ENDPOINTS

Six API domains, one platform

Every capability of the Probe Banks platform is accessible through clean, versioned REST endpoints.

Accounts API REST
Create and manage agent accounts -- individual, swarm, and treasury types.
  • POST /accounts Create account
  • GET /accounts/{id} Get account
  • GET /accounts/{id}/balance Get balance
  • PUT /accounts/{id}/rules Update rules
Payments API M2M
Initiate payments, streaming settlements, and conditional escrow operations.
  • POST /payments Send payment
  • POST /payments/stream Start stream
  • POST /payments/escrow Create escrow
  • GET /payments/{id} Get status
Cards API REST
Issue virtual and physical cards with programmable spending controls.
  • POST /cards Issue card
  • PUT /cards/{id}/limits Set limits
  • POST /cards/{id}/freeze Freeze card
Custody API VAULT
Deposit, withdraw, and manage digital asset custody in OZ Vault.
  • POST /custody/deposit Deposit
  • POST /custody/withdraw Withdraw
  • GET /custody/holdings Holdings
Credit API PoB
Query behavioral credit scores, apply for credit lines, and access scoring factors.
  • GET /credit/{id}/score Get score
  • GET /credit/{id}/factors Score factors
  • POST /credit/{id}/apply Apply credit
Agent API BUN
Register agents on BUN, discover peers, bid for resources, and manage lifecycle.
  • POST /agents/register Register
  • GET /agents/discover Discover
  • POST /agents/{id}/bid Resource bid
  • DEL /agents/{id} Deregister
AUTHENTICATION

Secure by default

Three authentication methods to fit every integration pattern -- from simple API keys to full OAuth 2.0 flows.

API Keys
Simple bearer token authentication for server-to-server integrations. Scoped permissions per key.
Authorization: Bearer pb_live_k1...
OAuth 2.0
Full OAuth 2.0 authorization code flow for third-party integrations and delegated agent access.
grant_type=authorization_code
Webhook Signatures
HMAC-SHA256 signed webhook payloads. Verify every incoming event is authentic and unmodified.
X-Probe-Signature: sha256=...
PLATFORM

Built for production

10,000/min
Rate Limits
Default 10,000 requests per minute. Higher limits available for enterprise accounts with dedicated SLAs.
v2
API Versioning
URL-path versioned. Previous versions supported for 12 months after deprecation. Migration guides provided.
4 SDKs
Official SDKs
Python, TypeScript, Go, and Rust. All auto-generated from OpenAPI spec with full type safety.
START INTEGRATING

Get your API keys

Create a developer account, generate API keys, and start making requests. Full sandbox environment available for testing.

Get API Keys Read the Docs