Developer Docs

BIGDBM API Reference

Integrate behavioral intent signals and real-time identity enrichment into your applications with simple, secure REST APIs.

REST / JSON Bearer token auth Production-grade SLA

Getting Started

Overview

The BIGDBM API suite lets you query behavioral intent signals, resolve identifiers, and enrich profiles, all over HTTPS using JSON payloads. Every response includes structured data you can pipe directly into your CRM, CDP, or data warehouse.

  • Query consumer intent by keyword, date range, and volume
  • Enrich emails, phones, addresses, MAIDs, and IPs in real time
  • Receive hashed email (HEM) lists for audience activation
  • All endpoints return standard JSON with consistent error shapes

Base URL

HTTPS https://aws-behavioral-intent-api.bigdbm.com

All API requests must be made over HTTPS. HTTP requests will be rejected. API keys are issued per account and scoped to the products you have licensed.

Security

Authentication

All BIGDBM API endpoints require a Bearer token passed in the Authorization header.

Header format:
Authorization: Bearer YOUR_TOKEN

Tokens are issued by your BIGDBM account representative. Each token is scoped to specific API products and rate limits. Do not share tokens or commit them to version control, use environment variables or a secrets manager.

  • Tokens do not expire on a fixed schedule, but can be rotated on request
  • Each token is tied to your organization and audit-logged
  • A missing or invalid token returns 401 Unauthorized

Sync APIs

B2B Sync APIs

Enrich business records in real time using a wide range of B2B identifiers. Whether you're starting from a company name, an IP address, a LinkedIn profile, or a hashed email, these APIs instantly append firmographic, contact, and intent data to your existing records — accelerating sales, marketing, and operational workflows.

  • Account-Based Marketing — match inbound signals to company records and trigger targeted campaigns
  • Lead Enrichment — append missing firmographic and contact data to incomplete CRM records
  • Real-time Scoring — enrich leads the moment they enter your pipeline for immediate sales prioritization
  • Identity Resolution — match across identifiers (IP, email, LinkedIn, phone) to a single company profile

Available Endpoints

POST B2B Address Docs →
Resolve a physical business address to company identity, contacts, and firmographic data. Ideal for direct mail lists, field sales territory enrichment, and verifying inbound form data against known business locations.
🗺️
Territory Enrichment
Map inbound leads to sales territories by company address.
📬
Direct Mail
Verify and enrich physical addresses before large-scale direct mail sends.
🔎
Prospect Matching
Match business addresses to full company profiles for sales outreach.
POST B2B Email Docs →
Submit a business email address to retrieve the associated professional profile — including company, job title, seniority, and direct contact data. One of the most accurate B2B resolution methods available.
📥
Inbound Lead Enrichment
Instantly enrich leads when they submit a work email on your website.
🎯
Sales Prioritization
Score and route leads by seniority, department, and company size.
🔗
CRM Hygiene
Backfill missing contact attributes in your Salesforce or HubSpot records.
POST B2B Maid Docs →
Match a Mobile Advertising ID (MAID) to a B2B identity. Bridge the gap between consumer mobile data and professional profiles — enabling cross-device business targeting without relying on cookies.
📱
Mobile B2B Targeting
Reach business professionals on their mobile devices with pinpoint accuracy.
🍪
Cookieless Identity
Resolve B2B identity in a post-cookie world using durable mobile IDs.
📊
Cross-Device Attribution
Connect mobile touchpoints to your pipeline and attribute revenue correctly.
POST B2B Email MD5 Docs →
Submit an MD5-hashed business email to retrieve professional profile data without exposing raw PII. Designed for privacy-safe enrichment workflows, clean room environments, and partner data sharing agreements.
🔒
Privacy-Safe Enrichment
Enrich records without transmitting raw email addresses across systems.
🧹
Clean Room Compatibility
Use MD5 hashes to enrich data inside privacy-compliant data clean rooms.
🤝
Partner Data Sharing
Share enrichment workflows with partners without exposing underlying PII.
POST B2B Phone Docs →
Resolve a business phone number to company name, industry, job function, and contact data. Works with direct-dial, main-line, and mobile business numbers to return the most complete professional profile available.
📞
Call List Enrichment
Append company and title data to inbound call records before callbacks.
Number Validation
Verify that phone numbers are linked to real business entities before outreach.
🎯
Intent Matching
Cross-reference calling activity with intent signals for prioritization.
POST B2B Company Docs →
Submit a company name, domain, or EIN to retrieve full firmographic data — including industry, revenue range, employee count, headquarters location, and decision-maker contacts. The definitive B2B enrichment endpoint.
📊
Account Intelligence
Build full account profiles before sales calls or account planning sessions.
🎯
ICP Scoring
Score companies against your Ideal Customer Profile using live firmographic data.
🔗
CRM Population
Backfill or update company records in your CRM with authoritative firmographics.
POST B2B IP Docs →
Resolve a visiting IP address to a company identity — including company name, industry, size, and location. Transform anonymous website traffic into qualified B2B leads without requiring any form submission.
👀
Website Deanonymization
Identify the companies visiting your website even when they don't convert.
Real-time Lead Capture
Trigger sales alerts the moment a target account lands on your site.
🎯
ABM Signal Detection
Track target account engagement and surface warm accounts to sales.
POST B2B LinkedIn Docs →
Match a LinkedIn profile URL or Sales Navigator ID to enriched B2B contact and company data. Bridge social intelligence with verified business records for the most complete professional profile available.
🔍
Prospect Research
Enrich LinkedIn profiles with verified contact info and firmographics.
📩
Outreach Personalization
Append job history, skills, and company data to personalize cold outreach.
🧩
Social + CRM Sync
Keep your CRM synchronized with current LinkedIn profile and company data.

