---
meta:
  - title: Quick Start Guide - SavvyIQ API Documentation
  - name: description
    content: Get up and running with our Entity APIs in 5 minutes. Convert business names into verified entity data and retrieve comprehensive business intelligence.
---
# 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.

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

## API Authentication

1. [Sign up for an account](https://savvyiq.ai/signup) or [log in](https://savvyiq.ai/login)
2. Navigate to **API Keys** in your dashboard
3. Click **Create New Key** and copy your API key

```yaml
# 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.

### Entity Resolution Response

```json
{
  "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](/docs/concepts/confidence-and-explainability) for details.

## Business Intelligence Retrieval

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

### Entity Data Response

```json
{
  "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:

## Error Handling

Standard HTTP error responses:

```json
// 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
- [Understanding API Responses](/docs/handling-responses) - How to interpret API responses
- [Rate Limits](/docs/rate-limits) - API usage limits

### Core Concepts
- [Entities and Candidates](/docs/concepts/entities-and-candidates) - Data model documentation
- [Confidence and Explainability](/docs/concepts/confidence-and-explainability) - Scoring methodology
- [Identifiers](/docs/concepts/identifiers) - ID system and cross-API usage

### API Documentation
- [Entity Resolution API](/docs/apis/entity-resolution) - API details for entity resolution
- [Business Intelligence API](/docs/apis/business-intelligence) - API details for business intelligence
- [Domain Intelligence API](/docs/apis/domain-intelligence) - API details for domain intelligence