Authentication

How to authenticate with the Partners API

All Partners API endpoints require an API key passed in the x-api-key header.

Getting your API key

API keys are provisioned by the WealthAtlas team. Contact support@wealthatlas.com or reach out to your account manager to get one.

Each API key is scoped to a single team and has access to that team’s data, lists, networks, and credit balance.

Using your API key

Include the x-api-key header in every request:

$curl -X GET https://api.wealthatlas.com/v1/partners/test \
> -H "x-api-key: YOUR_API_KEY"

Verifying your key

Use the GET /test endpoint to verify your API key is valid. It returns 200 OK if the key is recognized and linked to an active team.

Key expiry

A key may carry a deactivation date, set by the WealthAtlas team when the key is issued or later. The key keeps working through that date (UTC) and is rejected from the following day with 401 Unauthorized:

1{"detail": "API key expired on 2026-08-01. Contact WealthAtlas to issue a new key."}

This is deliberately distinct from an unrecognized key, which API Gateway rejects with 403 Forbidden before the request reaches us. An expired key is never charged credits. Contact support to have a new key issued.

Security best practices

  • Never expose your API key in client-side code. API calls should be made from your server.
  • Rotate keys if you suspect they’ve been compromised. Contact support to issue a new key.
  • Store keys in environment variables or a secrets manager, not in source code.

Rate limits

The Partners API enforces the following rate limits:

LimitValue
Requests per second10
Burst limit10

If you exceed these limits, the API returns 429 Too Many Requests. Implement exponential backoff in your client.