Sync APIs

Consumer Sync APIs

Enhance existing consumer records with additional attributes in real time. All consumer sync endpoints use a configurable Output ID (10008), fully customizable to your requirements before production deployment. Ideal for identity resolution, profile enrichment, and improving match rates across marketing, analytics, and activation workflows.

Output ID 10008 — All consumer sync endpoints return the standard Output ID 10008 schema by default. This is fully configurable — attributes can be added or removed before production deployment. Contact your account representative to tailor the output to your data model.

Available Endpoints (14)

POST PII Docs →
The most comprehensive consumer resolution method. Submit a combination of name and address to receive a fully enriched consumer profile including demographics, financial indicators, contact data, and household attributes. Highest match rates across all input types.
🪪
Identity Resolution
Resolve consumer identities from first-party data with industry-leading match rates.
📈
Profile Enrichment
Append 30+ attributes to thin first-party records for richer audience targeting.
🎯
Segmentation
Build precise segments from enriched PII for campaign targeting and personalization.
POST Id Docs →
Submit a proprietary consumer ID or partner identity key to retrieve the associated enriched profile. Designed for systems where you already have a resolved identity token and need to retrieve current attribute data.
🔄
Profile Refresh
Update stale records by submitting existing IDs to retrieve current attributes.
🔗
Partner ID Sync
Resolve partner identity keys against your internal records for unified profiles.
📊
Attribute Backfill
Append missing demographics and contact data to ID-only records.
POST IP Docs →
Resolve a consumer IP address to household-level data including location, demographics, and lifestyle attributes. Useful for real-time personalization, anonymous visitor enrichment, and fraud signals.
👤
Visitor Identification
Identify anonymous website visitors and personalize experiences in real time.
📍
Geo-Demographic Targeting
Append location and demographic data to IP-based ad targeting workflows.
🛡️
Fraud Signals
Cross-reference IP data with household attributes to flag suspicious activity.
POST Email Docs →
Submit a raw consumer email address to append household demographics, contact information, income, lifestyle, and behavioral attributes. One of the most widely used input types for consumer data enrichment.
📧
Email List Enrichment
Append demographics and household data to email marketing lists.
🎯
Audience Segmentation
Segment email lists by income, age, and household composition for personalization.
🔍
Lead Qualification
Score inbound email leads by appended demographic and financial attributes.
POST Maid Docs →
Resolve a Mobile Advertising ID to consumer household data, demographics, and lifestyle attributes. Bridge mobile identity to offline consumer records for cross-channel targeting without cookie dependency.
📱
Mobile-to-Offline
Connect mobile identities to offline household data for unified consumer profiles.
🍪
Cookieless Targeting
Build addressable audiences from durable MAIDs in a cookie-free environment.
📊
Cross-Device Measurement
Attribute conversions across devices by resolving MAIDs to household records.
POST EmailMD5 Docs →
Submit an MD5-hashed email for privacy-safe consumer enrichment. Returns the same rich attribute set as the raw email endpoint without exposing personally identifiable information — ideal for clean room and privacy-first workflows.
🔒
Privacy-Safe Enrichment
Enrich records in clean room environments using hashed identifiers only.
🤝
Data Collaboration
Share enrichment capabilities with partners without transmitting raw emails.
Compliance-Ready
Meet data governance requirements while maintaining full enrichment capability.
POST MD5Age Docs →
Submit a hashed email to retrieve the associated age band — a lightweight, privacy-safe signal for audience segmentation and age-gating. Returns age bracket data without requiring full profile resolution.
👶
Age Segmentation
Build age-band audiences from hashed email lists without full PII enrichment.
🔞
Age-Gating
Verify age ranges for compliant targeting of age-restricted products.
📊
Demographic Validation
Cross-validate self-reported ages against authoritative household records.
POST Phone Docs →
Resolve a consumer phone number — mobile or landline — to household demographics, name, address, and lifestyle attributes. Enriches inbound call data and SMS marketing lists with rich consumer context.
📞
Call Center Enrichment
Display caller household data to agents in real time during inbound calls.
📲
SMS List Enrichment
Append demographic context to SMS subscriber lists for better segmentation.
🔍
Identity Verification
Cross-validate phone numbers against household records to confirm identity.
POST GZAI Docs →
AI-enhanced geographic zone enrichment using ZIP+4 precision. Append hyper-local demographic, lifestyle, and socioeconomic insights derived from AI models trained on neighborhood-level signals — without requiring individual-level PII.
🤖
AI-Powered Segmentation
Apply AI-derived neighborhood signals for next-generation audience targeting.
📍
Hyper-Local Targeting
Enrich at ZIP+4 precision for ultra-local campaign personalization.
🔒
Privacy-First Enrichment
Get rich insights without individual-level PII using geographic aggregates.
POST Address Docs →
Append consumer profile data from a physical street address input. Returns household demographics, estimated resident names, financial indicators, and contact attributes — useful for direct mail, field sales, and property-linked workflows.
📬
Direct Mail
Enrich mailing lists with household demographics before campaign sends.
🏡
Property Targeting
Combine address-level data with property signals for home services campaigns.
🔎
Address Validation
Verify addresses are residential and linked to real consumer records.
POST PII with Validation Docs →
The full PII enrichment response plus real-time data quality flags. In addition to appending consumer attributes, this endpoint validates the accuracy and recency of each returned field — helping you understand the confidence level of every attribute returned.
Data Quality Assurance
Flag low-confidence or outdated attributes before using in downstream systems.
🏆
Best Record Selection
Use validation scores to select the highest-quality records from multiple sources.
📊
Compliance Auditing
Document data provenance and quality scores for regulatory compliance needs.
POST LinkedIn Docs →
Match consumer LinkedIn profiles to household and demographic data. Combine professional context with consumer attributes for the most complete view of your audience — spanning both their personal and professional identity.
🔗
Professional + Consumer
Merge LinkedIn professional data with consumer household attributes.
🎯
Premium Audience Targeting
Build high-value audiences from professionally verified LinkedIn identifiers.
✉️
Personalized Outreach
Personalize consumer communications using both professional and household context.
POST VIN Docs →
Resolve a Vehicle Identification Number to the associated consumer profile — including owner demographics, contact data, and household attributes. Ideal for automotive marketing, insurance, and aftermarket services targeting.
🚗
Automotive Marketing
Target vehicle owners with relevant service, upgrade, and replacement offers.
🛡️
Insurance Targeting
Reach auto insurance prospects by vehicle type, age, and owner demographics.
🔧
Aftermarket Services
Connect with vehicle owners for maintenance, accessories, and parts campaigns.
GET PII Count Docs →
Returns the number of matching consumer records for a given PII input — without returning the full profile. Use this lightweight endpoint to validate data quality, estimate match rates, and size audiences before committing to full enrichment API calls.
📊
Match Rate Validation
Estimate match rates for a dataset before running full enrichment at scale.
💰
Cost Estimation
Size potential API usage and costs before committing to large enrichment jobs.
🔍
Data Quality Check
Quickly assess the quality and coverage of an input dataset before processing.

