MindScan Intelligence API

Generate a complete behavioral sales intelligence report for a lead. Returns 18 CRM-ready fields with actionable sales insights.

Request Body

Example Request

{
  "first_name": "Sarah",
  "last_name": "Johnson",
  "date_of_birth": "1988-07-22",
  "city": "Austin",
  "state": "TX",
  "country": "US",
  "location_id": "abc123locationXYZ",
  "business_context": "Company serves US homeowners, tone should be consultative and trust-first."
}

Example Response

{
  "status": "success",
  "lead": {
    "first_name": "Sarah",
    "last_name": "Johnson"
  },
  "report": {
    "Executive_Summary": "Sarah is a vision-driven buyer who...",
    "Buying_Style": "Emotionally motivated with analytical validation...",
    "Psychological_Drivers": "Status, innovation, social proof...",
    "Decision_Process": "Fast initial interest, needs social proof...",
    "Communication_Tone": "Warm, enthusiastic, story-driven...",
    "Cheat_Sheet_DO": "Lead with vision and transformation...",
    "Cheat_Sheet_DONT": "Don't overwhelm with specs early...",
    "Objection_Handling": "When she says 'I need to think'...",
    "Messaging_Hooks": "3 high-converting angles for outreach...",
    "Follow_Up_Cadence": "Day 1: Personal touch. Day 3: Value...",
    "Onboarding_Strategy": "Start with quick wins to build...",
    "Retention_Loyalty": "Monthly check-ins with progress data...",
    "Churn_Risk": "Medium — watch for engagement drops...",
    "Next_Best_Action": "Send a personalized case study...",
    "Opening_Script": "Hi Sarah, I noticed you...",
    "Close_Script": "Based on everything we discussed...",
    "Follow_Up_Message_SMS": "Hey Sarah! Quick thought on...",
    "Follow_Up_Message_Email": "Subject: Sarah, this reminded me..."
  },
  "usage": {
    "total_scans": 142,
    "monthly_scans": 38,
    "scans_remaining": 62,
    "plan": "enterprise"
  }
}

Convenience endpoint for deep reports. Same request shape as /v1/scan but forces depth=full.

Runs quick profiles for each person, then returns a synthesis compatibility analysis.

{
  "profile_type": "hiring",
  "group_name": "Q1 Sales Hire",
  "depth": "quick",
  "people": [
    {"first_name":"Alex","last_name":"Rivera","date_of_birth":"1990-01-15","city":"Austin","country":"US","context_role":"team_member"},
    {"first_name":"Mia","last_name":"Cole","date_of_birth":"1995-09-21","city":"Dallas","country":"US","context_role":"candidate","cv_summary":"5 years B2B SaaS closing."}
  ]
}

Fetches all individual scans plus synthesis result for a previously-created group.

List cached people for your account. Reuse them in compatibility workflows.

Attach or update CV summary for a cached person (used in hiring analysis).

Check your current scan usage, remaining quota, and plan details.

Example Response

{
  "account": "Level Up Marketplace",
  "company": "Level Up",
  "usage": {
    "total_scans": 142,
    "monthly_scans": 38,
    "scans_remaining": 62,
    "plan": "enterprise",
    "scan_limit": 100
  }
}

Get scan usage broken down by GHL location/subaccount. Agencies use this to see which subaccounts are consuming scans — ideal for per-location billing.

Requires the same API key authentication as other endpoints.

Example Response

{
  "account": "My Agency",
  "company": "Agency Inc",
  "overall_usage": {
    "total_scans": 250,
    "monthly_scans": 82,
    "scans_remaining": 918,
    "plan": "growth"
  },
  "locations": [
    {
      "location_id": "loc_abc123",
      "total_scans": 120,
      "monthly_scans": 45,
      "daily_scans": 3,
      "last_scan_at": "2025-12-15T14:30:00"
    },
    {
      "location_id": "loc_def456",
      "total_scans": 80,
      "monthly_scans": 22,
      "daily_scans": 1,
      "last_scan_at": "2025-12-15T11:20:00"
    }
  ]
}

Set or update your business profile used to personalize report outputs.

Example Request

