Authentication

All API requests require authentication via a Bearer token in the Authorization header.

API Keys

Generate API keys from your dashboard at braidisdata.com under Settings > API Keys.

TIP

API access is available on Growth plans and above. Starter plans use the Salesforce package and web dashboard only.

Using Your Key

Include your API key in every request:

curl -X POST https://api.braidisdata.com/v1/reverse-phone \
  -H "Authorization: Bearer br_live_abc123def456..." \
  -H "Content-Type: application/json" \
  -d '{"phone": "+15551234567"}'

Key Format

Environment	Prefix	Example
Production	br_live_	br_live_abc123def456ghi789
Sandbox	br_test_	br_test_xyz987wvu654tsr321

Key Management

• You can create multiple keys per account
• Keys can be rotated without downtime — create a new key, update your code, then revoke the old one
• Each key can optionally be scoped to specific endpoints

Security Best Practices

• Never expose keys in client-side code — always call the API from your server
• Use environment variables — don't hardcode keys in source files
• Rotate keys regularly — at least every 90 days
• Use sandbox keys for development — sandbox requests don't consume credits

Error Responses

If authentication fails, you'll receive:

{
  "success": false,
  "error": {
    "code": "AUTH_INVALID_KEY",
    "message": "Invalid or expired API key"
  }
}

Status Code	Meaning
401	Missing or invalid API key
403	Key is valid but lacks permission for this endpoint