🔗 BRDZ API Reference

Welcome to the BRDZ API Reference! This section covers direct HTTP API calls to BRDZ endpoints. If you're looking for SDK usage, check out the SDK Reference.

Base URL

All API endpoints are relative to:

https://api.brdz.link/api

Authentication

BRDZ API uses two levels of authentication:

1. API Key (Required for all requests)

Include your API key in the x-api-key header:

curl -H "x-api-key: YOUR_API_KEY" \
  https://api.brdz.link/api/endpoint

2. JWT Token (Required for authenticated endpoints)

Include JWT token in the Authorization header:

curl -H "Authorization: Bearer YOUR_JWT_TOKEN" \
  -H "x-api-key: YOUR_API_KEY" \
  https://api.brdz.link/api/protected-endpoint

Get API Key

Generate your API key at BRDZ Dashboard or use the API Key generation endpoint.

Quick Start

1. Get API Key

curl -X POST https://api.brdz.link/api/keys/generate-sdk-key \
  -H "Content-Type: application/json" \
  -d '{"provider_name": "My App"}'

curl -X POST https://api.brdz.link/api/auth/login \
  -H "Content-Type: application/json" \
  -H "x-api-key: YOUR_API_KEY" \
  -d '{
    "usernameoremail": "user@example.com",
    "password": "password123"
  }'

3. Make Authenticated Request

curl -X GET https://api.brdz.link/api/users/123 \
  -H "Authorization: Bearer YOUR_JWT_TOKEN" \
  -H "x-api-key: YOUR_API_KEY"

API Categories

🔐 Core Authentication & Security

Essential authentication, authorization and security endpoints.

API	Description	Key Endpoints
Authentication	User login, mobile auth, password reset	`/auth/login`, `/auth/mobile-login`, `/password/request_reset`
Two-Factor Auth	2FA setup, enable, disable, verification	`/2fa/setup`, `/2fa/enable`, `/2fa/verify-login`
API Keys	API key generation and management	`/keys/sdk-key`, `/keys/generate-sdk-key`
Admin	Administrative user management	`/admins/users`, `/admins/list`, `/admins/approve-kyc`, `/admins/users/{user_id}`
User Management	User profiles, countries, TOS acceptance	`/users/update_profile`, `/users/countries`, `/users/confirm`

⛓️ Modern Blockchain & Crypto

Next-generation blockchain and cryptocurrency operations.

API	Description	Key Endpoints
Crypto Wallet (ABSK)	AI-powered wallet management	`/absk/manual/wallets/crypto`, `/absk/agent/wallets/process`
Cross-chain	Multi-chain transfers (Sepolia, Amoy, Neon)	`/crosschain/initiate`, `/crosschain/mint`, `/crosschain/burn`
Onchain	Direct blockchain transaction execution	`/onchain/execute`, `/onchain/log`, `/onchain/history`
Bridge	Cross-chain wallet bridging	`/bridge/chains`, `/bridge/wallets`, `/bridge/execute`
Cardano	Cardano blockchain operations	`/cardano/balance`, `/cardano/onramp`, `/cardano/offramp`
XRPL	XRPL integration and trustlines	`/xrpl/trustlines`, `/xrpl/onramp`, `/xrpl/issuer`
Neon	Neon blockchain authentication	`/neon/signin`, `/neon/balance`

💰 Financial Services & Commerce

Payment processing and financial service endpoints.

API	Description	Key Endpoints
Marketplace (AI Commerce)	AI conversational commerce & multi-marketplace shopping	`/marketplace/chat`, `/marketplace/search`, `/marketplace/orders`
MCP (AI Commerce)	AI-powered shopping and payments	`/mcp/step1`, `/mcp/create-order`, `/mcp/execute-order`
Xendit	Payment gateway for Indonesia	`/xendit/withdraw`, `/xendit/fixed-va`, `/xendit/balance`
Indodax	Crypto exchange & IDR-USDC conversion	`/indodax/crypto-wallet`, `/indodax/conversion`
Foreign Exchange	Currency conversion and rates	`/fx/rate`, `/fx/convertall`, `/fx/simulate`
StableX	Cross-chain USDC operations	`/stablex/price-preview`, `/stablex/convert`, `/stablex/onramp`
Client Management	Client registration and management	`/clients/create_with_admin`, `/clients/{id}/stats`
NTCP	Recipient management & batch transfers	`/ntcp/recipients`, `/ntcp/batchtransfer/init`

🏦 Traditional Financial Services