Intent APIs

Intent by Item (IAB, Keyword, Domain)

The Intent API 2.4 enables you to discover individuals actively researching specific products, brands, or services. By surfacing people who are already showing buying intent, you can prioritize your highest-value prospects and reach them when they're most likely to convert.

📣
Demand Generation
Reach in-market buyers with targeted campaigns timed to their active research phase.
📊
Audience Expansion
Grow your addressable market by identifying net-new prospects showing relevant intent signals.
Performance Campaigns
Reduce wasted spend by focusing budget on prospects demonstrating active purchase intent.

POST /intent/createList

Creates an intent-based audience list and returns matching hashed email addresses (HEMs) for activation or enrichment.

POST https://aws-behavioral-intent-api.bigdbm.com/intent/createList

Request Example

cURL shell
curl --location 'https://aws-behavioral-intent-api.bigdbm.com/intent/createList' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR_TOKEN' \
--data '{
    "StartDate": "2025-12-03",
    "EndDate": "2025-12-03",
    "Keywords": "audi",
    "NumberOfHems": 1000
}'

Parameters

ParameterTypeRequiredDescription
StartDate string Required Start of the intent signal window. Format: YYYY-MM-DD. Must be within the last 90 days.
EndDate string Required End of the intent signal window. Format: YYYY-MM-DD. Must be >= StartDate.
Keywords string Required Keyword or phrase representing the consumer intent to match. Examples: "audi", "mortgage refinance", "electric vehicle".
NumberOfHems integer Required Maximum number of hashed email addresses to return. Min: 100, Max: 100,000. Actual count may be lower depending on signal volume.

