Search company
POSThttps://api.foxentry.com/company/search
This enpoint mainly serves as autocomplete but can be used to search for specific companies based on filter criteria as well. Foxentry will automatically offer you suggestions to complete the company you are writing down.
Pay attention to the client section in the request body. You can specify the user's location in order to receive more relevant suggestions.
Headers
Api-VersionstringAuthorizationstringrequiredBody params
requestobjectrequiredCustom ID assigned by you if you need so.
queryobjectrequiredParameters you want to validate or search for.
Type of search.
Searched value.
Company name.
Country code in format ISO-3166-1 alpha-2.
Company registration number (ID).
Company national TAX number. Currently available only for SK subjects.
Company VAT number.
optionsobjectOptions that change how the endpoint behaves.
Data scope of returned data.Default
basicArray of allowed data sources, which restricts countries the module searches. Although we use the request.client object to provide most relevant results, it is generally recommended to to limit this option to only the necessary sources - especially if you don't utilize the request.client object.Default
["CZ", "SK", "PL"]Whether or not to include entities that have already ended their existence in the output.Default
falseWhether to return locally formatted ZIP code or not. (130 00 vs 13000).Default
falseThis option determines the format in which the city is returned. Minimal = Praha, basic = Praha 8, extended = Praha 8 - Karlín.Default
basicThis option determines the format in which the country is returned. Supported formats: alpha2 = CZ, alpha3 = CZE, local = Česká republika, international = Czech republic, localShortened = Česko, internationalShortened = Czechia.Default
alpha2This option filters results by the legal form type.Default
anyPrefer = prefer results matching the filter parameters, limit = limit to results matching the filter parameters.Default
limitLimits number of results returned by the endpoint.Default
10If true, values with different format would be accepted. (Uppercase and diacritics).Default
trueIf true, alternative values for filter types would be accepted. Currently used mainly for the Polish companies names. (for example name of company: ELBI-WROCŁAW SP.Z O.O. ; alternative name: ELBI-WROCŁAW SPÓŁKA Z OGRANICZONĄ ODPOWIEDZIALNOŚCIĄ).Default
trueIf true, only exact match would be accepted. For example filter registrationID "0499" would return 0 results, since no company with the exact registration ID exists.Default
trueclientobjectInformation about your user, to make results more relevant.
Country code in ISO-3166-1 alpha-2 format.
Client's latitude
Client's longitude
Empty fields use the example value shown in grey. Everything you type here is written into the request on the right, and the other way round.
Responses
Response body · application/json
statusintegerStatus of API response.
requestobjectendpointstringcodestringCode of request.
customIdstring | nullCustom ID assigned by you if you need so.
queryobjecttypestringType of search.
nameregistrationNumbertaxNumbervatNumbervaluestringSearched value.
filterobjectAdditional filter in order to specify the search results. You can for example set as a filter country CZ, so the the search engine would look for the companies only in the Czech republic. Pay attention to the options, which determines how the filter should behave.
namestringCompany name.
countrystringCountry code in format ISO-3166-1 alpha-2.
registrationNumberstringCompany registration number (ID).
taxNumberstringCompany national TAX number. Currently available only for SK subjects.
vatNumberstringCompany VAT number.
optionsobjectQuery options.
dataScopestringData scope of returned data.
basicextendedfulldataSourcearray[string]Array of allowed data sources, which restricts countries the module searches. Although we use the request.client object to provide most relevant results, it is generally recommended to to limit this option to only the necessary sources - especially if you don't utilize the request.client object.
includeTerminatedSubjectsbooleanWhether or not to include entities that have already ended their existence in the output.
zipFormatbooleanWhether to return locally formatted ZIP code or not. (130 00 vs 13000).
cityFormatstringThis option determines the format in which the city is returned. Minimal = Praha, basic = Praha 8, extended = Praha 8 - Karlín.
minimalbasicextendedcountryFormatstringThis option determines the format in which the country is returned. Supported formats: alpha2 = CZ, alpha3 = CZE, local = Česká republika, international = Czech republic, localShortened = Česko, internationalShortened = Czechia.
alpha2alpha3locallocalShortenedinternationalinternationalShortenedlegalFormTypestring | nullThis option filters results by the legal form type.
juridicalphysicalanyfilterModestringPrefer = prefer results matching the filter parameters, limit = limit to results matching the filter parameters.
limitpreferresultsLimitintegerLimits number of results returned by the endpoint.
filterAcceptFormatbooleanIf true, values with different format would be accepted. (Uppercase and diacritics).
filterAcceptAlternativesbooleanIf true, alternative values for filter types would be accepted. Currently used mainly for the Polish companies names. (for example name of company: ELBI-WROCŁAW SP.Z O.O. ; alternative name: ELBI-WROCŁAW SPÓŁKA Z OGRANICZONĄ ODPOWIEDZIALNOŚCIĄ).
filterExactMatchbooleanIf true, only exact match would be accepted. For example filter registrationID "0499" would return 0 results, since no company with the exact registration ID exists.
clientobjectAdditional information about your user (from whom you've obtained the data sent in query) to increase relevance of the results. If you do not wish to provide this information, you can limit results to relevant countries using the dataSource parameter present in some modules.
ipstringcountrystringCountry code in ISO-3166-1 alpha-2 format.
locationobjectLatitude & longitude of the client's approximate location.
latnumberClient's latitude
lonnumberClient's longitude
responseobjectresultsCountnumberNumber of results.
resultsOffsetintegerPagination offset
resultsTotalinteger | nullMaximum number of results that can be returned. Null if pagination not available.
resultsarray[object]flagsobjectisActivebooleanIndicates whether the company is currently active.
isVatPayerbooleanIndicates whether the company is a VAT payer. Available in extended and full datascopes.git sta
isVatSubjectbooleanIndicates whether the company is a VAT subject. Available in extended and full datascopes.
isInInsolvencybooleanIndicates whether the company is currently in insolvency. Available in full datascope in select countries.
dataobjectcountrystring | nullCountry code in format ISO-3166-1 alpha-2.
uuidstring | nullnamestring | nullName of company.
registrationNumberstring | nullCompany registration number.
taxNumberstring | nullCompany tax number.
vatNumberstring | nullCompany vat number.
vatNumberSpecialstring | nullSpecial vat number in case that subject is part of VAT group.
addressobjectLocation data
dataobjectaddressOfficialobject | nullAddress data from the official registry. Not validated by Foxentry.
dataobject | nullnacearray[object]Types of business
codestringCode of business.
namestringName of business
isPrimaryboolean | nullDetermines if it is the main object of the business.
databoxesarray[object]Company's electronic mail boxes (databoxes).
codestringCode of databox.
namestringName of databox.
receivingMessagesbooleanWhether the databox is set to receive messages from public as well.
registrationsarray[object]Information about the company's registrations.
typestringType of registration.
businessRegistervatRegisterdataobjectlegalFormobjecttypestringLegal form type
juridicalphysicalNonecodestring | nullCode of legal form.
namestring | nullName of legal form.
legalFormSpecificobjectSpecific cases of legalForm.
codestring | nullCode of legal form for Polish companies.
namestring | nullName of legal form for Polish companies.
esa2010objectThe European System of National and Regional Accounts.
codestring | nullCode of ESA2010.
namestring | nullName of ESA2010.
datesobjectImportant dates associated with company.
createdstring | nullCompany creation date.
terminatedstring | nullCompany termination date.
employeesobjectEmployees information.
countnumber | nullNumber of employees.
categorystring | nullCategory of employees.
insolvencyobject | nullCompany insolvency status with history
historyarray[object]businessPremisesarray[object]labelstring | nullLabel of business premises
addressobjectactivitySubjectsstringTypes of activity associated with the premise.
authorityarray[object]namestringName of authority.
membersarray[object]Members associated with company.
decisionsarray[string]Information about the company's manner of decision making.
capitalobjectCompany's funding
valueobjectshareholdersarray[object]Information about shareholders.
stocksarray[string]Textual description of the stock ammount and value.
tradeLicencesarray[object]Trade licence information.
typestringType of trade licence.
namestringName of trade licenses.
validobjectinterruptedobjectDates of interuption.
responsiblePersonstring | nullResponsible person.
activitySubjectsarray[string]vatobjectVat payer information.
statusstring | nullVat current status. Payer, non payer and subject. Subject means the company is a VAT payer only for non domestic transactions (identifikovaná osoba).
payernonpayersubjectreliabilityobjectReliability of the VAT payer.
bankAccountsarray[object]Bank accounts associated with the VAT payer.
historyarray[object]History of the VAT payer.
errorsarray[string]List of errors related to the request. Should be empty if the request finished successfully.
Response body · application/json
statusintegerHTTP status of the response.
errorsarray[object]What went wrong.
groupstringError group.
REQUESTAUTHVALUESERVERtypestringError type.
subtypestring | nullMore specific error type.
severitystringHow serious the error is.
criticalwarninginforelatedToarray[string]Query parameters the error relates to.
descriptionstringHuman readable description.
Response body · application/json
statusintegerHTTP status of the response.
errorsarray[object]What went wrong.
groupstringError group.
REQUESTAUTHVALUESERVERtypestringError type.
subtypestring | nullMore specific error type.
severitystringHow serious the error is.
criticalwarninginforelatedToarray[string]Query parameters the error relates to.
descriptionstringHuman readable description.
Response body · application/json
statusintegerHTTP status of the response.
errorsarray[object]What went wrong.
groupstringError group.
REQUESTAUTHVALUESERVERtypestringError type.
subtypestring | nullMore specific error type.
severitystringHow serious the error is.
criticalwarninginforelatedToarray[string]Query parameters the error relates to.
descriptionstringHuman readable description.
Response body · application/json
statusintegerHTTP status of the response.
errorsarray[object]What went wrong.
groupstringError group.
REQUESTAUTHVALUESERVERtypestringError type.
subtypestring | nullMore specific error type.
severitystringHow serious the error is.
criticalwarninginforelatedToarray[string]Query parameters the error relates to.
descriptionstringHuman readable description.
Response body · application/json
statusintegerHTTP status of the response.
errorsarray[object]What went wrong.
groupstringError group.
REQUESTAUTHVALUESERVERtypestringError type.
subtypestring | nullMore specific error type.
severitystringHow serious the error is.
criticalwarninginforelatedToarray[string]Query parameters the error relates to.
descriptionstringHuman readable description.
Response body · application/json
statusintegerHTTP status of the response.
errorsarray[object]What went wrong.
groupstringError group.
REQUESTAUTHVALUESERVERtypestringError type.
subtypestring | nullMore specific error type.
severitystringHow serious the error is.
criticalwarninginforelatedToarray[string]Query parameters the error relates to.
descriptionstringHuman readable description.
Response body · application/json
statusintegerHTTP status of the response.
errorsarray[object]What went wrong.
groupstringError group.
REQUESTAUTHVALUESERVERtypestringError type.
subtypestring | nullMore specific error type.
severitystringHow serious the error is.
criticalwarninginforelatedToarray[string]Query parameters the error relates to.
descriptionstringHuman readable description.
Response body · application/json
statusintegerHTTP status of the response.
errorsarray[object]What went wrong.
groupstringError group.
REQUESTAUTHVALUESERVERtypestringError type.
subtypestring | nullMore specific error type.
severitystringHow serious the error is.
criticalwarninginforelatedToarray[string]Query parameters the error relates to.
descriptionstringHuman readable description.
Response body · application/json
statusintegerHTTP status of the response.
errorsarray[object]What went wrong.
groupstringError group.
REQUESTAUTHVALUESERVERtypestringError type.
subtypestring | nullMore specific error type.
severitystringHow serious the error is.
criticalwarninginforelatedToarray[string]Query parameters the error relates to.
descriptionstringHuman readable description.