{
  "company_name": "Acme Roofing",
  "industry": "Home Services",
  "value_proposition": "Fast roof replacement with premium materials.",
  "services": "roof repair, roof replacement, inspections",
  "target_market": "US homeowners",
  "tone": "professional and consultative",
  "proof_points": "500+ projects completed",
  "pricing_model": "per-project"
}

Example Response

{
  "status": "success",
  "profile": {
    "company_name": "Acme Roofing",
    "industry": "Home Services",
    "value_proposition": "Fast roof replacement with premium materials.",
    "services": "roof repair, roof replacement, inspections",
    "target_market": "US homeowners",
    "tone": "professional and consultative",
    "proof_points": "500+ projects completed",
    "pricing_model": "per-project"
  }
}

Retrieve the active business profile for your API key context.

Example Response

{
  "status": "success",
  "profile": {
    "company_name": "Acme Roofing",
    "industry": "Home Services",
    "value_proposition": "Fast roof replacement with premium materials.",
    "services": "roof repair, roof replacement, inspections",
    "target_market": "US homeowners",
    "tone": "professional and consultative",
    "proof_points": "500+ projects completed",
    "pricing_model": "per-project"
  }
}

Activate a new coach session for a CRM contact. If an active session already exists for that contact, the existing session is returned.

Example Request

{
  "contact_id": "ghl_contact_abc123",
  "contact_name": "John Smith",
  "contact_profile": {
    "Executive_Summary": "Analytical, cautious buyer..."
  },
  "crm_context": {
    "deal_stage": "Proposal Sent",
    "deal_value": "$5,000",
    "last_activity": "Downloaded pricing PDF",
    "recent_messages": [
      {"type":"email","direction":"outbound","date":"2026-02-10","summary":"Sent proposal with 3 options"},
      {"type":"sms","direction":"inbound","date":"2026-02-11","summary":"Thanks, will review this week"}
    ],
    "notes": "Prefers morning calls. Budget approved by manager.",
    "tags": ["hot-lead", "enterprise"]
  }
}

Example Response

{
  "status": "success",
  "session_id": 42,
  "contact_id": "ghl_contact_abc123",
  "contact_name": "John Smith",
  "initial_analysis": "Here's what I see with John..."
}

Generate a secure contact-specific coach launch link for CRM custom fields.

Example Request

{
  "contact_id": "ghl_contact_abc123",
  "contact_name": "John Smith",
  "crm_context": {
    "deal_stage": "Proposal Sent",
    "notes": "Budget approved"
  },
  "auto_tag": "sales_coach"
}

Example Response

{
  "status": "success",
  "coach_link": "https://api.mind-scan.com/coach/open?t=...",
  "expires_at": "2026-02-20T10:30:00+00:00"
}

Send a message to an active coach session and receive practical next-step guidance.

Example Request

{
  "session_id": 42,
  "message": "Can you draft an SMS to follow up on the proposal?"
}

Example Response

{
  "status": "success",
  "session_id": 42,
  "response": "Here's an SMS for John that plays to his analytical nature...",
  "messages_used": 5,
  "messages_remaining": 95
}

List active coach sessions for your account.

Example Response

{
  "status": "success",
  "sessions": [
    {
      "session_id": 42,
      "contact_id": "ghl_contact_abc123",
      "contact_name": "John Smith",
      "status": "active",
      "message_count": 5,
      "created_at": "2026-02-13T10:30:00Z"
    }
  ]
}

Get full conversation history for a specific coach session.

Example Response

{
  "status": "success",
  "session_id": 42,
  "contact_name": "John Smith",
  "session_status": "active",
  "messages": [
    {"role":"assistant","content":"Here's what I see with John...","created_at":"2026-02-13T10:30:02Z"},
    {"role":"user","content":"Can you draft an SMS?","created_at":"2026-02-13T10:31:10Z"},
    {"role":"assistant","content":"Here's an SMS for John...","created_at":"2026-02-13T10:31:12Z"}
  ],
  "messages_used": 3,
  "messages_remaining": 97
}

Close a coach session when the conversation is complete.

Example Response

{
  "status": "success",
  "session_id": 42,
  "final_message_count": 12
}