> ## Documentation Index
> Fetch the complete documentation index at: https://docs.squid-id.com/llms.txt
> Use this file to discover all available pages before exploring further.

# API overview

> The Squid ID API is read-only: retrieve an identified visitor's details by id, over the Squid ID broker, authenticated with your API key.

The Squid ID API is read-only. A key you create in Squid ID reads one identified visitor's details. It cannot list, create, change, or delete anything. Use it to pull an identified visitor into your own systems.

## Base URL

```
https://id-api.asksquid.ai/api
```

All requests are served over HTTPS and go through the Squid ID broker: your key is exchanged for access at the edge, so the base URL is always `id-api.asksquid.ai`.

## Authentication

Every request requires your Squid ID API key in the `Authorization` header. Keys start with `sqid_`.

```
Authorization: Bearer sqid_YOUR_KEY
```

See [Authentication](/api-reference/authentication) for how to create one, and [API keys](/account/api-tokens) for managing them.

## Endpoints

| Endpoint                                                             | Method | Description                                                                                                 | Billing                             |
| -------------------------------------------------------------------- | ------ | ----------------------------------------------------------------------------------------------------------- | ----------------------------------- |
| [/visitors/{visitorId}/details](/api-reference/visitors/get-details) | GET    | An identified visitor's base details: name, email, company, role, LinkedIn                                  | Free to call                        |
| [/visitors/enrichment](/api-reference/visitors/enrichment)           | POST   | Enrich a person by email or phone: full record (contact, social, company, org, job, location, work history) | One ID match + one Squid ID+ record |

`enrichment` returns the complete Squid ID+ record and is charged per call at your current rates; `details` returns the base fields already on a visitor and is free to call. Enrichments require **API access** enabled and are not added to your visitors dashboard.

## Response codes

| Code  | Meaning                                          |
| ----- | ------------------------------------------------ |
| `200` | Success                                          |
| `401` | Unauthorized (missing, invalid, or disabled key) |
| `404` | Visitor not found                                |
| `429` | Rate limited                                     |

## Other APIs

This is the read-only visitor API available on Squid ID. If you're interested in other APIs, refer to our development platform, [sqid.dev](https://sqid.dev).