SavvyIQ

Quick Start Guide

Get your first entity resolution working in minutes. This guide walks through converting business names into verified entity data and retrieving comprehensive business intelligence.

You'll build a complete workflow: "Apple Inc" → verified entity record → detailed business profile with corporate hierarchy and financial data.

View as .md

API Authentication

  1. Sign up for an account or log in
  2. Navigate to API Keys in your dashboard
  3. Click Create New Key and copy your API key
# API key format:
S6yS02QKbzUyR4Uyihut2f7qNf2bJBLZQ

All requests require the apikey header with your API key.

Entity Resolution

Transform a business name into a verified entity record using the Entity Resolution API.

Loading...

Entity Resolution Response

{
  "request_id": "req_2ZUKocPbFCPLClZ5XtHlJ",
  "status": "matched",
  "confidence": 98,
  "type": "business",
  "subtype": "incorporated_entity",
  "entity": {
    "id": "siq_2ZUKocPbFCPLClZ5XtHlJ",
    "name": "Apple",
    "status": "active",
    "website": "apple.com",
    "description": "Designs, develops, and sells consumer electronics, computer software, and online services.",
    "headquarters": {
      "city": "Cupertino",
      "state": "California",
      "address": "ONE APPLE PARK WAY",
      "country": "United States",
      "state_code": "CA",
      "country_code": "US"
    },
    "primary_legal_entity": {
      "id": "le_2ZoRp6I3EUgebkUBHaDdk",
      "name": "APPLE INC.",
      "country_code": "US",
      "jurisdiction": "California"
    }
  },
  "candidate": null,
  "factors": [ /* Decision reasoning */ ],
  "actions": [ /* Improvement suggestions */ ],
  "metadata": { /* Request context */ }
}

Response Analysis

  • status: "matched" - Verified entity found (vs. candidate response)
  • confidence: 98 - High confidence match
  • entity.id - Unique identifier for subsequent API calls
  • primary_legal_entity - Government record details

Note: Complete responses include factors (match reasoning) and actions (improvement suggestions). See Confidence and Explainability for details.

Business Intelligence Retrieval

Now use the entity ID to unlock comprehensive business data and insights.

Loading...

Entity Data Response

{
  "entity_id": "siq_2ZUKocPbFCPLClZ5XtHlJ",
  "status": "complete",
  "data": {
    "id": "siq_2ZUKocPbFCPLClZ5XtHlJ",
    "name": "Apple",
    "type": "business",
    "subtype": "incorporated_entity",
    "status": "active",
    "headquarters": {
      "address": {
        "city": "Cupertino",
        "state": "California",
        "country": "United States",
        "state_code": "CA",
        "postal_code": "95014",
        "street_address": "1 Apple Park Way"
      }
    },
    "primary_legal_entity": {
      "id": "le_2ZoRp6I3EUgebkUBHaDdk",
      "name": "APPLE INC.",
      "jurisdiction": {
        "country_code": "US",
        "state_province": "California"
      }
    },
    "attributes": {
      "description": "Apple Inc. is a multinational technology company that designs, develops, and sells consumer electronics, computer software, and online services.",
      "website": "https://www.apple.com",
      "domain": "apple.com"
    },
    "classification": {
      "naics_codes_2022": [
        {
          "code": "334220",
          "name": "Radio and Television Broadcasting and Wireless Communications Equipment Manufacturing",
          "relevance": 90,
          "confidence": 95,
          "is_primary": true
        },
        {
            "code": "334111",
            "name": "Electronic Computer Manufacturing",
            "relevance": 90,
            "confidence": 95,
            "is_primary": false
        },
        {
            "code": "449210",
            "name": "Electronics and Appliance Retailers",
            "relevance": 85,
            "confidence": 90,
            "is_primary": false
        },
        // ...
      ],
      "business_tags": [
        "Consumer Electronics",
        "Software Development",
        "Technology Hardware"
      ],
      "business_model": [
        "Hardware Sales",
        "Software Licensing",
        "Services"
      ],
      "products_services": [
        "iPhone",
        "iPad",
        "Mac",
        "Apple Watch",
        "iOS",
        "macOS"
      ]
    }
  },
  "//": "..."
}

Complete Workflow Implementation

End-to-end implementation combining entity resolution and business intelligence retrieval:

Loading...

Error Handling

Standard HTTP error responses:

// 401 - Invalid API key
{
  "message": "No API key found in request",
  "request_id": "d6ed1709fa87777bb373fd60a810e717"
}
 
// 400 - Invalid request
{
  "error": {
    "message": "Missing required parameter: name",
    "type": "bad_request"
  }
}
 
// 502 - Request timeout
{
  "error": {
    "message": "Request timeout",
    "type": "timeout"
  }
}

Next Steps

Getting Started

Core Concepts

API Documentation