Skip to main content

Documentation Index

Fetch the complete documentation index at: https://apidocs.bridge.xyz/llms.txt

Use this file to discover all available pages before exploring further.

​
Step 1: Create a Bridge account

Are you an existing developer? Head over to dashboard.bridge.xyz to login to your Bridge Dashboard. Do you want to get started? Contact sales.

​
Step 2: Create your API keys

Once logged in, click on the “API Keys” tab on the top menu bar and generate a new API key.
Safely store your API keys
Bridge will make your API key available only once, so make sure to immediately copy and save the key safely and securely. Your key is used to authenticate into our APIs and is highly sensitive. If it ever gets compromised, you can immediately revoke key access from our dashboard and generate a new key.

​
Creating scoped API keys programmatically

In addition to the Dashboard, you can create scoped API keys via the API. Scoped keys are restricted to a subset of permissions and are useful for limiting what a key can do — for example, granting only customer:read access to a read-only service. Use POST /v0/api_keys with an unrestricted key or a key that holds the api_key:create scope: 
curl -X POST https://api.bridge.xyz/v0/api_keys \
  -H "Api-Key: <your-api-key>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Customer service key",
    "scopes": ["customer:read", "customer:create"]
  }'
The name field is optional (up to 100 characters) and lets you label a key so you can identify its purpose later. The value in the response is the plaintext secret — it is returned only once, so store it immediately. Up to 500 scoped keys may exist per developer. To inspect the scopes on the key making a request, call GET /v0/api_keys/whoami.

​
Step 3: Follow our guides and start moving money.

Create your first customer - This guide walks you through creating your first customer and getting them verified Create a one-time payment - This guide walks you through moving funds onchain through a bank Setting up webhooks - This guide walks you through setting up and using Bridge webhooks to handle customer events in your application.