WealthGuard API Documentation

Build powerful financial applications with our RESTful API. Access real-time portfolio data, transaction history, investment analytics, and automated wealth management tools.

Note: All endpoints return JSON responses. Dates are formatted in ISO 8601. All monetary values are in USD cents to avoid floating-point precision issues.

Authentication

WealthGuard uses API keys and OAuth 2.0 for authentication. Include your credentials in the request header.

Header Format

Authorization: Bearer <your_api_token>
X-Client-Id: <your_client_id>

Generate your API key in the Developer Dashboard. Keys are scoped by environment (sandbox/production) and permission level (read/write/admin).

Base URL & Rate Limits

Endpoints
Production: https://api.wealthguard.com/v2
Sandbox:    https://sandbox-api.wealthguard.com/v2

Rate limits are enforced per API key:

Plan	Requests/min	Burst
Developer	60	10
Business	600	50
Enterprise	Custom	Custom

Accounts

GET /v2/accounts

Retrieve a paginated list of linked financial accounts.

Query Parameters

Parameter	Type	Description
`status`	string	Filter by status: `active`, `inactive`
`limit`	integer	Number of results (max 100). Default: 20
`cursor`	string	Pagination cursor from previous response

Example Request

cURL

curl -X GET "https://api.wealthguard.com/v2/accounts?status=active&limit=10" \
  -H "Authorization: Bearer sk_live_51NzKx..." \
  -H "Content-Type: application/json"

Example Response 200 OK

JSON
{
  "data": [
    {
      "id": "acct_8f3k2m9d",
      "type": "checking",
      "institution": "Chase",
      "balance": 2450000,
      "currency": "USD",
      "status": "active",
      "updated_at": "2024-01-15T14:32:00Z"
    }
  ],
  "pagination": {
    "next_cursor": "dXNlcl9uZXh0",
    "has_more": true
  }
}

POST /v2/accounts/link

Initiate a secure account linking flow using Plaid or native direct connect.

Request Body

Parameter	Type	Required	Description
`provider`	string	Yes	`plaid`, `yodlee`, `native`
`user_id`	string	Yes	Internal user identifier
`redirect_url`	string	No	URL to return after successful linking

Transactions

GET /v2/accounts/{account_id}/transactions

Fetch transaction history for a specific account. Supports date filtering and category mapping.

Path Parameters

Parameter	Type	Description
`account_id`	string	The unique account identifier

Deprecation Notice: The legacy_format query parameter will be removed in v3.0. Please migrate to the new transaction schema.

Error Handling

WealthGuard uses standard HTTP status codes. Errors return a consistent JSON structure.

Error Response
{
  "error": {
    "code": "rate_limit_exceeded",
    "message": "You have exceeded the maximum number of requests per minute.",
    "details": {
      "retry_after": 45,
      "limit": 60,
      "current": 61
    },
    "request_id": "req_8f3k2m9d1x"
  }
}

Code	Description
`400`	Bad Request - Invalid parameters or malformed JSON
`401`	Unauthorized - Invalid or missing API key
`403`	Forbidden - Insufficient permissions for this resource
`404`	Not Found - Resource does not exist
`429`	Too Many Requests - Rate limit exceeded
`500`	Internal Server Error - Something went wrong on our end

Webhooks

Subscribe to real-time events like account.linked, transaction.created, or portfolio.rebalanced.

Webhook payloads are signed using HMAC-SHA256. Verify the X-Webhook-Signature header before processing events.