Legacy wallet and transaction management.

API	Description	Key Endpoints
Traditional Wallet	Classic wallet operations	`/wallet/balance`, `/wallet/history`, `/wallet/add`
Traditional Transactions	Standard transaction processing	`/transactions`, `/transactions/topup`, `/transactions/transfer`
Visa	Virtual Visa card management	`/visa/cards`, `/visa/create`, `/visa/balance`

🔗 Third-Party Integrations

External service integrations and verifications.

API	Description	Key Endpoints
eKYC	Sumsub identity verification	`/ekyc/status`, `/ekyc/sumsub/token`, `/ekyc/sumsub/websdk`
Plaid	Banking and ACH integration	`/plaid/link_token`, `/plaid/exchange`, `/plaid/topup`
Twitter	Twitter bot verification & rewards	`/twitter/verification/initiate`, `/twitter/rewards/mention`
Privy	Privy authentication integration	`/privy/auth/login`, `/privy/auth/link-wallet`
Xendit	Indonesian payment gateway	`/xendit/wallet/withdraw`, `/xendit/fixed-va/request`, `/xendit/reconciliation/run`
Indodax	Crypto conversion & trading (IDR to USDC)	`/indodax/crypto-wallet/save`, `/indodax/conversion/run-daily`, `/indodax/conversion/status/:job_id`
IDRX	IDR onramp/offramp gateway (BRDZ System)	`/idrx/onramp/initiate`, `/idrx/offramp/initiate`, `/idrx/banks/add`, `/idrx/transactions/mint`

🧪 Development & Testing

Development tools and testing environments.

API	Description	Key Endpoints
Testnet	Testnet development tools	`/testnet/chain`, `/testnet/onramp`, `/testnet/faucet`

Response Format

All API responses follow a consistent format:

Success Response

{
  "success": true,
  "data": {
    // Response data here
  },
  "timestamp": "2024-01-15T10:30:00Z"
}

Error Response

{
  "success": false,
  "error": "Error message",
  "code": "ERROR_CODE",
  "timestamp": "2024-01-15T10:30:00Z"
}

HTTP Status Codes

Status	Meaning	Description
`200`	OK	Request successful
`201`	Created	Resource created successfully
`400`	Bad Request	Invalid request parameters
`401`	Unauthorized	Missing or invalid API key/token
`403`	Forbidden	Insufficient permissions
`404`	Not Found	Resource not found
`429`	Too Many Requests	Rate limit exceeded
`500`	Internal Server Error	Server error

Rate Limiting

API requests are rate limited to ensure fair usage:

Public endpoints: 100 requests per minute
Authenticated endpoints: 1000 requests per minute
File upload endpoints: 10 requests per minute

Rate limit headers are included in responses:

X-RateLimit-Limit: 1000
X-RateLimit-Remaining: 999
X-RateLimit-Reset: 1640995200

Error Codes

Common error codes you might encounter:

Code	Description	Solution
`API_KEY_MISSING`	API key not provided	Include `x-api-key` header
`API_KEY_INVALID`	Invalid API key	Generate new API key
`TOKEN_EXPIRED`	JWT token expired	Re-authenticate user
`INSUFFICIENT_BALANCE`	Insufficient wallet balance	Top up wallet
`RATE_LIMITED`	Too many requests	Wait and retry

SDKs Available

While this reference covers HTTP APIs directly, we recommend using our official SDKs:

JavaScript/TypeScript: npm install anantla_sdk
Python: Coming soon
Go: Coming soon
PHP: Coming soon

Support

Need help with the API?

📧 Email: contact@anantla.com
🌐 Contact Form: anantla.org/contact
📚 SDK Documentation: SDK Reference
💬 Community: GitHub Discussions

Next Steps

Get your API key from the Dashboard
Try authentication with the Authentication API
Explore specific APIs that match your use case
Consider using the SDK for easier integration

Base URL​

Authentication​

1. API Key (Required for all requests)​

2. JWT Token (Required for authenticated endpoints)​

Quick Start​

1. Get API Key​

2. Login User​

3. Make Authenticated Request​

API Categories​

🔐 Core Authentication & Security​

⛓️ Modern Blockchain & Crypto​

💰 Financial Services & Commerce​

🏦 Traditional Financial Services​

🔗 Third-Party Integrations​

🧪 Development & Testing​

Response Format​

Success Response​

Error Response​

HTTP Status Codes​

Rate Limiting​

Error Codes​

SDKs Available​

Support​