REST API reference

Kick off a business profile resolve — by name + country, or by domain alone when you already know the business's website. Requires the profiles:write scope. This is asynchronous — a cold full resolve runs the complete discovery → crawl → extraction → reconciliation pipeline and typically takes a few minutes (a preview resolve returns fast partial data in a few seconds), so this endpoint returns immediately and you poll for the result (see below).

Request body

Federated countries require a locality hint. For US, IN, BR, CA, AU, DE, MX, and NG, business names commonly repeat across many distinct, unrelated locations (a "Joe's Pizza" in a dozen different states) — name + country alone isn't enough to reliably identify one. Omitting localityHint for these countries returns MISSING_REQUIRED_FIELD; supplying one that isn't a real state, province, or city in that country returns INVALID_FIELD_VALUE. This requirement never applies to a domain lookup — a domain is inherently unambiguous.

Request body (by name + country)

{
  "businessName": "Blispa Barbershop & Spa",
  "countryHint": "KE",
  "mode": "full"
}

Request body (by domain)

No countryHint or localityHint needed — the engine deep-crawls the given domain first, extracts the business's real name and every fingerprint (phone, email, address, social links) directly from the site, and derives the country from the domain itself (its country-code TLD, or a phone number found on the site) before the rest of the resolve runs. This is often a cleaner match than name + country: you've already supplied an unambiguous anchor, so there's no name to disambiguate.

{
  "domain": "artcaffe.co.ke",
  "mode": "full"
}

Response — 202 Accepted

{
  "businessId": "616de6d1-7732-4ece-a551-5e3187923aa8",
  "pollUrl": "/v1/profiles/616de6d1-7732-4ece-a551-5e3187923aa8",
  "status": "processing"
}

Poll pollUrl (i.e. GET /v1/profiles/{businessId}) every few seconds until it stops returning 202. See that endpoint below for the shape of the finished result.

Poll for a resolve's result, or re-fetch an already-completed profile by its business ID — the same ID returned by POST /v1/profiles/lookup. Requires profiles:read.

Query parameters

Response by state

Force a full re-generation of a profile, bypassing all caches. Counts against your lookup quota.

Submit a data correction for a specific field. Corrections are reviewed and applied to future profile generations.

Request body

Return per-field source attribution — which sources contributed to a specific field and at what confidence.

Not yet available in production — this currently returns 501 NOT_IMPLEMENTED. Every field in the main profile response already carries its own metadata.sources and metadata.confidence inline (see Data model), which covers most attribution needs today.

Ask a natural language question about a profile. Requires the ask_lumen feature on your plan.

Request body

Stream profile generation as Server-Sent Events. Each event is a JSON object. The stream ends with an event: done sentinel.

Event types

List profiles in the account, paginated.

Query parameters

Register a URL to be called when a lookup you started resolves or fails.

List your registered URLs.

Remove a registered URL.

List recent delivery attempts across your subscriptions.

Inspect one delivery attempt.

Manually retry one delivery.

List deliveries that exhausted all automatic retries.

Re-attempt a dead-lettered delivery.

Send a synthetic test event to a URL before relying on it.

Create a short-lived Creem customer portal session. Redirect the customer to overview_url to manage their payment method or cancel — both are handled on Creem's own hosted pages, and Creem's webhook syncs any resulting change back to your account.

Response

{
  "overview_url": "https://www.creem.io/my-orders/..."
}

cancel_url and update_payment_method_url may also appear in this object, but Creem's portal is a single page rather than separate deep links, so in practice they are omitted — send the customer to overview_url and let them navigate from there.

List the account's billing/invoice history.

Get a short-lived (~1 hour) signed PDF URL for one invoice.

Full usage metrics for the current billing period, including per-resource used/limit/remaining.

Condensed summary view matching the dashboard's usage page.

Daily usage breakdown for the current billing period.

Account details including tier, features enabled, and support info.

Create a new API key. The rawKey in the response is shown exactly once.

List all active API keys (raw keys are never returned — only metadata).

Revoke an API key immediately. Requests using the revoked key fail within 60 seconds.

Liveness check. Returns 200 OK if the gateway process is running. No auth required.

Readiness check. Returns 200 OK when all downstream services are reachable. No auth required.