API reference
Match a company
Resolve a domain to a company we hold, with nothing else attached. Free, and intended to be called constantly.
Beta
GET/api/v1/public/company/match
Free. Identity resolution is plumbing: an integration calls it on every inbound record to decide whether enriching is worth a credit, so metering it would tax the step that keeps your spend efficient while earning us almost nothing. It is rate-limited per key instead. A miss answers 200 with matched:false and charges nothing — it is an outcome, not an error.
Parameters
| Name | Type | Description | |
|---|---|---|---|
| domain | string | Required | A registrable domain. A full URL or a leading www. is accepted and normalised — send what you have. |
Returns
| Field | Type | Description |
|---|---|---|
| matched | boolean | Whether a company was found. |
| company.domain | string | The canonical registrable domain. This is the identifier every other call takes. |
| company.name | string | Canonical company name. |
| credits_charged | number | Always 0 for this endpoint. |
Example
bash
curl "https://api.truepoint.in/api/v1/public/company/match?domain=acme.com" \
-H "Authorization: Bearer $TRUEPOINT_API_KEY"json
{
"matched": true,
"company": { "domain": "acme.com", "name": "Acme" },
"credits_charged": 0
}Errors
| Status | Type | Meaning |
|---|---|---|
| 422 | validation_error | The request failed validation — a missing identifier, or a value we could not parse. 422 rather than 400: the request was well-formed, its contents were not. |
| 401 | invalid_token | Missing, malformed, unknown or revoked API key. All four answer identically on purpose — the endpoint must not confirm which keys exist. |
| 403 | insufficient_scope | The key is valid but was not minted with the scope this endpoint requires. |
| 402 | insufficient_credits | The balance cannot cover this call. Nothing was charged and nothing was returned. Carries `balance` and `required`. |
| 429 | rate_limited | Too many requests for this key. Carries `retryAfterSeconds`. Retries are safe and are not billed. |
| 500 | internal | Something failed on our side. Nothing was charged. Retry with backoff. |