docs/authentication
Home ↗

Authentication

Every request to a protected endpoint must carry your API key in the x-api-key header. Keys are prefixed sk_live_ and are tied to a single caller identity.

curl -X POST https://api.parcelkit.us/api/auth/generate \
  -H "Content-Type: application/json" \
  -d '{"owner":"Acme Corp","email":"dev@acme.com"}'
response.json
{
  "key": "sk_live_e3548b8f1a01c2e03c97a0dbd92e1781",
  "owner": "Acme Corp",
  "email": "dev@acme.com"
}
curl -G https://api.parcelkit.us/api/property/search \
  -H "x-api-key: sk_live_your_key" \
  --data-urlencode "q=10 Woodborough Way, Spring TX 77389"

Your key is shown only once at generation time. If lost, use the Get API Key endpoint in the Request Console to issue a new one.