Documentation

Identity

GET /api/v1/identity: which company an API key belongs to, its environment, and whether it can place a live order right now.

API reference

Base URL: https://api.roofquery.com. Authenticate with Authorization: Bearer <your key> — except the four file routes, which take no key.

Copies this whole page as Markdown, so you can paste it into an assistant and have it write the integration. Nothing secret goes on the clipboard — your keys aren't included.

GET /api/v1/identity

Who this key belongs to, and whether it can actually place an order. Call it once after issuing a key to confirm it works, and later as a health probe. canOrder is quoted against the cheapest product — it answers "can this account order at all", not "can it afford a commercial report".

curl -H "Authorization: Bearer rq_live_sk_..." \
  "https://api.roofquery.com/api/v1/identity"
{
  "companyId": "acct_9f2c1",
  "companyName": "Acme Roofing",
  "sandbox": false,
  "env": "live",
  "keyId": "key_3d81aa",
  "balance": {
    "available": 247,
    "currency": "usd",
    "canOrder": true
  }
}