API

API reference

One lookup endpoint. Numbers are E.164 (normalized examples below). Get credentials in the portal.

Base URL

https://api.harvestwave.com

Authentication

Applications use either:

An API key on X-API-Key
An OAuth2 client-credentials bearer token on Authorization: Bearer

Humans create and rotate those credentials in the portal. Do not put the portal password on the lookup request.

POST /v1/lookups

Send one E.164 number. The match is exact. Off-by-one is a different number; there is no fuzzy matching.

Request

POST /v1/lookups HTTP/1.1
Host: api.harvestwave.com
Content-Type: application/json
X-API-Key: YOUR_API_KEY

{
  "phoneNumber": "+15551234567"
}

Response

{
  "isBusiness": true,
  "businesses": [
    { "name": "Example Firm LLP", "confidence": 1.0 }
  ]
}

confidence is 1.0 for an exact directory listing. Address, additional numbers, and contacts are omitted unless your token includes those data permissions and the directory has them. Entitled extra slices that actually appear on the body add one credit each.

Errors and rate limits

See the portal for the live account status of credentials, remaining credits, and any enforced limits. This page does not invent status codes or SLA numbers.

Get credentials