Sign in
Async Web Presence Review

Async Review Company

This API endpoint allows you to enqueue a web presence review based on either a website (as a URL, domain, or email) or both a business name and address. Other optional information about the company and applicant (phone, email, applicant name) can help identify the business and locate additional detail. You may either poll for status updates using the url provided in the response's Location header, or, if you have a webhook configured, wait for us to notify you when the web presence review is completed. (You may then request the details from the Web Presence Review History endpoint.) This API requires a valid API key (X-API-KEY) to be provided in the headers and is rate limited to 5 requests per second.

post/api/v1/company/async/search

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

OK

messagestring

The message response from the server.

tracking_idstring uuid nullable

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

Example response

{
  "message": "Request for info@example.com is processing.",
  "tracking_id": "00000000-0000-0000-0000-000000000000"
}

Changes

Changed in 2 of the 12 revisions of this API.1514

  • 955831a8d5e914See the full diff
    • ▲

      the request property became not nullable

      request-property-became-not-nullable

    • ▲

      the request property became not nullable

      request-property-became-not-nullable

    • ▲

      the request property became not nullable

      request-property-became-not-nullable

    • ▲

      the request property became not nullable

      request-property-became-not-nullable

    • ▲

      the request property became not nullable

      request-property-became-not-nullable

    • ▲

      the request property became not nullable

      request-property-became-not-nullable

    • ▲

      the request property became not nullable

      request-property-became-not-nullable

    • ▲

      the request property became not nullable

      request-property-became-not-nullable

    • ▲

      the request property became not nullable

      request-property-became-not-nullable

    • ▲

      the request property became not nullable

      request-property-became-not-nullable

    • ▲

      the request property became not nullable

      request-property-became-not-nullable

    • ▲

      the request property became not nullable

      request-property-became-not-nullable

    • ▲

      the request property became not nullable

      request-property-became-not-nullable

    • ▲

      the request property became not nullable

      request-property-became-not-nullable

  • fd8c32a19c7f114See the full diff
    • ▲

      response property tracking_id list-of-types was widened by adding types null to media type application/json of response 200

      response-property-list-of-types-widened

    • ○

      request property list-of-types was widened by adding types null to media type application/json

      request-property-list-of-types-widened

    • ○

      request property list-of-types was widened by adding types null to media type application/json

      request-property-list-of-types-widened

    • ○

      request property list-of-types was widened by adding types null to media type application/json

      request-property-list-of-types-widened

    • ○

      request property list-of-types was widened by adding types null to media type application/json

      request-property-list-of-types-widened

    • ○

      request property list-of-types was widened by adding types null to media type application/json

      request-property-list-of-types-widened

    • ○

      request property list-of-types was widened by adding types null to media type application/json

      request-property-list-of-types-widened

    • ○

      request property list-of-types was widened by adding types null to media type application/json

      request-property-list-of-types-widened

    • ○

      request property list-of-types was widened by adding types null to media type application/json

      request-property-list-of-types-widened

    • ○

      request property list-of-types was widened by adding types null to media type application/json

      request-property-list-of-types-widened

    • ○

      request property list-of-types was widened by adding types null to media type application/json

      request-property-list-of-types-widened

    • ○

      request property list-of-types was widened by adding types null to media type application/json

      request-property-list-of-types-widened

    • ○

      request property list-of-types was widened by adding types null to media type application/json

      request-property-list-of-types-widened

    • ○

      request property list-of-types was widened by adding types null to media type application/json

      request-property-list-of-types-widened

    • ○

      request property list-of-types was widened by adding types null to media type application/json

      request-property-list-of-types-widened