Sample Response

JSON Response 200 OK
{
  "status": "success",
  "listId": "lst_7f3a9b2c4d1e",
  "count": 1000,
  "hems": [
    {
      "hem": "a3f4e8b7c2d1901ef56a3b2c4d7e8f9a0b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5",
      "signal_date": "2025-12-03",
      "confidence": 0.94,
      "signal_count": 7
    }
  ],
  "metadata": {
    "processing_ms": 143,
    "keyword_match_pool": 48291,
    "api_version": "2.4"
  }
}

Intent APIs

Intent by MD5

The Intent 3.0 API works in reverse: by submitting an MD5 identifier, you can retrieve the topics, products, or services that an individual has recently searched for. This allows for deeper audience insights, personalized messaging, smarter segmentation, and more effective downstream activation.

🔍
Audience Insights
Understand what topics your known audience has been researching recently.
✉️
Personalized Messaging
Tailor outreach copy to match each individual's real purchase intent signals.
🗂️
Smarter Segmentation
Build micro-segments based on actual research behavior rather than inferred attributes.
🚀
Downstream Activation
Feed intent data into your DSP, CRM, or activation platform for precision targeting.
POST Intent by MD5 Docs →
Submit an MD5 identifier to retrieve the topics and products an individual has recently searched for — enabling deeper audience insights, personalized messaging, smarter segmentation, and more effective downstream activation.

Audience APIs

Audience Creation APIs

Build precise, addressable audiences at scale across consumer, B2B, property, and healthcare datasets. Define your ideal customer profile and receive a matched audience ready for activation across any channel — DSP, CRM, email, or direct mail.

All audience creation endpoints share the same SmartSelector API documentation. Select the audience type below to access the technical reference for that dataset.

Consumer Audience

Build precise consumer audiences using demographic, behavioral, and lifestyle attributes. Receives a matched, addressable audience ready for activation.

B2B Audience

Create targeted B2B audiences from company size, industry, job function, seniority, and intent signals. Reach the right decision-makers at the right accounts with precision account-based targeting.

Property Audience

Build audiences based on property ownership, home value, mortgage status, and neighborhood attributes. Ideal for real estate, home services, insurance, and financial services campaigns targeting homeowners.

Healthcare Audience

Build compliant healthcare audiences from provider specialty, therapeutic category interest, and patient segment indicators. Designed for pharmaceutical, medical device, and health system marketing teams.

Service APIs

OPQL Phone Validation

The OPQL API verifies phone number reachability by querying telecom provider data directly. The response returns a numeric score from 0 to 5 — each value maps to a specific level of network activity and verification confidence, letting you make precise decisions about contact quality rather than a simple active/inactive flag.

The API returns a single integer field opql_score with a value between 0 and 5. Higher scores indicate greater reachability confidence and telecom verification depth. Scores of 4 or 5 are generally safe for outreach; scores of 0 or 1 should be suppressed.

Response Score Reference

0
Invalid or Unverified Reachability
The number cannot be verified with any telecom source. It is likely invalid, disconnected, or entirely unrecognized by carrier systems.
Suppress — do not contact
1
No Activity or Insufficient Information
The number exists in carrier records but shows no detectable activity and lacks enough information to assess reachability with confidence.
High risk — suppress or re-validate
2
Limited Activity with Partial Information
Some network signals are present but activity is sparse and the information available is incomplete. Reachability is uncertain.
Use with caution — low confidence
3
Recent Activity with Limited Identifiable Information
The number has shown recent network activity, but the identity and full profile behind it are only partially confirmed by carrier data.
Moderate confidence — use selectively
4
Stable Network Activity with Verified Reachability
The number demonstrates consistent network activity and carrier verification confirms it is reachable. Suitable for outreach with standard hygiene practices.
Good — safe for outreach
5
Consistent Reachability with Full Verification
The highest confidence score. The number is fully verified by telecom sources, shows consistent activity, and all identity signals are confirmed. Optimal for high-value outreach.
Excellent — highest confidence

