BusinessSearch.updatedCopy Pagewbhk BusinessSearch.updatedEmitted when a Business search has been updated. E.g. if the IRS was down for tin matching, the search may be updated at a later date with the correct tin_matched result.Payload__event__objectDefaults to [object Object]WebhookMetadata objectiduuidrequiredThe unique identifier of the search.optionsarray of stringsrequiredOptional features enabled during search execution.Options*Allowed:Order.WebsiteAnalysisOrder.NaicsPredictionOrder.PepOrder.EnhancedADD stringorderablesarray of objectsDefaults to []A list of associated requests that were made as a result of ordering optional features through the options when the search was submitted. This allows you to correlate associated operations that will complete asynchronously once the search is completed. For example, if you order Website Analysis when issuing the search you will have a corresponding WebsiteAnalysisRequest orderable containing the ID and URL of the forthcoming associated operations.OrderablesADD objectuserUserAttributionResponse (v1) | nullDetails on the User who performed the search.user UserAttributionResponse (v1) | nullstatestringenumrequiredThe current state of the search.PENDINGEXECUTINGCOMPLETEDFAILEDCANCELLEDAllowed:PENDINGEXECUTINGCOMPLETEDFAILEDCANCELLEDnamestringrequiredThe name inputted in the search.addressstringrequiredThe address string inputted in the search.search_addressAddressSummaryResponse (v1) | nullThe sanitized address inputted in the search.search_address AddressSummaryResponse (v1) | nullofficer_namesarray | nullThe officer names inputted in the search.Officer Names array | nullalternative_namesarray | nullThe alternative names inputted in the search.Alternative Names array | nullwebsitestringnullThe website inputted in the search.phone_numberstringnullThe phone number inputted in the search.emailstringnullThe email inputted in the search.tinstringnullThe TIN/EIN inputted in the search.reference_idstringnullThe reference ID inputted in the search.tin_matchedbooleannullIndicates whether the inputted TIN/EIN was a match, per the IRS. If a TIN is submitted with the search, and a response of null is returned, this indicates that the IRS validation service is currently having a temporary outage. Please see status.baselayer.com for status updates.truefalsetin_match_typeIRSTINMatchType | nullThe type of match that occurred.tin_match_type IRSTINMatchType | nulltin_potential_matchstringnulldeprecatedIf the inputted TIN/EIN was not a match, but is a real TIN/EIN, this field returns the name of the entity to whom that TIN/EIN actually belongs.watchlist_hitsarray of objectsDefaults to []The watchlist hits associated with the searched business.Watchlist HitsADD objectbusiness_name_matchMatchType | nullIndicates how close the inputted name matches the found business entity.business_name_match MatchType | nullbusiness_address_matchAddressMatchType | nullIndicates how close the inputted address matches the found business entity.business_address_match AddressMatchType | nullbusiness_officer_matchMatchType | nullIndicates how close the inputted officer name matches the found business officers.business_officer_match MatchType | nullregistered_agent_matchMatchType | nullIndicates how close the inputted officer name matches the found business registered agent.registered_agent_match MatchType | nullbusiness_website_matchbooleannullDoes the inputted website match the found business website?truefalsebusiness_website_redirect_matchbooleannullIndicates whether the website match was established via a cross-domain redirect. True when business_website_match is True and the match was found because one website redirects to the other's domain.truefalsesearch_address_validation_levelAddressValidationLevel | nullThe validation level derived during address normalization.search_address_validation_level AddressValidationLevel | nullcreated_atdate-timerequiredThe datetime the search was created.updated_atstringnullThe datetime the search was updated at (generally when the search completed).verifiedbooleannullIndicates whether the found business was a close enough match to be considered verified.truefalsescoresarray | nullAn array containing Baselayer's ratings.Scores array | nullerrorstringnullAny errors that occurred.warningsarray of stringsDefaults to []Any warnings that occurred.WarningsADD stringbusinessBusinessResponse (v1) | nullA representation of the Business identified by the Search.business BusinessResponse (v1) | nullurlurirequiredlength between 1 and 2083The API URL to retrieve the search.status_urlurirequiredlength between 1 and 2083The API URL to retrieve the status of the search.business_urlstringnullrequiredlength between 1 and 2083The API URL to retrieve the business details.console_urlurilength between 1 and 2083The URL to the search details in the console.Responses 200Successful Response 422Validation ErrorUpdated 3 months ago BusinessSearch.failedBusiness Search Legacy UpdatedDid this page help you?YesNo
