API Documentation

Integrate with Brevitax to export your data and receive leads from external sources using our REST API.

Getting Started

The Brevitax API provides two core capabilities: data exports for getting your leads and cases out of Brevitax, and webhook endpoints for receiving leads from external sources like your website, CRM, or lead generation tools.

Authentication

All API requests require authentication using an API key passed in the x-api-key header. Contact your account manager to obtain API keys for your organization.

Base URL

Replace your-subdomain with your actual subdomain (e.g., pastdu, main, etc.):

https://your-subdomain.brevitax.com/api

Export Endpoints

Export your data in JSON or CSV format for integration with CRMs, reporting tools, or data analysis.

Export Leads

Export Users

Export Tax Cases

Webhook Endpoints

Receive leads and tax cases from external sources like your website, landing pages, or lead generation tools.

Receive Leads

{
  "full_name": "John Smith",           // Required
  "email": "john@example.com",         // Required  
  "phone": "+1-555-123-4567",         // Optional
  "message": "Interested in tax help", // Optional
  "lead_source": "website_form",       // Optional
  "taxfirm_id": 123                   // Optional
}

{
  "success": true,
  "message": "Lead created successfully",
  "data": {
    "id": 456,
    "full_name": "John Smith",
    "email": "john@example.com",
    "created_at": "2025-01-21T10:30:00Z"
  }
}

Receive Tax Cases

{
  "user_email": "client@example.com",     // Required
  "full_name": "Jane Doe",                // Required
  "phone": "+1-555-987-6543",            // Optional
  "selected_program": "offer_in_compromise", // Optional
  "tax_problem_data": {                   // Optional
    "problem_type": "back_taxes",
    "amount_owed": "25000",
    "years_affected": ["2020", "2021", "2022"]
  },
  "personal_info": {                      // Optional
    "address": "123 Main St",
    "city": "Anytown",
    "state": "CA",
    "zip": "12345"
  },
  "taxfirm_id": 123                      // Optional
}

API Key Management

Manage your API keys programmatically (requires admin access).

Create API Key

{
  "key_name": "CRM Integration",
  "permissions": ["read", "write"],
  "taxfirm_id": 123,
  "expires_in_days": 365
}

Validate API Key

Error Handling

The API uses standard HTTP status codes:

• 200 - Success
• 201 - Created (for webhook submissions)
• 400 - Bad Request (missing required fields)
• 401 - Unauthorized (invalid API key)
• 500 - Internal Server Error

Integration Examples

Export to Salesforce

// Export leads and sync to Salesforce
const response = await fetch('https://your-subdomain.brevitax.com/api/exports/leads?format=json', {
  headers: { 'x-api-key': 'your-api-key' }
});
const { data: leads } = await response.json();

// Process leads and sync to Salesforce CRM
leads.forEach(lead => {
  // Your Salesforce integration logic
});

Receive Website Leads

// Send form submission to Brevitax
const formData = {
  full_name: document.getElementById('name').value,
  email: document.getElementById('email').value,
  phone: document.getElementById('phone').value,
  message: document.getElementById('message').value,
  lead_source: 'contact_form'
};

fetch('https://your-subdomain.brevitax.com/api/webhooks/leads', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'x-api-key': 'your-api-key'
  },
  body: JSON.stringify(formData)
});