Use Cases

🎯
Score-Based Filtering
Route only score 4–5 numbers into outreach queues. Suppress 0–1 automatically to protect sender reputation.
📊
List Quality Scoring
Score an entire phone list before a campaign send to measure reachability distribution and forecast contact rates.
📋
DNC & Compliance Hygiene
Combine score 0–1 suppression with DNC checks for a fully compliant, high-quality contact file.
📬
SMS Deliverability
Validate mobile numbers against carrier data before SMS sends — target score 4–5 for best deliverability rates.

Coming Soon

🏠

Property Sync APIs

Property Sync APIs are currently in development and will enable real-time enrichment of property records with ownership, valuation, and demographic data.

Coming Soon

Coming Soon

🏥

Healthcare Sync APIs

Healthcare Sync APIs are currently in development and will enable compliant enrichment of healthcare records with provider, patient segment, and clinical data attributes.

Coming Soon

Email APIs

Batch Email Validation

The Email Validation API lets you submit a list of email addresses and receive a deliverability verdict for each one. Use it to clean contact lists, suppress undeliverables before sends, and flag risky addresses that could harm sender reputation.

BASE URL https://r6q7ghcrah.execute-api.us-west-2.amazonaws.com/Prod
Authentication required. All requests must include an Authorization header with a valid Bearer token. Contact your account manager to obtain access credentials.

POST /email-cleansing/batch

Validates up to 10 email addresses in a single request and returns a deliverability status for each.

POST https://r6q7ghcrah.execute-api.us-west-2.amazonaws.com/Prod/email-cleansing/batch

Request Example

cURL shell
curl --location 'https://r6q7ghcrah.execute-api.us-west-2.amazonaws.com/Prod/email-cleansing/batch' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR_TOKEN' \
--data '{
  "ValidatorId": 10,
  "Emails": [
    "alice@example.com",
    "bob@example.org"
  ]
}'

Request Parameters

ParameterTypeRequiredDescription
ValidatorId integer Required Identifies the validation engine to use for processing. Example: 10. Your account manager will provide the correct value for your contract.
Emails string[] Required List of email addresses to validate. Maximum 10 addresses per request. Each address must be a valid format and no longer than 200 characters.

Response Fields

FieldTypeDescription
results object[] Array of validation results, one entry per submitted email address.
results[].email string The email address that was validated, echoed back from the request.
results[].status integer Deliverability verdict code. See the Status Codes table below.

Validation Status Codes

StatusLabelMeaning
10 Deliverable The address is valid and safe to send to.
20 Send with Caution The address may be deliverable but carries some risk (e.g. role address, low-quality domain). Review before sending.
30 Undeliverable The address is invalid or the mailbox does not exist. Suppress from all sends.
40 Unknown Deliverability could not be determined. Treat cautiously.
50 Catch-all The domain accepts all email regardless of whether the mailbox exists. Deliverability cannot be confirmed.

Sample Response

JSON Response 200 OK
{
  "results": [
    {
      "email": "alice@example.com",
      "status": 10
    },
    {
      "email": "bob@example.org",
      "status": 30
    }
  ]
}

Error Messages (400 Bad Request)

MessageCause
'Emails' must contain at least one email address and no more than {n} email addresses! The Emails array is empty or exceeds the maximum batch size.
An email address must be in a valid format and contain no more than {n} characters! One or more addresses are malformed or exceed the 200-character limit.
Validator with the ID: {n} not found! The supplied ValidatorId does not match any configured validator.
Validation error. Please contact us! An internal processing error occurred. Reach out to support if this persists.
Invalid ClientId! The Bearer token does not correspond to a recognised client account.

Reference

Response Codes

All BIGDBM API endpoints return standard HTTP status codes. Errors include a message field with a human-readable description.

Code Meaning Notes
200 OK Success Request was processed successfully. Check the status field for application-level results.
400 Bad Request Invalid parameters A required parameter is missing, malformed, or out of range. Check the message field for details.
401 Unauthorized Authentication failed Bearer token is missing, expired, or invalid. Verify your token in the Authorization header.
429 Too Many Requests Rate limit exceeded You have exceeded the request rate for your plan. Check the Retry-After header and implement exponential backoff.
500 Internal Server Error Server error An unexpected error occurred. These are rare, retry with backoff. If persistent, contact support.

Ready to integrate?

Request API credentials and get started building with BIGDBM's data products today.

Get API Access