Validate company data

POSThttps://api.foxentry.com/company/validate

This endpoint requires at least 1 query parameter and will check if the parameters and their combinations are valid. Returns information about the company based on the datascope set in the options.

Foxentry validator is able not only to evaluate the validity of the inputed information but it also can fix various typos, errors and missing data. Foxentry can also suggest more suitable alternatives to the data sent in query. Please pay attention to the result, resultCorrected and suggestions in the response.

Always check result.proposal in the response for a proposed solution by Foxentry how you should process the response in your form or application.

Headers

Api-Versionstring

API version the request is sent to. Without it the latest version is used.

Authorizationstringrequired

Your API key, sent as a Bearer token. Same key as in the key box on the right.

Body params

requestobjectrequired

customIdstring | nullCustom ID assigned by you if you need so.

queryobjectrequired

Parameters you want to validate or search for.

namestringCompany name

countrystringCountry codes in format ISO-3166-1 alpha-2

registrationNumberstringCompany registration number (ID)

taxNumberstringCompany national TAX number. Currently available only for SK subjects.

vatNumberstringCompany VAT number

optionsobject

Options that change how the endpoint behaves.

resultsLimitintegerLimits number of results returned by the endpoint.Default 10

dataScopestringData scope of returned data.Default basic

dataSourcearray[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.Default ["CZ", "SK", "PL"]

includeTerminatedSubjectsbooleanWhether or not to include entities that have already ended their existence in the output.Default false

zipFormatbooleanWhether to return locally formatted ZIP code or not. (130 00 vs 13000).Default false

cityFormatstringThis option determines the format in which the city is returned. Minimal = Praha, basic = Praha 8, extended = Praha 8 - Karlín.Default basic

countryFormatstringThis 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 alpha2

legalFormTypestring | nullThis option filters results by the legal form type.Default any

filterModestringPrefer = prefer results matching the filter parameters, limit = limit to results matching the filter parameters.Default limit

correctionModestringThis option determines how automatic corrections are handled. You can choose between full to allow all corrections, format to fix formatting only, suggestion to return corrected data in suggestions, or none for no corrections to be applied. Quality of data differs between countries, therefore it might be desirable to limit the correction mode in some cases.Default full

correctionModeCrossCountrystringThis option determines how automatic corrections are handled when a result from another country matches your query. You can choose between full to allow all corrections, format to fix formatting only, suggestion to return corrected data in suggestions, or none for no corrections to be applied. Quality of data differs between countries, therefore it might be desirable to limit the correction mode in some cases.Default format

clientobject

Information about your user, to make results more relevant.

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

statusinteger

Status of API response.

requestobject

endpointstring

codestring

Code of request.

customIdstring | null

Custom ID assigned by you if you need so.

queryobject

optionsobject

Query options.

resultsLimitinteger

Limits number of results returned by the endpoint.

dataScopestring

Data scope of returned data.

basicextendedfull

dataSourcearray[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.

includeTerminatedSubjectsboolean

Whether or not to include entities that have already ended their existence in the output.

zipFormatboolean

Whether to return locally formatted ZIP code or not. (130 00 vs 13000).

cityFormatstring

This option determines the format in which the city is returned. Minimal = Praha, basic = Praha 8, extended = Praha 8 - Karlín.

minimalbasicextended

countryFormatstring

This 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.

alpha2alpha3locallocalShortenedinternationalinternationalShortened

legalFormTypestring | null

This option filters results by the legal form type.

juridicalphysicalany

filterModestring

Prefer = prefer results matching the filter parameters, limit = limit to results matching the filter parameters.

limitprefer

correctionModestring

This option determines how automatic corrections are handled. You can choose between full to allow all corrections, format to fix formatting only, suggestion to return corrected data in suggestions, or none for no corrections to be applied. Quality of data differs between countries, therefore it might be desirable to limit the correction mode in some cases.

fullformatsuggestionnone

correctionModeCrossCountrystring

This option determines how automatic corrections are handled when a result from another country matches your query. You can choose between full to allow all corrections, format to fix formatting only, suggestion to return corrected data in suggestions, or none for no corrections to be applied. Quality of data differs between countries, therefore it might be desirable to limit the correction mode in some cases.

fullformatsuggestionnone

clientobject

Additional 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.

responseobject

resultobject

Evaluation of the sent query.

isValidboolean

Determines the validity of the response. True = valid response / False = invalid response. Can be also null, which indicates a non-specific error.

proposalstring

Proposed solution by Foxentry how you should process the response in your form or application.

validvalidWithSuggestioninvalidinvalidWithCorrectioninvalidWithPartialCorrectioninvalidWithSuggestioninvalidWithCorrectionWithSuggestion

errorsarray[object]

List of errors related to the query. Provides information about which query fields were deemed invalid and why.

flagsobject

dataobject

countrystring | null

Country code in format ISO-3166-1 alpha-2.

uuidstring | null

namestring | null

Name of company.

registrationNumberstring | null

Company registration number.

taxNumberstring | null

Company tax number.

vatNumberstring | null

Company vat number.

vatNumberSpecialstring | null

Special vat number in case that subject is part of VAT group.

addressobject

Location data

addressOfficialobject | null

Address data from the official registry. Not validated by Foxentry.

nacearray[object]

Types of business

databoxesarray[object]

Company's electronic mail boxes (databoxes).

registrationsarray[object]

Information about the company's registrations.

legalFormobject

legalFormSpecificobject

Specific cases of legalForm.

esa2010object

The European System of National and Regional Accounts.

datesobject

Important dates associated with company.

employeesobject

Employees information.

insolvencyobject | null

Company insolvency status with history

businessPremisesarray[object]

authorityarray[object]

capitalobject

Company's funding

tradeLicencesarray[object]

Trade licence information.

vatobject

Vat payer information.

resultCorrectedobject

Company validation result

isValidboolean

Determines the validity of the response. True = valid response / False = invalid response. Can be also null, which indicates a non-specific error.

errorsarray[object]

List of errors related to the query. Provides information about which query fields were deemed invalid and why.

flagsobject

dataobject

countrystring | null

Country code in format ISO-3166-1 alpha-2.

uuidstring | null

namestring | null

Name of company.

registrationNumberstring | null

Company registration number.

taxNumberstring | null

Company tax number.

vatNumberstring | null

Company vat number.

vatNumberSpecialstring | null

Special vat number in case that subject is part of VAT group.

addressobject

Location data

addressOfficialobject | null

Address data from the official registry. Not validated by Foxentry.

nacearray[object]

Types of business

databoxesarray[object]

Company's electronic mail boxes (databoxes).

registrationsarray[object]

Information about the company's registrations.

legalFormobject

legalFormSpecificobject

Specific cases of legalForm.

esa2010object

The European System of National and Regional Accounts.

datesobject

Important dates associated with company.

employeesobject

Employees information.

insolvencyobject | null

Company insolvency status with history

businessPremisesarray[object]

authorityarray[object]

capitalobject

Company's funding

tradeLicencesarray[object]

Trade licence information.

vatobject

Vat payer information.

fixesarray[object]

List of all changes applied to the query data in order to get the corrected result.

suggestionsarray[object]

Alternatives suggested for the sent query.

isValidboolean

Determines the validity of the response. True = valid response / False = invalid response. Can be also null, which indicates a non-specific error.

errorsarray[object]

List of errors related to the query. Provides information about which query fields were deemed invalid and why.

flagsobject

dataobject

countrystring | null

Country code in format ISO-3166-1 alpha-2.

uuidstring | null

namestring | null

Name of company.

registrationNumberstring | null

Company registration number.

taxNumberstring | null

Company tax number.

vatNumberstring | null

Company vat number.

vatNumberSpecialstring | null

Special vat number in case that subject is part of VAT group.

addressobject

Location data

addressOfficialobject | null

Address data from the official registry. Not validated by Foxentry.

nacearray[object]

Types of business

databoxesarray[object]

Company's electronic mail boxes (databoxes).

registrationsarray[object]

Information about the company's registrations.

legalFormobject

legalFormSpecificobject

Specific cases of legalForm.

esa2010object

The European System of National and Regional Accounts.

datesobject

Important dates associated with company.

employeesobject

Employees information.

insolvencyobject | null

Company insolvency status with history

businessPremisesarray[object]

authorityarray[object]

capitalobject

Company's funding

tradeLicencesarray[object]

Trade licence information.

vatobject

Vat payer information.

fixesarray[object]

List of all changes applied to the query data in order to get the corrected result.

errorsarray[string]

List of errors related to the request. Should be empty if the request finished successfully.