Web Presence Review

Review Company

Conduct a web presence review of a business. You must identify the business one of two ways:

By domain — submit domain (accepts a bare domain, full URL, or email; we extract the registered domain).
By name + address — submit submitted_business_name together with at least one address field (address_line_1, city, state_province, postal_code, or country).

All other fields (submitted_phone, submitted_email, submitted_full_name, submitted_description) are optional and help us identify the business and surface additional detail.

Requires a valid X-API-KEY header. Rate limited to 5 requests per second.

Unstable connections: a review can take up to 90 seconds, and some integrations cannot hold a connection open that long. Pass ?async=true to have us validate and enqueue the review, then respond 201 right away with a tracking id and a Location header. true is the only value this parameter accepts; omit it entirely to wait for the result as usual. Poll that URL (GET for the full result, HEAD if you only need the status) until it returns 200; it returns 202 while the review is still running. The review itself is unchanged — it still runs under the same time budget as a waiting request, so a job that reaches a worker too late is abandoned rather than left running. That makes this different from the /company/async/* endpoints, which run a review to completion however long it takes and notify you by webhook; use those if your priority is that the review finishes rather than that it finishes soon.

Testing: You can use example.org as a test domain to verify your integration without hitting real data sources or incurring any cost to you. It returns a static fixture response with realistic data, and it honours async=true as well — the review is already complete, so the URL you are handed returns the fixture on your first poll. Test domain requests are never counted in your search statistics.

post/api/v1/company/search

Query parameters

async'true' nullable

Pass async=true to enqueue the review and get a 201 with a Location header to poll, instead of holding the connection open until the review completes. true is the only accepted value; omit the parameter entirely to wait for the result.

Request body

domainstring nullable

The business's domain. Required unless you provide submitted_business_name together with an address. Accepts a bare domain, full URL, or email — we reduce it to the registered domain per Mozilla's Public Suffix List. (RFC 1034/1035 for ASCII, IDNA2008 for internationalized.)

submitted_business_namestring nullable

The business's name. Required (along with an address) if you do not provide domain.

submitted_descriptionstring nullable

A description of the business's industry/operations

address_line_1string nullable

Line 1 of the business address. At least one address field is required when identifying the business by name instead of domain.

address_line_2string nullable

Line 2 of the business address.

citystring nullable

City of the business address.

state_provincestring nullable

State/Province of the business address.

postal_codestring nullable

Postal code of the business address.

countrystring nullable

Country of the business address

submitted_emailstring nullable

The email of the business or applicant. (Emails should conform to the IETF RFC 5322 spec)

submitted_phonestring nullable

The phone number of the business or applicant. (Phone numbers should conform to the ITU-T E.164 standard)

submitted_full_namestring nullable

The full name of the applicant.

match_profile_idstring uuid nullable

ID of the TrueBiz match profile to use when processing the request.

external_tracking_refstring nullable

ID used in your system to track this request.

Example request

{
  "address_line_1": "123 Main St.",
  "address_line_2": "Suite 100",
  "city": "Memphis",
  "country": "USA",
  "domain": "example.net",
  "external_tracking_ref": "abc_defg12345678",
  "match_profile_id": "00000000-0000-0000-0000-000000000000",
  "postal_code": "37501",
  "state_province": "TN",
  "submitted_business_name": "Bob's Burritos",
  "submitted_description": "Bob's Burritos is a local institution proudly serving top quality Mexican street food to the Memphis area since 1967.",
  "submitted_email": "bob@yahoo.com",
  "submitted_full_name": "Bob Smith",
  "submitted_phone": "+19015555555"
}

Response

namestring nullable

The name of the company.

has_closed_indicatorsboolean nullable

true when any one supported source signals the business is closed — either permanently or temporarily. Signals include closure language on the website, a CLOSED_PERMANENTLY or CLOSED_TEMPORARILY status from Google Places, and matching Yelp/Scrap.io flags. Treat as a strong indicator the business should not be approved without manual review. null means we did not gather enough signal to make a determination — it is not the same as false.

founded_yearinteger nullable

The year the company was founded.

descriptionstring nullable

A short summary of what the company does, sourced from the company's own website content and/or third-party business data providers. May be null for parked, unreachable, or extremely sparse sites where no usable description could be derived.

social_media_profilesstring[]

All social media profile URLs we associate with the company. This is the complete set; social_media_detailed_profiles is the enriched subset of these for which we were able to collect follower counts and other per-profile metrics.

pdf_report_linkstring uri nullable

URL for a PDF outlining the results in a visual format. The PDF is rendered on demand, so the first request to this URL starts generation and returns a 202; repeat it until it returns 200. See the Async Web Presence Review Integration Guide.

ui_portal_linkstring uri nullable

Link to see the full response in TrueBiz's web portal.

is_blockedboolean

Is this business blocked for fraud based on information that your company has provided to us.

tracking_idstring uuid nullable

ID used to track this request in TrueBiz's application.