{ "openapi": "3.1.0", "info": { "version": "2.1", "title": "Foxentry API reference", "termsOfService": "https://foxentry.com/terms-and-conditions", "description": "# Welcome to the Foxentry API version 2.1\nWelcome to the new version of Foxentry API 2.1 Our API is designed to enhance your data management experience and provide you with even more powerful tools to harness the potential of getting and working with data.\n## API usage\nThe Foxentry API is used to retrieve, validate, and modify user data. Using our API, you can obtain detailed information, validate customer input, and automatically edit it into the appropriate formats.

\nThe new version of our API also supports automatic corrections, offering you suggestions and corrections for your inputs so that you always get the right data.\n## Features in version 2.1\nFoxentry now provides you with a wide variety of information by providing a comprehensive set of endpoints for numerous data categories. Whether you need information on a Company, an Email address, a Location, a Name, or a Phone number, Foxentry can help. We are pleased to offer our valued clients a total of 12 endpoints in this new version.

\nWith the latest version of the Foxentry API, we have implemented advanced Corrections and Suggestions. This means that the data you receive will be more refined and precise, enabling you to make data-driven decisions with the utmost confidence.

\nThe latest Foxentry API version includes HTTP global errors but also local error messages, recognizing the need for clear and useful error feedback. If a problem happens while using the API, you will be notified in descriptive error messages, providing a smoother integration process and quicker issue resolution.

\nTo further enhance data quality, Foxentry has introduced Fixes in the new version of the API. This means that even if there are minor errors in the data you provide, the API will intelligently identify and correct them, reducing the risk of inaccuracies in your results.\n## API call\nEach API call should be directed to a specific endpoint URL. Each API call to an endpoint can only contain one API request.\n## Environment\nProduction: https://api.foxentry.com/\n## Supported countries\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
EndpointSupported countries
company/validateCzech Republic, Hungary, Poland, and Slovakia
company/searchCzech Republic, Hungary, Poland, and Slovakia
company/getCzech Republic, Hungary, Poland, and Slovakia
email/validateWorldwide
email/searchWorldwide
location/validateAlbania, Andorra, Austria, Belgium, Bosnia and Herzegovina, Bulgaria, Croatia, Cyprus, Czech Republic, Denmark, France, Germany, Greece, Hungary, Iceland, Italy, Kosovo, Liechtenstein, Luxembourg, Malta, Monaco, Montenegro, Netherlands, North Macedonia, Poland, Romania, San Marino, Serbia, Slovakia, Slovenia, Spain, Switzerland, United Kingdom, and Vatican City
location/searchAlbania, Andorra, Austria, Belgium, Bosnia and Herzegovina, Bulgaria, Croatia, Cyprus, Czech Republic, Denmark, France, Germany, Greece, Hungary, Iceland, Italy, Kosovo, Liechtenstein, Luxembourg, Malta, Monaco, Montenegro, Netherlands, North Macedonia, Poland, Romania, San Marino, Serbia, Slovakia, Slovenia, Spain, Switzerland, United Kingdom, and Vatican City
location/getAlbania, Andorra, Austria, Belgium, Bosnia and Herzegovina, Bulgaria, Croatia, Cyprus, Czech Republic, Denmark, France, Germany, Greece, Hungary, Iceland, Italy, Kosovo, Liechtenstein, Luxembourg, Malta, Monaco, Montenegro, Netherlands, North Macedonia, Poland, Romania, San Marino, Serbia, Slovakia, Slovenia, Spain, Switzerland, United Kingdom, and Vatican City
location/localizeAlbania, Andorra, Austria, Belgium, Bosnia and Herzegovina, Bulgaria, Croatia, Cyprus, Czech Republic, Denmark, France, Germany, Greece, Hungary, Iceland, Italy, Kosovo, Liechtenstein, Luxembourg, Malta, Monaco, Montenegro, Netherlands, North Macedonia, Poland, Romania, San Marino, Serbia, Slovakia, Slovenia, Spain, Switzerland, United Kingdom, and Vatican City
name/validateCzech Republic and Slovakia
phone/validateWorldwide
\n\n## Security\nAs part of our commitment to data security, you are required to obtain a Bearer token from Foxentry. If you are a new user and do not have an API key, create your account at https://app.foxentry.com/registration and generate the key in your project settings. \n\n## Need help? \nShould you encounter any issues, have questions, or need assistance, please feel free to reach out to our dedicated support team at info@foxentry.com. We are here to help you make the most of our API and resolve any questions you may have.", "contact": { "name": "Foxentry", "email": "info@foxentry.com", "url": "https://www.foxentry.com" } }, "servers": [ { "url": "https://api.foxentry.com" } ], "paths": { "/company/validate": { "post": { "tags": [ "Company" ], "summary": "Validate company data", "description": "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 entered 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.", "operationId": "CompanyValidation", "parameters": [ { "$ref": "#/paths/~1company~1get/post/parameters/0" }, { "$ref": "#/paths/~1company~1get/post/parameters/1" } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "request": { "type": "object", "allOf": [ { "type": "object", "properties": { "customId": { "type": [ "string", "null" ], "description": "Custom ID assigned by you if you need so.", "example": "customer567914" }, "query": { "type": "object", "properties": { "name": { "type": "string", "description": "Company name", "example": "AVA Trans s.r.o." }, "country": { "type": "string", "description": "Country codes in format [ISO-3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)", "example": "SK" }, "registrationNumber": { "type": "string", "description": "Company registration number (ID)", "example": "52072169" }, "taxNumber": { "type": "string", "description": "Company national TAX number. Currently available only for SK subjects.", "example": "2120884337" }, "vatNumber": { "type": "string", "description": "Company VAT number", "example": "SK2120884337" } } }, "options": { "allOf": [ { "allOf": [ { "$ref": "#/paths/~1company~1get/post/requestBody/content/application~1json/schema/properties/request/allOf/0/properties/options" }, { "type": "object", "description": "Query options.", "properties": { "legalFormType": { "description": "This option filters results by the legal form type.", "type": [ "string", "null" ], "enum": [ "juridical", "physical", "any" ], "default": "any", "example": "any" }, "filterMode": { "type": "string", "description": "Prefer = prefer results matching the filter parameters, limit = limit to results matching the filter parameters.", "enum": [ "limit", "prefer" ], "example": "limit", "default": "limit" }, "correctionMode": { "description": "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.", "type": "string", "enum": [ "full", "format", "suggestion", "none" ], "default": "full", "example": "full" }, "correctionModeCrossCountry": { "description": "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.", "type": "string", "enum": [ "full", "format", "suggestion", "none" ], "default": "format", "example": "format" } } } ] } ], "properties": { "resultsLimit": { "type": "integer", "description": "Limits number of results returned by the endpoint.", "minimum": 1, "maximum": 20, "default": 10, "example": 10 } } }, "client": { "$ref": "#/paths/~1company~1get/post/requestBody/content/application~1json/schema/properties/request/allOf/0/properties/client" } } } ], "required": [ "query" ] } }, "required": [ "request" ] }, "examples": { "Request Example": { "value": { "request": { "query": { "name": "AVANTRO", "country": "CZ", "registrationNumber": "04997476" }, "options": { "dataScope": "basic", "resultsLimit": 10, "includeTerminatedSubjects": false, "cityFormat": "basic", "zipFormat": false }, "client": { "country": "CZ", "location": { "lat": 50.0628, "lon": 13.9271 } } } } } } } } }, "responses": { "200": { "description": "Successful response", "headers": { "foxentry-api-version": { "$ref": "#/paths/~1company~1get/post/responses/200/headers/foxentry-api-version" }, "foxentry-daily-credits-left": { "$ref": "#/paths/~1company~1get/post/responses/200/headers/foxentry-daily-credits-left" }, "foxentry-daily-credits-limit": { "$ref": "#/paths/~1company~1get/post/responses/200/headers/foxentry-daily-credits-limit" }, "foxentry-rate-limit": { "$ref": "#/paths/~1company~1get/post/responses/200/headers/foxentry-rate-limit" }, "foxentry-rate-limit-period": { "$ref": "#/paths/~1company~1get/post/responses/200/headers/foxentry-rate-limit-period" }, "foxentry-rate-limit-remaining": { "$ref": "#/paths/~1company~1get/post/responses/200/headers/foxentry-rate-limit-remaining" } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status of API response.", "example": 200 }, "request": { "allOf": [ { "type": "object", "properties": { "endpoint": { "example": "company/validate" } } }, { "$ref": "#/paths/~1company~1get/post/responses/200/content/application~1json/schema/properties/request/allOf/1" }, { "$ref": "#/paths/~1company~1validate/post/requestBody/content/application~1json/schema/properties/request/allOf/0" } ] }, "response": { "type": "object", "properties": { "result": { "type": "object", "description": "Evaluation of the sent query.", "properties": { "isValid": { "type": "boolean", "description": "Determines the validity of the response. True = valid response / False = invalid response. Can be also null, which indicates a non-specific error.", "example": false }, "proposal": { "type": "string", "examples": [ "valid", "validWithSuggestion", "invalid", "invalidWithSuggestion", "invalidWithCorrection", "invalidWithCorrectionWithSuggestion", "invalidWithPartialCorrection", "invalidWithPartialCorrectionWithSuggestion" ], "description": "Proposed solution by Foxentry how you should process the response in\nyour form or application.\n\nThe value is composed of three parts: the validity of `result`, the\nvalidity of `resultCorrected` (appending `WithCorrection` or\n`WithPartialCorrection`), and the presence of `suggestions`\n(appending `WithSuggestion`). It is always a string and is never null.\n\nComplete list of possible values:\n\n- `valid`\n- `validWithSuggestion`\n- `invalid`\n- `invalidWithSuggestion`\n- `invalidWithCorrection`\n- `invalidWithCorrectionWithSuggestion`\n- `invalidWithPartialCorrection`\n- `invalidWithPartialCorrectionWithSuggestion`" } }, "allOf": [ { "title": "Company validation result", "type": [ "object", "null" ], "properties": { "isValid": { "type": "boolean", "description": "Determines the validity of the response. True = valid response / False = invalid response. Can be also null, which indicates a non-specific error.", "example": true }, "errors": { "type": "array", "description": "List of errors related to the query. Provides information about which query fields were deemed invalid and why.", "items": { "anyOf": [ { "$ref": "#/paths/~1name~1validate/post/responses/200/content/application~1json/schema/properties/response/properties/result/allOf/0/properties/errors/items/anyOf/0" }, { "title": "Company specific syntax error", "type": "object", "properties": { "group": { "enum": [ "SYNTAX" ], "description": "Group of error.", "example": "SYNTAX" }, "type": { "enum": [ "VALUE_PART_EXTRA", "VALUE_PART_MISSING" ], "description": "Type of error.", "example": "VALUE_PART_EXTRA" }, "subtype": { "enum": [ "LEGAL_FORM" ], "description": "Subtype of error.", "example": "LEGAL_FORM" }, "severity": { "enum": [ "info", "warning", "critical" ], "description": "Severity of error. Info = cosmetic changes that don't change the overall meaning. Warning = typos and other errors that could affect the meaning. Critical = critical errors.", "example": "critical" }, "relatedTo": { "description": "List of the affected inputs.", "type": "array", "items": { "type": "string", "description": "Error related to.", "example": "name" } }, "description": { "type": [ "string", "null" ], "description": "Description of error.", "example": "Value contains duplicated legal form." } } }, { "$ref": "#/paths/~1name~1validate/post/responses/200/content/application~1json/schema/properties/response/properties/result/allOf/0/properties/errors/items/anyOf/2" }, { "$ref": "#/paths/~1name~1validate/post/responses/200/content/application~1json/schema/properties/response/properties/result/allOf/0/properties/errors/items/anyOf/3" } ] } } }, "required": [ "isValid", "errors" ], "allOf": [ { "$ref": "#/paths/~1company~1get/post/responses/200/content/application~1json/schema/properties/response/properties/results/items" } ] } ] }, "resultCorrected": { "oneOf": [ { "$ref": "#/paths/~1company~1validate/post/responses/200/content/application~1json/schema/properties/response/properties/suggestions/items" }, { "type": "null", "title": "No data" } ] }, "suggestions": { "type": "array", "description": "Alternatives suggested for the sent query.", "items": { "type": "object", "allOf": [ { "$ref": "#/paths/~1company~1validate/post/responses/200/content/application~1json/schema/properties/response/properties/result/allOf/0" }, { "type": "object", "properties": { "fixes": { "type": "array", "description": "List of all changes applied to the query data in order to get the corrected result.", "items": { "anyOf": [ { "$ref": "#/paths/~1name~1validate/post/responses/200/content/application~1json/schema/properties/response/properties/suggestions/items/allOf/1/properties/fixes/items/anyOf/0" }, { "$ref": "#/paths/~1name~1validate/post/responses/200/content/application~1json/schema/properties/response/properties/suggestions/items/allOf/1/properties/fixes/items/anyOf/1" }, { "title": "Company specific syntax fix", "type": "object", "properties": { "group": { "enum": [ "SYNTAX" ], "description": "Group of fix.", "example": "SYNTAX" }, "type": { "enum": [ "VALUE_PART_ADDED", "VALUE_PART_CHANGED", "VALUE_PART_REMOVED" ], "description": "Type of fix.", "example": "VALUE_PART_ADDED" }, "subtype": { "enum": [ "LEGAL_FORM" ], "description": "Subtype of fix.", "example": "LEGAL_FORM" }, "data": { "$ref": "#/paths/~1name~1validate/post/responses/200/content/application~1json/schema/properties/response/properties/suggestions/items/allOf/1/properties/fixes/items/anyOf/0/properties/data" } } }, { "$ref": "#/paths/~1name~1validate/post/responses/200/content/application~1json/schema/properties/response/properties/suggestions/items/allOf/1/properties/fixes/items/anyOf/2" } ] } } } } ], "required": [ "isValid", "errors", "fixes" ] } } }, "required": [ "result", "suggestions" ] }, "errors": { "description": "List of errors related to the request. Should be empty if the request finished successfully.", "type": "array", "items": {}, "maxItems": 0 } }, "required": [ "status", "request", "response" ] }, "examples": { "valid": { "value": { "status": 200, "request": { "endpoint": "company/validate", "code": "7fb7cd3c-d5b0-405e-ae04-3e14ecdc1904", "query": { "name": "AVANTRO s.r.o.", "registrationNumber": "04997476", "country": "CZ" }, "options": { "dataSource": [ "CZ", "SK", "PL" ], "dataScope": "basic", "includeTerminatedSubjects": false, "resultsLimit": 10, "nameFormat": "normalized", "countryFormat": "alpha2", "cityFormat": "basic", "zipFormat": false, "legalFormType": "any", "correctionMode": "full", "correctionModeCrossCountry": "format" } }, "response": { "result": { "isValid": true, "proposal": "valid", "data": { "uuid": "ca3665de-ded1-47f7-9bcd-b8c3eb8c52e1", "country": "CZ", "name": "AVANTRO s.r.o.", "nameOfficial": "AVANTRO s.r.o.", "nameAlternative": null, "nameNormalized": "AVANTRO s.r.o.", "registrationNumber": "04997476", "taxNumber": null, "vatNumber": "CZ04997476", "vatNumberSpecial": null, "address": { "data": { "country": "CZ", "state": null, "region": "Hlavní město Praha", "district": "území Hlavního města Prahy", "ids": { "internal": "d2ade877-1e95-4a83-baa6-5431ce5b3ca8", "external": "22349995" }, "street": "Thámova", "number": { "type": "č.p.", "part1": "137", "part1Number": "137", "part1Letter": null, "part2": "16", "part2Number": "16", "part2Letter": null, "full": "137/16" }, "streetWithNumber": "Thámova 137/16", "city": "Praha 8", "zip": "18600", "full": "Thámova 137/16, 18600 Praha 8" } }, "addressOfficial": { "data": { "country": "CZ", "street": "Thámova", "number": { "part1": null, "part1Number": null, "part1Letter": null, "part2": null, "part2Number": null, "part2Letter": null, "full": "137/16" }, "streetWithNumber": "Thámova 137/16", "city": "Praha", "zip": "18600", "full": "Thámova 137/16, 18600 Praha" } }, "legalForm": { "type": "juridical" } }, "flags": { "isActive": true }, "errors": [] }, "resultCorrected": null, "suggestions": [] }, "errors": [] } }, "invalid": { "value": { "status": 200, "request": { "endpoint": "company/validate", "code": "69294ba9-05c3-4565-ae84-380c8e428ec4", "query": { "name": "AVANTRO s.r.o.", "registrationNumber": "25547", "country": "CZ" }, "options": { "dataSource": [ "CZ", "SK", "PL" ], "dataScope": "basic", "includeTerminatedSubjects": false, "resultsLimit": 10, "nameFormat": "normalized", "countryFormat": "alpha2", "cityFormat": "basic", "zipFormat": false, "legalFormType": "any", "correctionMode": "full", "correctionModeCrossCountry": "format" } }, "response": { "result": { "isValid": false, "proposal": "invalid", "data": { "uuid": null, "country": "CZ", "name": "AVANTRO s.r.o.", "nameOfficial": null, "nameAlternative": null, "nameNormalized": null, "registrationNumber": "25547", "taxNumber": null, "vatNumber": null, "vatNumberSpecial": null, "address": null, "addressOfficial": null, "legalForm": { "type": null } }, "flags": { "isActive": null }, "errors": [ { "group": "VALUE", "type": "INVALID", "subtype": null, "severity": "critical", "relatedTo": [ "registrationNumber" ], "description": "Value is not valid." } ] }, "resultCorrected": null, "suggestions": [] }, "errors": [] } }, "invalidWithSuggestion": { "value": { "status": 200, "request": { "endpoint": "company/validate", "code": "3c0221e2-ba0d-4ae8-8691-264db0789d4c", "query": { "registrationNumber": "0499747", "country": "CZ" }, "options": { "dataSource": [ "CZ", "SK", "PL" ], "dataScope": "basic", "includeTerminatedSubjects": false, "resultsLimit": 10, "nameFormat": "normalized", "countryFormat": "alpha2", "cityFormat": "basic", "zipFormat": false, "legalFormType": "any", "correctionMode": "full", "correctionModeCrossCountry": "format" } }, "response": { "result": { "isValid": false, "proposal": "invalid", "data": { "uuid": null, "country": "CZ", "name": null, "nameOfficial": null, "nameAlternative": null, "nameNormalized": null, "registrationNumber": "0499747", "taxNumber": null, "vatNumber": null, "vatNumberSpecial": null, "address": null, "addressOfficial": null, "legalForm": { "type": null } }, "flags": { "isActive": null }, "errors": [ { "group": "VALUE", "type": "INVALID", "subtype": null, "severity": "critical", "relatedTo": [ "registrationNumber" ], "description": "Value is not valid." } ] }, "resultCorrected": null, "suggestions": [] }, "errors": [] } }, "invalidWithCorrection": { "value": { "status": 200, "request": { "endpoint": "company/validate", "code": "18982007-ac0e-4af8-a525-07e6feacb4b6", "query": { "name": "AVANTRO", "registrationNumber": "04997476", "country": "CZ" }, "options": { "dataSource": [ "CZ", "SK", "PL" ], "dataScope": "basic", "includeTerminatedSubjects": false, "resultsLimit": 10, "nameFormat": "normalized", "countryFormat": "alpha2", "cityFormat": "basic", "zipFormat": false, "legalFormType": "any", "correctionMode": "full", "correctionModeCrossCountry": "format" } }, "response": { "result": { "isValid": false, "proposal": "invalidWithCorrection", "data": { "uuid": null, "country": "CZ", "name": "AVANTRO", "nameOfficial": null, "nameAlternative": null, "nameNormalized": null, "registrationNumber": "04997476", "taxNumber": null, "vatNumber": null, "vatNumberSpecial": null, "address": null, "addressOfficial": null, "legalForm": { "type": null } }, "flags": { "isActive": null }, "errors": [] }, "resultCorrected": { "isValid": true, "data": { "uuid": "ca3665de-ded1-47f7-9bcd-b8c3eb8c52e1", "country": "CZ", "name": "AVANTRO s.r.o.", "nameOfficial": "AVANTRO s.r.o.", "nameAlternative": null, "nameNormalized": "AVANTRO s.r.o.", "registrationNumber": "04997476", "taxNumber": null, "vatNumber": "CZ04997476", "vatNumberSpecial": null, "address": { "data": { "country": "CZ", "state": null, "region": "Hlavní město Praha", "district": "území Hlavního města Prahy", "ids": { "internal": "d2ade877-1e95-4a83-baa6-5431ce5b3ca8", "external": "22349995" }, "street": "Thámova", "number": { "type": "č.p.", "part1": "137", "part1Number": "137", "part1Letter": null, "part2": "16", "part2Number": "16", "part2Letter": null, "full": "137/16" }, "streetWithNumber": "Thámova 137/16", "city": "Praha 8", "zip": "18600", "full": "Thámova 137/16, 18600 Praha 8" } }, "addressOfficial": { "data": { "country": "CZ", "street": "Thámova", "number": { "part1": null, "part1Number": null, "part1Letter": null, "part2": null, "part2Number": null, "part2Letter": null, "full": "137/16" }, "streetWithNumber": "Thámova 137/16", "city": "Praha", "zip": "18600", "full": "Thámova 137/16, 18600 Praha" } }, "legalForm": { "type": "juridical" } }, "flags": { "isActive": true }, "errors": [], "fixes": [] }, "suggestions": [] }, "errors": [] } }, "invalidWithNameFormatCorrection": { "value": { "status": 200, "request": { "endpoint": "company/validate", "code": "42d73fa0-1d6e-4999-b640-3c9665eabfb9", "query": { "name": "Lidl Magyarország Bt.", "country": "HU" }, "options": { "dataSource": [ "CZ", "SK", "PL", "HU" ], "dataScope": "basic", "includeTerminatedSubjects": false, "resultsLimit": 10, "nameFormat": "official", "countryFormat": "alpha2", "cityFormat": "basic", "zipFormat": false, "legalFormType": "any", "correctionMode": "full", "correctionModeCrossCountry": "format" } }, "response": { "result": { "isValid": false, "proposal": "invalidWithCorrection", "data": { "uuid": null, "country": "HU", "name": "Lidl Magyarország Bt.", "nameOfficial": null, "nameAlternative": null, "nameNormalized": null, "registrationNumber": null, "taxNumber": null, "vatNumber": null, "vatNumberSpecial": null, "address": null, "addressOfficial": null, "legalForm": { "type": null } }, "flags": { "isActive": null }, "errors": [ { "group": "FORMAT", "type": "INVALID", "subtype": null, "severity": "info", "relatedTo": [ "name" ], "description": "Value has invalid format." } ] }, "resultCorrected": { "isValid": true, "data": { "uuid": "771e162a-a0a6-4881-94ff-69089f880426", "country": "HU", "name": "Lidl Magyarország Kereskedelmi Betéti Társaság", "nameOfficial": "Lidl Magyarország Kereskedelmi Betéti Társaság", "nameAlternative": "Lidl Magyarország Bt.", "nameNormalized": "Lidl Magyarország Bt.", "registrationNumber": "01-06-757718", "taxNumber": "21588017-2-44", "vatNumber": "HU21588017", "vatNumberSpecial": null, "address": { "data": { "country": "HU", "state": null, "region": "Budapest", "district": "Budapest", "ids": { "internal": "58ee8897-ac38-4479-8518-8b0772224c19", "external": null }, "street": "Rádl árok", "number": { "type": null, "part1": null, "part1Number": null, "part1Letter": null, "part2": null, "part2Number": null, "part2Letter": null, "full": "6" }, "streetWithNumber": "Rádl árok 6", "city": "Budapest", "zip": "1037", "full": "Rádl árok 6, 1037 Budapest" } }, "addressOfficial": { "data": { "country": "HU", "street": "Rádl árok", "number": { "part1": null, "part1Number": null, "part1Letter": null, "part2": null, "part2Number": null, "part2Letter": null, "full": "6" }, "streetWithNumber": "Rádl árok 6", "city": "Budapest", "zip": "1037", "full": "Rádl árok 6, 1037 Budapest" } }, "legalForm": { "type": "juridical" } }, "flags": { "isActive": true }, "errors": [], "fixes": [ { "group": "FORMAT", "type": "CHANGED", "subtype": null, "data": { "typeFrom": "name", "type": "name", "valueFrom": "Lidl Magyarország Bt.", "value": "Lidl Magyarország Kereskedelmi Betéti Társaság" } } ] }, "suggestions": [] }, "errors": [] } } } } } }, "400": { "$ref": "#/paths/~1company~1get/post/responses/400" }, "401": { "$ref": "#/paths/~1company~1get/post/responses/401" }, "402": { "$ref": "#/paths/~1company~1get/post/responses/402" }, "403": { "$ref": "#/paths/~1company~1get/post/responses/403" }, "404": { "$ref": "#/paths/~1company~1get/post/responses/404" }, "405": { "$ref": "#/paths/~1company~1get/post/responses/405" }, "429": { "$ref": "#/paths/~1company~1get/post/responses/429" }, "500": { "$ref": "#/paths/~1company~1get/post/responses/500" }, "503": { "$ref": "#/paths/~1company~1get/post/responses/503" } }, "security": [ { "BearerAuth": [] } ] } }, "/company/search": { "post": { "tags": [ "Company" ], "summary": "Search company", "description": "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.", "operationId": "CompanySearch", "parameters": [ { "$ref": "#/paths/~1company~1get/post/parameters/0" }, { "$ref": "#/paths/~1company~1get/post/parameters/1" } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "request": { "type": "object", "allOf": [ { "type": "object", "properties": { "customId": { "type": [ "string", "null" ], "description": "Custom ID assigned by you if you need so.", "example": "customer567914" }, "query": { "type": "object", "properties": { "type": { "type": "string", "description": "Type of search.", "enum": [ "name", "registrationNumber", "taxNumber", "vatNumber" ], "example": "name" }, "value": { "type": "string", "description": "Searched value.", "example": "Avantro" }, "filter": { "type": "object", "description": "Additional 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.", "properties": { "name": { "type": "string", "description": "Company name.", "example": "AVA Trans s.r.o." }, "country": { "type": "string", "description": "Country code in format [ISO-3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).", "example": "SK" }, "registrationNumber": { "type": "string", "description": "Company registration number (ID).", "example": "52072169" }, "taxNumber": { "type": "string", "description": "Company national TAX number. Currently available only for SK subjects.", "example": "2120884337" }, "vatNumber": { "type": "string", "description": "Company VAT number.", "example": "SK2120092029" } } } }, "required": [ "type", "value" ] }, "options": { "allOf": [ { "$ref": "#/paths/~1company~1get/post/requestBody/content/application~1json/schema/properties/request/allOf/0/properties/options" }, { "type": "object", "description": "Query options.", "properties": { "legalFormType": { "description": "This option filters results by the legal form type.", "type": [ "string", "null" ], "enum": [ "juridical", "physical", "any" ], "default": "any", "example": "any" }, "filterMode": { "type": "string", "description": "Prefer = prefer results matching the filter parameters, limit = limit to results matching the filter parameters.", "enum": [ "limit", "prefer" ], "example": "limit", "default": "limit" }, "resultsLimit": { "type": "integer", "description": "Limits number of results returned by the endpoint.", "minimum": 1, "maximum": 20, "default": 10, "example": 10 }, "filterAcceptFormat": { "type": "boolean", "description": "If true, values with different format would be accepted. (Uppercase and diacritics).", "example": true, "default": true }, "filterAcceptAlternatives": { "type": "boolean", "description": "If 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Ą).", "example": true, "default": true }, "filterExactMatch": { "type": "boolean", "description": "If 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.", "example": true, "default": true } } } ] }, "client": { "$ref": "#/paths/~1company~1get/post/requestBody/content/application~1json/schema/properties/request/allOf/0/properties/client" } } } ], "required": [ "query" ] } }, "required": [ "request" ] }, "examples": { "Request Example": { "value": { "request": { "query": { "type": "name", "value": "ava", "filter": { "country": "CZ" } }, "options": { "dataScope": "basic", "resultsLimit": 10, "includeTerminatedSubjects": false, "filterMode": "limit", "filterAcceptFormat": true, "filterExactMatch": true, "cityFormat": "basic", "zipFormat": false }, "client": { "country": "CZ", "location": { "lat": 50.0628, "lon": 13.9271 } } } } } } } } }, "responses": { "200": { "description": "Successful response", "headers": { "foxentry-api-version": { "$ref": "#/paths/~1company~1get/post/responses/200/headers/foxentry-api-version" }, "foxentry-daily-credits-left": { "$ref": "#/paths/~1company~1get/post/responses/200/headers/foxentry-daily-credits-left" }, "foxentry-daily-credits-limit": { "$ref": "#/paths/~1company~1get/post/responses/200/headers/foxentry-daily-credits-limit" }, "foxentry-rate-limit": { "$ref": "#/paths/~1company~1get/post/responses/200/headers/foxentry-rate-limit" }, "foxentry-rate-limit-period": { "$ref": "#/paths/~1company~1get/post/responses/200/headers/foxentry-rate-limit-period" }, "foxentry-rate-limit-remaining": { "$ref": "#/paths/~1company~1get/post/responses/200/headers/foxentry-rate-limit-remaining" } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status of API response.", "example": 200 }, "request": { "allOf": [ { "type": "object", "properties": { "endpoint": { "example": "company/search" } } }, { "$ref": "#/paths/~1company~1get/post/responses/200/content/application~1json/schema/properties/request/allOf/1" }, { "$ref": "#/paths/~1company~1search/post/requestBody/content/application~1json/schema/properties/request/allOf/0" } ] }, "response": { "type": "object", "properties": { "resultsCount": { "type": "number", "description": "Number of results.", "example": 1 }, "resultsOffset": { "type": "integer", "description": "Pagination offset", "format": "int32", "example": 0 }, "resultsTotal": { "type": [ "integer", "null" ], "description": "Maximum number of results that can be returned. Null if pagination not available.", "format": "int32", "example": 40 }, "results": { "type": "array", "items": { "$ref": "#/paths/~1company~1get/post/responses/200/content/application~1json/schema/properties/response/properties/results/items" } } }, "required": [ "resultsCount", "results" ] }, "errors": { "description": "List of errors related to the request. Should be empty if the request finished successfully.", "type": "array", "items": {}, "maxItems": 0 } }, "required": [ "status", "request", "response" ] }, "examples": { "searchName": { "value": { "status": 200, "request": { "endpoint": "company/search", "code": "ab694ecf-96d9-4904-ae53-3f948d0bc862", "query": { "type": "name", "value": "Avantro" }, "options": { "dataSource": [ "CZ", "SK", "PL" ], "dataScope": "basic", "includeTerminatedSubjects": false, "filterMode": "limit", "filterAcceptAlternatives": true, "filterAcceptFormat": true, "filterExactMatch": true, "resultsLimit": 10, "nameFormat": "normalized", "countryFormat": "alpha2", "cityFormat": "basic", "zipFormat": false, "legalFormType": "any", "allowPartialResults": false } }, "response": { "resultsCount": 1, "resultsOffset": 0, "resultsTotal": null, "results": [ { "data": { "uuid": "ca3665de-ded1-47f7-9bcd-b8c3eb8c52e1", "country": "CZ", "name": "AVANTRO s.r.o.", "nameOfficial": "AVANTRO s.r.o.", "nameAlternative": null, "nameNormalized": "AVANTRO s.r.o.", "registrationNumber": "04997476", "taxNumber": null, "vatNumber": "CZ04997476", "vatNumberSpecial": null, "address": { "data": { "country": "CZ", "state": null, "region": "Hlavní město Praha", "district": "území Hlavního města Prahy", "ids": { "internal": "d2ade877-1e95-4a83-baa6-5431ce5b3ca8", "external": "22349995" }, "street": "Thámova", "number": { "type": "č.p.", "part1": "137", "part1Number": "137", "part1Letter": null, "part2": "16", "part2Number": "16", "part2Letter": null, "full": "137/16" }, "streetWithNumber": "Thámova 137/16", "city": "Praha 8", "zip": "18600", "full": "Thámova 137/16, 18600 Praha 8" } }, "addressOfficial": { "data": { "country": "CZ", "street": "Thámova", "number": { "part1": null, "part1Number": null, "part1Letter": null, "part2": null, "part2Number": null, "part2Letter": null, "full": "137/16" }, "streetWithNumber": "Thámova 137/16", "city": "Praha", "zip": "18600", "full": "Thámova 137/16, 18600 Praha" } }, "legalForm": { "type": "juridical" } }, "flags": { "isActive": true } } ] }, "errors": [] } }, "searchRegistrationNumber": { "value": { "status": 200, "request": { "endpoint": "company/search", "code": "569ced07-fbd5-4144-a31a-945929a84e48", "query": { "type": "registrationNumber", "value": "049974" }, "options": { "dataSource": [ "CZ", "SK", "PL" ], "dataScope": "basic", "includeTerminatedSubjects": false, "filterMode": "limit", "filterAcceptAlternatives": true, "filterAcceptFormat": true, "filterExactMatch": true, "resultsLimit": 10, "nameFormat": "normalized", "countryFormat": "alpha2", "cityFormat": "basic", "zipFormat": false, "legalFormType": "any", "allowPartialResults": false } }, "response": { "resultsCount": 6, "resultsOffset": 0, "resultsTotal": null, "results": [ { "data": { "uuid": "ca3665de-ded1-47f7-9bcd-b8c3eb8c52e1", "country": "CZ", "name": "AVANTRO s.r.o.", "nameOfficial": "AVANTRO s.r.o.", "nameAlternative": null, "nameNormalized": "AVANTRO s.r.o.", "registrationNumber": "04997476", "taxNumber": null, "vatNumber": "CZ04997476", "vatNumberSpecial": null, "address": { "data": { "country": "CZ", "state": null, "region": "Hlavní město Praha", "district": "území Hlavního města Prahy", "ids": { "internal": "d2ade877-1e95-4a83-baa6-5431ce5b3ca8", "external": "22349995" }, "street": "Thámova", "number": { "type": "č.p.", "part1": "137", "part1Number": "137", "part1Letter": null, "part2": "16", "part2Number": "16", "part2Letter": null, "full": "137/16" }, "streetWithNumber": "Thámova 137/16", "city": "Praha 8", "zip": "18600", "full": "Thámova 137/16, 18600 Praha 8" } }, "addressOfficial": { "data": { "country": "CZ", "street": "Thámova", "number": { "part1": null, "part1Number": null, "part1Letter": null, "part2": null, "part2Number": null, "part2Letter": null, "full": "137/16" }, "streetWithNumber": "Thámova 137/16", "city": "Praha", "zip": "18600", "full": "Thámova 137/16, 18600 Praha" } }, "legalForm": { "type": "juridical" } }, "flags": { "isActive": true } }, { "data": { "uuid": "9542f9f1-2e1d-4c81-a87c-8762e31ff958", "country": "CZ", "name": "Manotick s.r.o.", "nameOfficial": "Manotick s.r.o.", "nameAlternative": null, "nameNormalized": "Manotick s.r.o.", "registrationNumber": "04997441", "taxNumber": null, "vatNumber": null, "vatNumberSpecial": null, "address": { "data": { "country": "CZ", "state": null, "region": "Hlavní město Praha", "district": "území Hlavního města Prahy", "ids": { "internal": "a31b9a04-efb2-4351-8b05-5ae90b185909", "external": "21715475" }, "street": "Křižovnická", "number": { "type": "č.p.", "part1": "86", "part1Number": "86", "part1Letter": null, "part2": "6", "part2Number": "6", "part2Letter": null, "full": "86/6" }, "streetWithNumber": "Křižovnická 86/6", "city": "Praha 1", "zip": "11000", "full": "Křižovnická 86/6, 11000 Praha 1" } }, "addressOfficial": { "data": { "country": "CZ", "street": "Křižovnická", "number": { "part1": null, "part1Number": null, "part1Letter": null, "part2": null, "part2Number": null, "part2Letter": null, "full": "86/6" }, "streetWithNumber": "Křižovnická 86/6", "city": "Praha", "zip": "11000", "full": "Křižovnická 86/6, 11000 Praha" } }, "legalForm": { "type": "juridical" } }, "flags": { "isActive": true } }, { "data": { "uuid": "75809988-2e08-4ac4-ba73-25e8528a4aab", "country": "CZ", "name": "VEMIO s.r.o.", "nameOfficial": "VEMIO s.r.o.", "nameAlternative": null, "nameNormalized": "VEMIO s.r.o.", "registrationNumber": "04997468", "taxNumber": null, "vatNumber": null, "vatNumberSpecial": null, "address": { "data": { "country": "CZ", "state": null, "region": "Plzeňský kraj", "district": "Plzeň-město", "ids": { "internal": "bac4bac1-8d64-4c8e-b937-fa417f7512ab", "external": "24534161" }, "street": "Plovární", "number": { "type": "č.p.", "part1": "478", "part1Number": "478", "part1Letter": null, "part2": "1", "part2Number": "1", "part2Letter": null, "full": "478/1" }, "streetWithNumber": "Plovární 478/1", "city": "Plzeň", "zip": "30100", "full": "Plovární 478/1, 30100 Plzeň" } }, "addressOfficial": { "data": { "country": "CZ", "street": "Plovární", "number": { "part1": null, "part1Number": null, "part1Letter": null, "part2": null, "part2Number": null, "part2Letter": null, "full": "478/1" }, "streetWithNumber": "Plovární 478/1", "city": "Plzeň", "zip": "30100", "full": "Plovární 478/1, 30100 Plzeň" } }, "legalForm": { "type": "juridical" } }, "flags": { "isActive": true } }, { "data": { "uuid": "bc6b7eca-6e0b-4d3c-9f57-ea34470a7f88", "country": "CZ", "name": "Mgr. Iva Sladkovská", "nameOfficial": "Mgr. Iva Sladkovská", "nameAlternative": null, "nameNormalized": "Mgr. Iva Sladkovská", "registrationNumber": "04997433", "taxNumber": null, "vatNumber": null, "vatNumberSpecial": null, "address": { "data": { "country": "CZ", "state": null, "region": "Středočeský kraj", "district": "Praha-východ", "ids": { "internal": "ee6fa3db-88a0-479b-990b-ae157f4b579d", "external": "79260667" }, "street": "Džbánka", "number": { "type": "č.p.", "part1": "558", "part1Number": "558", "part1Letter": null, "part2": null, "part2Number": null, "part2Letter": null, "full": "558" }, "streetWithNumber": "Džbánka 558", "city": "Sulice", "zip": "25168", "full": "Džbánka 558, 25168 Sulice" } }, "addressOfficial": { "data": { "country": "CZ", "street": "Džbánka", "number": { "part1": null, "part1Number": null, "part1Letter": null, "part2": null, "part2Number": null, "part2Letter": null, "full": "558" }, "streetWithNumber": "Džbánka 558", "city": "Sulice", "zip": "25168", "full": "Džbánka 558, 25168 Sulice" } }, "legalForm": { "type": "physical" } }, "flags": { "isActive": true } }, { "data": { "uuid": "c02871f0-de95-45a0-9279-cd1d9399a195", "country": "CZ", "name": "Quang Anh Kieu", "nameOfficial": "Quang Anh Kieu", "nameAlternative": null, "nameNormalized": "Quang Anh Kieu", "registrationNumber": "04997417", "taxNumber": null, "vatNumber": null, "vatNumberSpecial": null, "address": { "data": { "country": "CZ", "state": null, "region": "Plzeňský kraj", "district": "Plzeň-město", "ids": { "internal": "4c66b59f-cdc1-4c8f-b0f8-6294e2fbd6ac", "external": "24537110" }, "street": "Husova", "number": { "type": "č.p.", "part1": "786", "part1Number": "786", "part1Letter": null, "part2": "19", "part2Number": "19", "part2Letter": null, "full": "786/19" }, "streetWithNumber": "Husova 786/19", "city": "Plzeň", "zip": "30100", "full": "Husova 786/19, 30100 Plzeň" } }, "addressOfficial": { "data": { "country": "CZ", "street": "Husova", "number": { "part1": null, "part1Number": null, "part1Letter": null, "part2": null, "part2Number": null, "part2Letter": null, "full": "786/19" }, "streetWithNumber": "Husova 786/19", "city": "Plzeň", "zip": "30100", "full": "Husova 786/19, 30100 Plzeň" } }, "legalForm": { "type": "physical" } }, "flags": { "isActive": true } }, { "data": { "uuid": "90121cd5-d0af-46b6-8060-fa8b97a115c8", "country": "CZ", "name": "Miloš Kulhánek", "nameOfficial": "Miloš Kulhánek", "nameAlternative": null, "nameNormalized": "Miloš Kulhánek", "registrationNumber": "04997492", "taxNumber": null, "vatNumber": null, "vatNumberSpecial": null, "address": { "data": { "country": "CZ", "state": null, "region": "Plzeňský kraj", "district": "Plzeň-sever", "ids": { "internal": "61271a32-4db2-411e-a40f-9d5860ac3354", "external": "628590" }, "street": "Dřevec", "number": { "type": "č.p.", "part1": "5", "part1Number": "5", "part1Letter": null, "part2": null, "part2Number": null, "part2Letter": null, "full": "5" }, "streetWithNumber": "Dřevec 5", "city": "Kožlany", "zip": "33141", "full": "Dřevec 5, 33141 Kožlany" } }, "addressOfficial": { "data": { "country": "CZ", "street": "Dřevec", "number": { "part1": null, "part1Number": null, "part1Letter": null, "part2": null, "part2Number": null, "part2Letter": null, "full": "5" }, "streetWithNumber": "Dřevec 5", "city": "Kožlany", "zip": "33141", "full": "Dřevec 5, 33141 Kožlany" } }, "legalForm": { "type": "physical" } }, "flags": { "isActive": true } } ] }, "errors": [] } }, "searchTaxNumber": { "value": { "status": 200, "request": { "endpoint": "company/search", "code": "810048ad-806d-4b21-b89c-5459b2df3d3b", "query": { "type": "taxNumber", "value": "2120884" }, "options": { "dataSource": [ "CZ", "SK", "PL" ], "dataScope": "basic", "includeTerminatedSubjects": false, "filterMode": "limit", "filterAcceptAlternatives": true, "filterAcceptFormat": true, "filterExactMatch": true, "resultsLimit": 10, "nameFormat": "normalized", "countryFormat": "alpha2", "cityFormat": "basic", "zipFormat": false, "legalFormType": "any", "allowPartialResults": false } }, "response": { "resultsCount": 10, "resultsOffset": 0, "resultsTotal": null, "results": [ { "data": { "uuid": "76aca24f-f823-45bb-a866-842acd17b26d", "country": "SK", "name": "TRESPON, s.r.o.", "nameOfficial": "TRESPON, s.r.o.", "nameAlternative": null, "nameNormalized": "TRESPON, s.r.o.", "registrationNumber": "52082865", "taxNumber": "2120884315", "vatNumber": "SK2120884315", "vatNumberSpecial": null, "address": { "data": { "country": "SK", "state": null, "region": "Trnavský", "district": "Hlohovec", "ids": { "internal": "ae6a2bd8-9154-4d5f-8c70-0fcd33eb321e", "external": null }, "street": "R.Dilonga", "number": { "type": null, "part1": "129", "part1Number": "129", "part1Letter": null, "part2": "6B", "part2Number": "6", "part2Letter": "B", "full": "129/6B" }, "streetWithNumber": "R.Dilonga 129/6B", "city": "Hlohovec", "zip": "92001", "full": "R.Dilonga 129/6B, 92001 Hlohovec" } }, "addressOfficial": { "data": { "country": "SK", "street": "R. Dilonga", "number": { "part1": null, "part1Number": null, "part1Letter": null, "part2": null, "part2Number": null, "part2Letter": null, "full": "129/6B" }, "streetWithNumber": "R. Dilonga 129/6B", "city": "Hlohovec", "zip": "92001", "full": "R. Dilonga 129/6B, 92001 Hlohovec" } }, "legalForm": { "type": "juridical" } }, "flags": { "isActive": true } }, { "data": { "uuid": "6b1ce627-d93f-48e8-bbae-b2651091a86c", "country": "SK", "name": "Domov v pohode, s.r.o.", "nameOfficial": "Domov v pohode, s.r.o.", "nameAlternative": null, "nameNormalized": "Domov v pohode, s.r.o.", "registrationNumber": "52052711", "taxNumber": "2120884029", "vatNumber": null, "vatNumberSpecial": null, "address": { "data": { "country": "SK", "state": null, "region": "Trenčiansky", "district": "Prievidza", "ids": { "internal": "5f0456d4-02eb-4658-ab72-75a8854384ad", "external": null }, "street": "Duklianska ulica", "number": { "type": null, "part1": "54", "part1Number": "54", "part1Letter": null, "part2": "7A", "part2Number": "7", "part2Letter": "A", "full": "54/7A" }, "streetWithNumber": "Duklianska ulica 54/7A", "city": "Prievidza", "zip": "97101", "full": "Duklianska ulica 54/7A, 97101 Prievidza" } }, "addressOfficial": { "data": { "country": "SK", "street": "Duklianska", "number": { "part1": null, "part1Number": null, "part1Letter": null, "part2": null, "part2Number": null, "part2Letter": null, "full": "54/7A" }, "streetWithNumber": "Duklianska 54/7A", "city": "Prievidza", "zip": "97101", "full": "Duklianska 54/7A, 97101 Prievidza" } }, "legalForm": { "type": "juridical" } }, "flags": { "isActive": true } }, { "data": { "uuid": "56c8274c-8485-4732-961a-aef76e11f6d2", "country": "SK", "name": "Penarius, s.r.o.", "nameOfficial": "Penarius, s.r.o.", "nameAlternative": null, "nameNormalized": "Penarius, s.r.o.", "registrationNumber": "52079007", "taxNumber": "2120884678", "vatNumber": "SK2120884678", "vatNumberSpecial": null, "address": null, "addressOfficial": { "data": { "country": "SK", "street": "Eötvösova", "number": { "part1": null, "part1Number": null, "part1Letter": null, "part2": null, "part2Number": null, "part2Letter": null, "full": "51/28" }, "streetWithNumber": "Eötvösova 51/28", "city": "Komárno", "zip": "94501", "full": "Eötvösova 51/28, 94501 Komárno" } }, "legalForm": { "type": "juridical" } }, "flags": { "isActive": true } }, { "data": { "uuid": "7312ffbe-d80c-4fb7-b19a-548e9468e061", "country": "SK", "name": "OSCAR PINKY s.r.o.", "nameOfficial": "OSCAR PINKY s.r.o.", "nameAlternative": null, "nameNormalized": "OSCAR PINKY s.r.o.", "registrationNumber": "52057241", "taxNumber": "2120884205", "vatNumber": null, "vatNumberSpecial": null, "address": { "data": { "country": "SK", "state": null, "region": "Košický", "district": "Košice IV", "ids": { "internal": "f9aa8645-5222-4a11-9d52-00b6b545a3d8", "external": null }, "street": "Rázusova", "number": { "type": null, "part1": "49", "part1Number": "49", "part1Letter": null, "part2": null, "part2Number": null, "part2Letter": null, "full": "49" }, "streetWithNumber": "Rázusova 49", "city": "Košice", "zip": "04001", "full": "Rázusova 49, 04001 Košice" } }, "addressOfficial": { "data": { "country": "SK", "street": "Rázusova", "number": { "part1": null, "part1Number": null, "part1Letter": null, "part2": null, "part2Number": null, "part2Letter": null, "full": "49" }, "streetWithNumber": "Rázusova 49", "city": "Košice-Juh", "zip": "04001", "full": "Rázusova 49, 04001 Košice-Juh" } }, "legalForm": { "type": "juridical" } }, "flags": { "isActive": true } }, { "data": { "uuid": "d5f5494b-090e-4986-939e-eb2ddfd57d8b", "country": "SK", "name": "AKC - STUDIO s.r.o.", "nameOfficial": "AKC - STUDIO s.r.o.", "nameAlternative": null, "nameNormalized": "AKC - STUDIO s.r.o.", "registrationNumber": "52071103", "taxNumber": "2120884183", "vatNumber": "SK2120884183", "vatNumberSpecial": null, "address": { "data": { "country": "SK", "state": null, "region": "Nitriansky", "district": "Šaľa", "ids": { "internal": "b1af2a3c-4ab4-42bd-89ab-0af72bde3ae8", "external": null }, "street": "Hájske", "number": { "type": null, "part1": "95", "part1Number": "95", "part1Letter": null, "part2": null, "part2Number": null, "part2Letter": null, "full": "95" }, "streetWithNumber": "Hájske 95", "city": "Hájske", "zip": "95133", "full": "Hájske 95, 95133 Hájske" } }, "addressOfficial": { "data": { "country": "SK", "street": null, "number": { "part1": null, "part1Number": null, "part1Letter": null, "part2": null, "part2Number": null, "part2Letter": null, "full": "95" }, "streetWithNumber": "95", "city": "Hájske", "zip": "95133", "full": "95, 95133 Hájske" } }, "legalForm": { "type": "juridical" } }, "flags": { "isActive": true } }, { "data": { "uuid": "451e40b7-6d07-43f0-87f2-d9b4ea9bd139", "country": "SK", "name": "KG bet, s. r. o.", "nameOfficial": "KG bet, s. r. o.", "nameAlternative": null, "nameNormalized": "KG bet, s. r. o.", "registrationNumber": "52078892", "taxNumber": "2120884084", "vatNumber": null, "vatNumberSpecial": null, "address": { "data": { "country": "SK", "state": null, "region": "Banskobystrický", "district": "Banská Bystrica", "ids": { "internal": "94fc7801-c47c-4bf6-ad72-7c95f6c2c7d2", "external": null }, "street": "29.augusta", "number": { "type": null, "part1": "1524", "part1Number": "1524", "part1Letter": null, "part2": "24", "part2Number": "24", "part2Letter": null, "full": "1524/24" }, "streetWithNumber": "29.augusta 1524/24", "city": "Banská Bystrica", "zip": "97401", "full": "29.augusta 1524/24, 97401 Banská Bystrica" } }, "addressOfficial": { "data": { "country": "SK", "street": "ul. 29. augusta", "number": { "part1": null, "part1Number": null, "part1Letter": null, "part2": null, "part2Number": null, "part2Letter": null, "full": "1524/24" }, "streetWithNumber": "ul. 29. augusta 1524/24", "city": "Banská Bystrica", "zip": "97401", "full": "ul. 29. augusta 1524/24, 97401 Banská Bystrica" } }, "legalForm": { "type": "juridical" } }, "flags": { "isActive": true } }, { "data": { "uuid": "6761be1c-eb61-4fdd-b1de-bca2d3cdb51f", "country": "SK", "name": "Fibertel s.r.o.", "nameOfficial": "Fibertel s.r.o.", "nameAlternative": null, "nameNormalized": "Fibertel s.r.o.", "registrationNumber": "52078965", "taxNumber": "2120884546", "vatNumber": "SK2120884546", "vatNumberSpecial": null, "address": { "data": { "country": "SK", "state": null, "region": "Prešovský", "district": "Humenné", "ids": { "internal": "80514d05-f3c7-4e9b-87d6-c8e439656aad", "external": null }, "street": "Osloboditeľov", "number": { "type": null, "part1": "1631", "part1Number": "1631", "part1Letter": null, "part2": "114", "part2Number": "114", "part2Letter": null, "full": "1631/114" }, "streetWithNumber": "Osloboditeľov 1631/114", "city": "Humenné", "zip": "06601", "full": "Osloboditeľov 1631/114, 06601 Humenné" } }, "addressOfficial": { "data": { "country": "SK", "street": "Osloboditeľov", "number": { "part1": null, "part1Number": null, "part1Letter": null, "part2": null, "part2Number": null, "part2Letter": null, "full": "1631/114" }, "streetWithNumber": "Osloboditeľov 1631/114", "city": "Humenné", "zip": "06601", "full": "Osloboditeľov 1631/114, 06601 Humenné" } }, "legalForm": { "type": "juridical" } }, "flags": { "isActive": true } }, { "data": { "uuid": "2bf750fd-a350-4a01-822d-2d7b52f014c4", "country": "SK", "name": "MANGALIKA, s.r.o.", "nameOfficial": "MANGALIKA, s.r.o.", "nameAlternative": null, "nameNormalized": "MANGALIKA, s.r.o.", "registrationNumber": "52073181", "taxNumber": "2120884667", "vatNumber": null, "vatNumberSpecial": null, "address": { "data": { "country": "SK", "state": null, "region": "Trnavský", "district": "Piešťany", "ids": { "internal": "57aa3355-42b6-46af-b60c-6eaf85cf4d21", "external": null }, "street": "Vážska", "number": { "type": null, "part1": "3568", "part1Number": "3568", "part1Letter": null, "part2": "37", "part2Number": "37", "part2Letter": null, "full": "3568/37" }, "streetWithNumber": "Vážska 3568/37", "city": "Piešťany", "zip": "92101", "full": "Vážska 3568/37, 92101 Piešťany" } }, "addressOfficial": { "data": { "country": "SK", "street": "Vážska", "number": { "part1": null, "part1Number": null, "part1Letter": null, "part2": null, "part2Number": null, "part2Letter": null, "full": "3568/37" }, "streetWithNumber": "Vážska 3568/37", "city": "Piešťany", "zip": "92101", "full": "Vážska 3568/37, 92101 Piešťany" } }, "legalForm": { "type": "juridical" } }, "flags": { "isActive": true } }, { "data": { "uuid": "05e5128d-4399-4afd-aa24-8e1ba8fa2731", "country": "SK", "name": "MEDICARE CENTRUM s.r.o.", "nameOfficial": "MEDICARE CENTRUM s.r.o.", "nameAlternative": null, "nameNormalized": "MEDICARE CENTRUM s.r.o.", "registrationNumber": "52078639", "taxNumber": "2120884942", "vatNumber": null, "vatNumberSpecial": null, "address": { "data": { "country": "SK", "state": null, "region": "Bratislavský", "district": "Bratislava V", "ids": { "internal": "090daef1-8d58-4c0e-bfd5-b44a406aa4de", "external": null }, "street": "Strečnianska", "number": { "type": null, "part1": "13", "part1Number": "13", "part1Letter": null, "part2": null, "part2Number": null, "part2Letter": null, "full": "13" }, "streetWithNumber": "Strečnianska 13", "city": "Bratislava", "zip": "85105", "full": "Strečnianska 13, 85105 Bratislava" } }, "addressOfficial": { "data": { "country": "SK", "street": "Strečnianska", "number": { "part1": null, "part1Number": null, "part1Letter": null, "part2": null, "part2Number": null, "part2Letter": null, "full": "13" }, "streetWithNumber": "Strečnianska 13", "city": "Bratislava-Petržalka", "zip": "85105", "full": "Strečnianska 13, 85105 Bratislava-Petržalka" } }, "legalForm": { "type": "juridical" } }, "flags": { "isActive": true } }, { "data": { "uuid": "4f985edc-47da-49da-b41d-f14f4f89cf34", "country": "SK", "name": "BISTRANS s.r.o.", "nameOfficial": "BISTRANS s.r.o.", "nameAlternative": null, "nameNormalized": "BISTRANS s.r.o.", "registrationNumber": "52029956", "taxNumber": "2120884865", "vatNumber": "SK2120884865", "vatNumberSpecial": null, "address": { "data": { "country": "SK", "state": null, "region": "Košický", "district": "Košice IV", "ids": { "internal": "79454954-7212-4263-9dfd-3f7fdf163677", "external": null }, "street": "Lichardova", "number": { "type": null, "part1": "152", "part1Number": "152", "part1Letter": null, "part2": "21", "part2Number": "21", "part2Letter": null, "full": "152/21" }, "streetWithNumber": "Lichardova 152/21", "city": "Košice", "zip": "04001", "full": "Lichardova 152/21, 04001 Košice" } }, "addressOfficial": { "data": { "country": "SK", "street": "Lichardova", "number": { "part1": null, "part1Number": null, "part1Letter": null, "part2": null, "part2Number": null, "part2Letter": null, "full": "152/21" }, "streetWithNumber": "Lichardova 152/21", "city": "Košice-Juh", "zip": "04001", "full": "Lichardova 152/21, 04001 Košice-Juh" } }, "legalForm": { "type": "juridical" } }, "flags": { "isActive": true } } ] }, "errors": [] } }, "searchVatNumber": { "value": { "status": 200, "request": { "endpoint": "company/search", "code": "bfda4ed1-c9b7-40a2-914d-ff3f63f197af", "query": { "type": "vatNumber", "value": "CZ04997" }, "options": { "dataSource": [ "CZ", "SK", "PL" ], "dataScope": "basic", "includeTerminatedSubjects": false, "filterMode": "limit", "filterAcceptAlternatives": true, "filterAcceptFormat": true, "filterExactMatch": true, "resultsLimit": 10, "nameFormat": "normalized", "countryFormat": "alpha2", "cityFormat": "basic", "zipFormat": false, "legalFormType": "any", "allowPartialResults": false } }, "response": { "resultsCount": 10, "resultsOffset": 0, "resultsTotal": null, "results": [ { "data": { "uuid": "337a16e0-79fd-425c-a439-3355e221ec0d", "country": "CZ", "name": "LEEPHAM s.r.o.", "nameOfficial": "LEEPHAM s.r.o.", "nameAlternative": null, "nameNormalized": "LEEPHAM s.r.o.", "registrationNumber": "04997387", "taxNumber": null, "vatNumber": "CZ04997387", "vatNumberSpecial": null, "address": { "data": { "country": "CZ", "state": null, "region": "Středočeský kraj", "district": "Mělník", "ids": { "internal": "5b381369-ed10-4115-926e-4dcd412a6882", "external": "2112744" }, "street": "Vojkovice", "number": { "type": "č.p.", "part1": "116", "part1Number": "116", "part1Letter": null, "part2": null, "part2Number": null, "part2Letter": null, "full": "116" }, "streetWithNumber": "Vojkovice 116", "city": "Vojkovice", "zip": "27744", "full": "Vojkovice 116, 27744 Vojkovice" } }, "addressOfficial": { "data": { "country": "CZ", "street": "Vojkovice", "number": { "part1": null, "part1Number": null, "part1Letter": null, "part2": null, "part2Number": null, "part2Letter": null, "full": "116" }, "streetWithNumber": "Vojkovice 116", "city": "Vojkovice", "zip": "27744", "full": "Vojkovice 116, 27744 Vojkovice" } }, "legalForm": { "type": "juridical" } }, "flags": { "isActive": true } }, { "data": { "uuid": "ed969ebb-db8d-427b-8c58-7ecaca7d7f92", "country": "CZ", "name": "NIKOLUNA s.r.o.", "nameOfficial": "NIKOLUNA s.r.o.", "nameAlternative": null, "nameNormalized": "NIKOLUNA s.r.o.", "registrationNumber": "04997832", "taxNumber": null, "vatNumber": "CZ04997832", "vatNumberSpecial": null, "address": { "data": { "country": "CZ", "state": null, "region": "Středočeský kraj", "district": "Rakovník", "ids": { "internal": "ae1e3cc3-9023-463c-95b7-f543b733016f", "external": "8662991" }, "street": "Pod Nemocnicí", "number": { "type": "č.p.", "part1": "2154", "part1Number": "2154", "part1Letter": null, "part2": null, "part2Number": null, "part2Letter": null, "full": "2154" }, "streetWithNumber": "Pod Nemocnicí 2154", "city": "Rakovník", "zip": "26901", "full": "Pod Nemocnicí 2154, 26901 Rakovník" } }, "addressOfficial": { "data": { "country": "CZ", "street": "Pod Nemocnicí", "number": { "part1": null, "part1Number": null, "part1Letter": null, "part2": null, "part2Number": null, "part2Letter": null, "full": "2154" }, "streetWithNumber": "Pod Nemocnicí 2154", "city": "Rakovník", "zip": "26901", "full": "Pod Nemocnicí 2154, 26901 Rakovník" } }, "legalForm": { "type": "juridical" } }, "flags": { "isActive": true } }, { "data": { "uuid": "580a7925-2c40-43a7-a9a2-a5ab0ea397f2", "country": "CZ", "name": "AMADET facility s.r.o.", "nameOfficial": "AMADET facility s.r.o.", "nameAlternative": null, "nameNormalized": "AMADET facility s.r.o.", "registrationNumber": "04997689", "taxNumber": null, "vatNumber": "CZ04997689", "vatNumberSpecial": null, "address": { "data": { "country": "CZ", "state": null, "region": "Hlavní město Praha", "district": "území Hlavního města Prahy", "ids": { "internal": "8ffc809c-11f0-44ae-a949-ee6dd840c1dc", "external": "21889945" }, "street": "Durychova", "number": { "type": "č.p.", "part1": "101", "part1Number": "101", "part1Letter": null, "part2": "66", "part2Number": "66", "part2Letter": null, "full": "101/66" }, "streetWithNumber": "Durychova 101/66", "city": "Praha 4", "zip": "14200", "full": "Durychova 101/66, 14200 Praha 4" } }, "addressOfficial": { "data": { "country": "CZ", "street": "Durychova", "number": { "part1": null, "part1Number": null, "part1Letter": null, "part2": null, "part2Number": null, "part2Letter": null, "full": "101/66" }, "streetWithNumber": "Durychova 101/66", "city": "Praha", "zip": "14200", "full": "Durychova 101/66, 14200 Praha" } }, "legalForm": { "type": "juridical" } }, "flags": { "isActive": true } }, { "data": { "uuid": "3ae19a19-d7f7-4481-a91c-dcc0685860d1", "country": "CZ", "name": "M&S GLOBWASH CZ, s.r.o.", "nameOfficial": "M&S GLOBWASH CZ, s.r.o.", "nameAlternative": null, "nameNormalized": "M&S GLOBWASH CZ, s.r.o.", "registrationNumber": "04997361", "taxNumber": null, "vatNumber": "CZ04997361", "vatNumberSpecial": null, "address": { "data": { "country": "CZ", "state": null, "region": "Středočeský kraj", "district": "Praha-východ", "ids": { "internal": "403b808e-5047-409a-b842-5a2198eca151", "external": "74746545" }, "street": "Horácká", "number": { "type": "č.p.", "part1": "162", "part1Number": "162", "part1Letter": null, "part2": null, "part2Number": null, "part2Letter": null, "full": "162" }, "streetWithNumber": "Horácká 162", "city": "Křenice", "zip": "25084", "full": "Horácká 162, 25084 Křenice" } }, "addressOfficial": { "data": { "country": "CZ", "street": "Horácká", "number": { "part1": null, "part1Number": null, "part1Letter": null, "part2": null, "part2Number": null, "part2Letter": null, "full": "162" }, "streetWithNumber": "Horácká 162", "city": "Křenice", "zip": "25084", "full": "Horácká 162, 25084 Křenice" } }, "legalForm": { "type": "juridical" } }, "flags": { "isActive": true } }, { "data": { "uuid": "66bb2337-1a0c-46b7-8923-cf21b73850e1", "country": "CZ", "name": "HBS CROLE s.r.o.", "nameOfficial": "HBS CROLE s.r.o.", "nameAlternative": null, "nameNormalized": "HBS CROLE s.r.o.", "registrationNumber": "04997891", "taxNumber": null, "vatNumber": "CZ04997891", "vatNumberSpecial": null, "address": { "data": { "country": "CZ", "state": null, "region": "Hlavní město Praha", "district": "území Hlavního města Prahy", "ids": { "internal": "13eec76f-1642-4699-aea0-01e784e5d70e", "external": "22190660" }, "street": "Vítězné náměstí", "number": { "type": "č.p.", "part1": "576", "part1Number": "576", "part1Letter": null, "part2": "1", "part2Number": "1", "part2Letter": null, "full": "576/1" }, "streetWithNumber": "Vítězné náměstí 576/1", "city": "Praha 6", "zip": "16000", "full": "Vítězné náměstí 576/1, 16000 Praha 6" } }, "addressOfficial": { "data": { "country": "CZ", "street": "Vítězné náměstí", "number": { "part1": null, "part1Number": null, "part1Letter": null, "part2": null, "part2Number": null, "part2Letter": null, "full": "576/1" }, "streetWithNumber": "Vítězné náměstí 576/1", "city": "Praha", "zip": "16000", "full": "Vítězné náměstí 576/1, 16000 Praha" } }, "legalForm": { "type": "juridical" } }, "flags": { "isActive": true } }, { "data": { "uuid": "2197de26-a98a-451d-b533-da457e73af5b", "country": "CZ", "name": "Niema pawn s.r.o.", "nameOfficial": "Niema pawn s.r.o.", "nameAlternative": null, "nameNormalized": "Niema pawn s.r.o.", "registrationNumber": "04997557", "taxNumber": null, "vatNumber": "CZ04997557", "vatNumberSpecial": null, "address": { "data": { "country": "CZ", "state": null, "region": "Moravskoslezský kraj", "district": "Opava", "ids": { "internal": "f14f8dca-fa2b-427c-b7f2-7b1261dde4c6", "external": "4406311" }, "street": "Spojná", "number": { "type": "č.p.", "part1": "383", "part1Number": "383", "part1Letter": null, "part2": null, "part2Number": null, "part2Letter": null, "full": "383" }, "streetWithNumber": "Spojná 383", "city": "Markvartovice", "zip": "74714", "full": "Spojná 383, 74714 Markvartovice" } }, "addressOfficial": { "data": { "country": "CZ", "street": "Spojná", "number": { "part1": null, "part1Number": null, "part1Letter": null, "part2": null, "part2Number": null, "part2Letter": null, "full": "383" }, "streetWithNumber": "Spojná 383", "city": "Markvartovice", "zip": "74714", "full": "Spojná 383, 74714 Markvartovice" } }, "legalForm": { "type": "juridical" } }, "flags": { "isActive": true } }, { "data": { "uuid": "92dd746c-1a66-4b2a-9706-82628a157463", "country": "CZ", "name": "Jevyx-car s.r.o.", "nameOfficial": "Jevyx-car s.r.o.", "nameAlternative": null, "nameNormalized": "Jevyx-car s.r.o.", "registrationNumber": "04997174", "taxNumber": null, "vatNumber": "CZ04997174", "vatNumberSpecial": null, "address": { "data": { "country": "CZ", "state": null, "region": "Jihomoravský kraj", "district": "Brno-město", "ids": { "internal": "3cbaf324-011b-48f3-95dd-f2c60b5905f5", "external": "42289475" }, "street": "Pražákova", "number": { "type": "č.p.", "part1": "1008", "part1Number": "1008", "part1Letter": null, "part2": "69", "part2Number": "69", "part2Letter": null, "full": "1008/69" }, "streetWithNumber": "Pražákova 1008/69", "city": "Brno", "zip": "63900", "full": "Pražákova 1008/69, 63900 Brno" } }, "addressOfficial": { "data": { "country": "CZ", "street": "Pražákova", "number": { "part1": null, "part1Number": null, "part1Letter": null, "part2": null, "part2Number": null, "part2Letter": null, "full": "1008/69" }, "streetWithNumber": "Pražákova 1008/69", "city": "Brno", "zip": "63900", "full": "Pražákova 1008/69, 63900 Brno" } }, "legalForm": { "type": "juridical" } }, "flags": { "isActive": true } }, { "data": { "uuid": "ca3665de-ded1-47f7-9bcd-b8c3eb8c52e1", "country": "CZ", "name": "AVANTRO s.r.o.", "nameOfficial": "AVANTRO s.r.o.", "nameAlternative": null, "nameNormalized": "AVANTRO s.r.o.", "registrationNumber": "04997476", "taxNumber": null, "vatNumber": "CZ04997476", "vatNumberSpecial": null, "address": { "data": { "country": "CZ", "state": null, "region": "Hlavní město Praha", "district": "území Hlavního města Prahy", "ids": { "internal": "d2ade877-1e95-4a83-baa6-5431ce5b3ca8", "external": "22349995" }, "street": "Thámova", "number": { "type": "č.p.", "part1": "137", "part1Number": "137", "part1Letter": null, "part2": "16", "part2Number": "16", "part2Letter": null, "full": "137/16" }, "streetWithNumber": "Thámova 137/16", "city": "Praha 8", "zip": "18600", "full": "Thámova 137/16, 18600 Praha 8" } }, "addressOfficial": { "data": { "country": "CZ", "street": "Thámova", "number": { "part1": null, "part1Number": null, "part1Letter": null, "part2": null, "part2Number": null, "part2Letter": null, "full": "137/16" }, "streetWithNumber": "Thámova 137/16", "city": "Praha", "zip": "18600", "full": "Thámova 137/16, 18600 Praha" } }, "legalForm": { "type": "juridical" } }, "flags": { "isActive": true } }, { "data": { "uuid": "02d7bbde-868f-4f5b-ad64-fb0b8613ca0f", "country": "CZ", "name": "Ascent Capital s.r.o.", "nameOfficial": "Ascent Capital s.r.o.", "nameAlternative": null, "nameNormalized": "Ascent Capital s.r.o.", "registrationNumber": "04997859", "taxNumber": null, "vatNumber": "CZ04997859", "vatNumberSpecial": null, "address": { "data": { "country": "CZ", "state": null, "region": "Hlavní město Praha", "district": "území Hlavního města Prahy", "ids": { "internal": "c3c2369b-c2d0-4c5c-910c-20116e7395c2", "external": "22653473" }, "street": "Na zájezdu", "number": { "type": "č.p.", "part1": "2132", "part1Number": "2132", "part1Letter": null, "part2": "11", "part2Number": "11", "part2Letter": null, "full": "2132/11" }, "streetWithNumber": "Na zájezdu 2132/11", "city": "Praha 10", "zip": "10100", "full": "Na zájezdu 2132/11, 10100 Praha 10" } }, "addressOfficial": { "data": { "country": "CZ", "street": "Na zájezdu", "number": { "part1": null, "part1Number": null, "part1Letter": null, "part2": null, "part2Number": null, "part2Letter": null, "full": "2132/11" }, "streetWithNumber": "Na zájezdu 2132/11", "city": "Praha", "zip": "10100", "full": "Na zájezdu 2132/11, 10100 Praha" } }, "legalForm": { "type": "juridical" } }, "flags": { "isActive": true } }, { "data": { "uuid": "013647f6-9142-46b8-aeed-4b82a9e914cb", "country": "CZ", "name": "MAKESIM s.r.o.", "nameOfficial": "MAKESIM s.r.o.", "nameAlternative": null, "nameNormalized": "MAKESIM s.r.o.", "registrationNumber": "04997735", "taxNumber": null, "vatNumber": "CZ04997735", "vatNumberSpecial": null, "address": { "data": { "country": "CZ", "state": null, "region": "Hlavní město Praha", "district": "území Hlavního města Prahy", "ids": { "internal": "86ef6d6d-79f8-4c4b-9328-5179c0725b10", "external": "21843139" }, "street": "Donovalská", "number": { "type": "č.p.", "part1": "1756", "part1Number": "1756", "part1Letter": null, "part2": "45", "part2Number": "45", "part2Letter": null, "full": "1756/45" }, "streetWithNumber": "Donovalská 1756/45", "city": "Praha 4", "zip": "14900", "full": "Donovalská 1756/45, 14900 Praha 4" } }, "addressOfficial": { "data": { "country": "CZ", "street": "Donovalská", "number": { "part1": null, "part1Number": null, "part1Letter": null, "part2": null, "part2Number": null, "part2Letter": null, "full": "1756/45" }, "streetWithNumber": "Donovalská 1756/45", "city": "Praha", "zip": "14900", "full": "Donovalská 1756/45, 14900 Praha" } }, "legalForm": { "type": "juridical" } }, "flags": { "isActive": true } } ] }, "errors": [] } } } } } }, "400": { "$ref": "#/paths/~1company~1get/post/responses/400" }, "401": { "$ref": "#/paths/~1company~1get/post/responses/401" }, "402": { "$ref": "#/paths/~1company~1get/post/responses/402" }, "403": { "$ref": "#/paths/~1company~1get/post/responses/403" }, "404": { "$ref": "#/paths/~1company~1get/post/responses/404" }, "405": { "$ref": "#/paths/~1company~1get/post/responses/405" }, "429": { "$ref": "#/paths/~1company~1get/post/responses/429" }, "500": { "$ref": "#/paths/~1company~1get/post/responses/500" }, "503": { "$ref": "#/paths/~1company~1get/post/responses/503" } }, "security": [ { "BearerAuth": [] } ] } }, "/company/get": { "post": { "tags": [ "Company" ], "summary": "Get company data", "description": "Foxentry allows you to get information about company based on the dataScope option. Country and registrationNumber parameters are required.", "operationId": "CompanyGet", "parameters": [ { "name": "api-version", "in": "header", "description": "API version.", "required": false, "schema": { "type": "string", "default": "2.1", "example": "2.1" } }, { "name": "foxentry-include-request-details", "in": "header", "description": "Parameter to add details of your request.", "required": false, "schema": { "type": "boolean", "default": false, "example": false } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "request": { "type": "object", "allOf": [ { "type": "object", "properties": { "customId": { "type": [ "string", "null" ], "description": "Custom ID assigned by you if you need so.", "example": "customer567914" }, "query": { "type": "object", "properties": { "country": { "type": "string", "description": "Country code in format [ISO-3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).", "example": "CZ" }, "registrationNumber": { "type": "string", "description": "Company registration number.", "example": "04997476" } }, "required": [ "country", "registrationNumber" ] }, "options": { "type": "object", "description": "Query options.", "properties": { "dataScope": { "type": "string", "enum": [ "basic", "extended", "full" ], "description": "Data scope of returned data.", "default": "basic", "example": "full" }, "dataSource": { "description": "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.", "type": "array", "items": { "type": "string", "example": "CZ" }, "default": [ "CZ", "HU", "PL", "SK" ], "example": [ "CZ", "SK", "PL", "HU" ] }, "includeTerminatedSubjects": { "type": "boolean", "description": "Whether or not to include entities that have already ended their existence in the output.", "default": false, "example": false }, "zipFormat": { "description": "Whether to return locally formatted ZIP code or not. (130 00 vs 13000).", "type": "boolean", "default": false, "example": false }, "cityFormat": { "description": "This option determines the format in which the city is returned. Minimal = Praha, basic = Praha 8, extended = Praha 8 - Karlín.", "type": "string", "enum": [ "minimal", "basic", "extended" ], "default": "basic", "example": "basic" }, "nameFormat": { "description": "This option determines the format in which the name is returned. official returns the official name of the company as in official registers, normalized returns normalized name of the company (in standardized format). Example: official = Lidl Magyarország Kereskedelmi Betéti Társaság, normalized = Lidl Magyarország Bt.", "type": "string", "enum": [ "official", "normalized" ], "default": "normalized", "example": "normalized" }, "countryFormat": { "description": "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.", "type": "string", "enum": [ "alpha2", "alpha3", "local", "localShortened", "international", "internationalShortened" ], "default": "alpha2", "example": "alpha2" } } }, "client": { "type": "object", "description": "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.", "properties": { "ip": { "type": "string", "description": "IP address of your end user (IPv4 or IPv6). Used for geolocation to make results — for example for the search endpoints — more relevant to the user's location. If you have the user's GPS coordinates, prefer sending those via `location`, as an IP address may be less precise.", "examples": [ "127.0.1.1", "2001:db8::8a2e:370:7334" ] }, "country": { "type": "string", "description": "Country code in [ISO-3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format.", "example": "CZ" }, "location": { "type": "object", "description": "Latitude & longitude of the client's approximate location.", "properties": { "lat": { "type": "number", "description": "Client's latitude", "example": 50.0628 }, "lon": { "type": "number", "description": "Client's longitude", "example": 13.9271 } } } } } } } ], "required": [ "query" ] } }, "required": [ "request" ] }, "examples": { "Request Example": { "value": { "request": { "query": { "country": "CZ", "registrationNumber": "04997476" }, "options": { "dataScope": "full", "includeTerminatedSubjects": false, "cityFormat": "basic", "zipFormat": false }, "client": { "country": "CZ", "location": { "lat": 50.0628, "lon": 13.9271 } } } } } } } } }, "responses": { "200": { "description": "Successful response", "headers": { "foxentry-api-version": { "schema": { "type": "string", "example": "2.1" }, "description": "The version of the Foxentry API" }, "foxentry-daily-credits-left": { "schema": { "type": "number", "example": 9881.64 }, "description": "The amount of daily credits left" }, "foxentry-daily-credits-limit": { "schema": { "type": "number", "example": 1000 }, "description": "The daily credits limit" }, "foxentry-rate-limit": { "schema": { "type": "integer", "example": 5000 }, "description": "The rate limit" }, "foxentry-rate-limit-period": { "schema": { "type": "integer", "example": 900 }, "description": "The rate limit period" }, "foxentry-rate-limit-remaining": { "schema": { "type": "integer", "example": 4999 }, "description": "The remaining rate limit" } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status of API response.", "example": 200 }, "request": { "allOf": [ { "type": "object", "properties": { "endpoint": { "example": "company/get" } } }, { "type": "object", "properties": { "endpoint": { "type": "string", "description": "Endpoint name." }, "code": { "type": "string", "description": "Code of request.", "example": "gc0nCfcELaPSHH4Qo4UBaC7DbAj6G4" }, "customId": { "type": [ "string", "null" ], "description": "Custom ID assigned by you if you need so.", "example": "customer567914" } }, "required": [ "endpoint", "code" ] }, { "$ref": "#/paths/~1company~1get/post/requestBody/content/application~1json/schema/properties/request/allOf/0" } ] }, "response": { "type": "object", "properties": { "results": { "type": "array", "items": { "type": "object", "properties": { "flags": { "type": "object", "properties": { "isActive": { "type": [ "boolean", "null" ], "description": "Indicates whether the company is currently active.", "example": true }, "isVatPayer": { "type": [ "boolean", "null" ], "description": "Indicates whether the company is a VAT payer. Available in extended and full datascopes.", "example": true }, "isVatSubject": { "type": [ "boolean", "null" ], "description": "Indicates whether the company is a VAT subject. Available in extended and full datascopes.", "example": true }, "isInInsolvency": { "type": [ "boolean", "null" ], "description": "Indicates whether the company is currently in insolvency. Available in full datascope in select countries.", "example": false } } }, "data": { "type": "object", "properties": { "country": { "type": [ "string", "null" ], "description": "Country code in format [ISO-3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).", "example": "CZ" }, "uuid": { "type": [ "string", "null" ] }, "name": { "type": [ "string", "null" ], "description": "Name of company (in format requested by option nameFormat).", "example": "Avantro s.r.o." }, "nameOfficial": { "type": [ "string", "null" ], "description": "Name of company (as in official register).", "example": "Avantro s.r.o." }, "nameAlternative": { "type": [ "string", "null" ], "description": "Alternative name of company.", "example": "AVANTRO s. r. o." }, "nameNormalized": { "type": [ "string", "null" ], "description": "Normalized name of company.", "example": "Avantro s.r.o." }, "registrationNumber": { "type": [ "string", "null" ], "description": "Company registration number.", "example": "04997476" }, "taxNumber": { "type": [ "string", "null" ], "description": "Company tax number.", "example": "CZ04997476" }, "vatNumber": { "type": [ "string", "null" ], "description": "Company vat number.", "example": "CZ04997476" }, "vatNumberSpecial": { "type": [ "string", "null" ], "description": "Special vat number in case that subject is part of VAT group.", "example": "CZ0581019" }, "address": { "oneOf": [ { "$ref": "#/paths/~1location~1get/post/responses/200/content/application~1json/schema/properties/response/properties/results/items" }, { "type": "null", "title": "No data" } ] }, "addressOfficial": { "type": [ "object", "null" ], "description": "Address data from the official registry. Not validated by Foxentry.", "properties": { "data": { "type": [ "object", "null" ], "properties": { "country": { "type": [ "string", "null" ], "description": "Country of administrative area in format [ISO-3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).", "example": "CZ" }, "street": { "type": [ "string", "null" ], "description": "Street.", "example": "Jeseniova" }, "number": { "$ref": "#/paths/~1location~1get/post/responses/200/content/application~1json/schema/properties/response/properties/results/items/properties/data/properties/number" }, "streetWithNumber": { "type": [ "string", "null" ], "description": "Street with number.", "example": "Jeseniova 1151/55" }, "city": { "type": [ "string", "null" ], "description": "City.", "example": "Praha" }, "zip": { "type": [ "string", "null" ], "description": "ZIP code.", "example": "13000" }, "full": { "type": [ "string", "null" ], "description": "Full address.", "example": "Jeseniova 1151/55 Praha 130000" } } } } }, "nace": { "type": "array", "description": "Types of business", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "Code of business.", "example": "74" }, "name": { "type": "string", "description": "Name of business", "example": "Ostatní profesní, vědecké a technické činnosti" }, "isPrimary": { "type": [ "boolean", "null" ], "description": "Determines if it is the main object of the business.", "example": false } } } }, "databoxes": { "type": "array", "description": "Company's electronic mail boxes (databoxes).", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "Code of databox.", "example": "txutpba" }, "name": { "type": "string", "description": "Name of databox.", "example": "AVANTRO s.r.o." }, "receivingMessages": { "type": "boolean", "description": "Whether the databox is set to receive messages from public as well.", "example": true } } } }, "registrations": { "type": "array", "description": "Information about the company's registrations.", "items": { "type": "object", "properties": { "type": { "enum": [ "businessRegister", "vatRegister" ], "description": "Type of registration.", "example": "businessRegister" }, "data": { "type": "object", "properties": { "register": { "type": "object", "description": "Information about register.", "properties": { "code": { "type": [ "string", "null" ], "description": "Code of register.", "example": null }, "name": { "type": [ "string", "null" ], "description": "Name of register.", "example": "CENTRALNA EWIDENCJA I INFORMACJA O DZIAŁALNOŚCI GOSPODARCZEJ" }, "detail": { "type": [ "string", "null" ], "description": "Detail of register.", "example": null } } }, "registrator": { "type": "object", "description": "Information about registrator.", "properties": { "code": { "type": [ "string", "null" ], "description": "Code of register.", "example": "MSPH" }, "name": { "type": [ "string", "null" ], "description": "Name of registrator.", "example": "Městský soud v Praze" }, "detail": { "type": [ "string", "null" ], "description": "Detail of registration.", "example": "Územní pracoviště pro Prahu 8, Trojská 13a, PRAHA 8, tel. 266 013 111" } } }, "reference": { "type": [ "string", "null" ], "description": "Registration reference.", "example": "C 256795" } } } } } }, "legalForm": { "type": "object", "properties": { "type": { "description": "Legal form type", "enum": [ "juridical", "physical", null ], "default": "juridical", "example": "juridical" }, "code": { "type": [ "string", "null" ], "description": "Code of legal form.", "example": "112" }, "name": { "type": [ "string", "null" ], "description": "Name of legal form.", "example": "Společnost s ručením omezeným." } } }, "legalFormSpecific": { "type": "object", "description": "Specific cases of legalForm.", "properties": { "code": { "type": [ "string", "null" ], "description": "Code of legal form for Polish companies.", "example": null }, "name": { "type": [ "string", "null" ], "description": "Name of legal form for Polish companies.", "example": null } } }, "esa2010": { "type": "object", "description": "The European System of National and Regional Accounts.", "properties": { "code": { "type": [ "string", "null" ], "description": "Code of ESA2010.", "example": "11002" }, "name": { "type": [ "string", "null" ], "description": "Name of ESA2010.", "example": "Nefinanční podniky soukromé národní" } } }, "dates": { "type": "object", "description": "Important dates associated with company.", "properties": { "created": { "type": [ "string", "null" ], "description": "Company creation date.", "format": "date", "example": "2016-04-15" }, "terminated": { "type": [ "string", "null" ], "description": "Company termination date.", "format": "date", "example": "2016-04-15" } } }, "employees": { "type": "object", "description": "Employees information.", "properties": { "count": { "type": [ "number", "null" ], "description": "Number of employees.", "example": null }, "category": { "type": [ "string", "null" ], "description": "Category of employees.", "example": "1000-1499" } } }, "insolvency": { "type": [ "object", "null" ], "description": "Company insolvency status with history", "properties": { "history": { "type": "array", "items": { "type": "object", "properties": { "reference": { "type": "string", "description": "Official reference of insolvency.", "example": "65 INS 12632 / 2023" }, "dateFrom": { "type": "string", "description": "Since when is the insolvence valid.", "format": "date", "example": "2021-08-01" }, "dateTo": { "type": "string", "description": "Until when is the insolvency valid.", "format": "date", "example": "2025-08-01" }, "court": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of court", "example": "Krajský soud v Hradci Králové." } } }, "status": { "type": "string", "description": "Status of insolvency.", "example": "NEVYRIZENA" }, "detailUrl": { "type": "string", "description": "Detail URL of insolvency.", "format": "url", "example": "https://isir.justice.cz/isir/ueu/evidence_upadcu_detail.do?id=F" } } } } } }, "businessPremises": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": [ "string", "null" ], "description": "Label of business premises", "example": "Obchodní centrum Havlíčkův Brod." }, "address": { "type": "object", "properties": { "full": { "type": "string", "description": "Full address.", "example": "Nad Rybníkem 3169, 580 01, Havlíčkův Brod" } } }, "activitySubjects": { "type": "string", "description": "Types of activity associated with the premise.", "example": "Zprostředkovatelská činnost" } } } }, "authority": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of authority.", "example": "Statutární orgán" }, "members": { "type": "array", "description": "Members associated with company.", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "name of member.", "example": "Pavel Hrdlička" }, "address": { "oneOf": [ { "$ref": "#/paths/~1location~1get/post/responses/200/content/application~1json/schema/properties/response/properties/results/items" }, { "type": "null", "title": "No data" } ] }, "addressOfficial": { "$ref": "#/paths/~1company~1get/post/responses/200/content/application~1json/schema/properties/response/properties/results/items/properties/data/properties/addressOfficial" }, "function": { "type": [ "string", "null" ], "description": "Member function.", "example": "jednatel" }, "birthDate": { "type": [ "string", "null" ], "format": "date", "description": "Member date of birth.", "example": "1988-08-01" }, "registrationNumber": { "type": [ "number", "null" ], "description": "Member registration number.", "example": null } } } }, "decisions": { "type": "array", "description": "Information about the company's manner of decision making.", "items": { "type": [ "string", "null" ], "description": "Member decisions.", "example": "Společnost zastupuje jednatel samostatně." } } } } }, "capital": { "type": "object", "description": "Company's funding", "properties": { "value": { "type": "object", "properties": { "amount": { "type": [ "string", "null" ], "description": "Amount of capital.", "example": "200000" }, "currency": { "type": [ "string", "null" ], "description": "Currency of capital.", "example": "CZK" } } }, "shareholders": { "type": "array", "description": "Information about shareholders.", "items": { "type": "object", "properties": { "shareholder": { "type": "string", "description": "Information about shareholder.", "example": "PAVEL HRDLIČKA , dat. nar. 14. listopadu 1990 V Zahradách 277, 751 11 Radslavice" }, "share": { "type": "object", "properties": { "amount": { "type": "string", "description": "Amount of share.", "example": "200000" }, "currency": { "type": "string", "description": "Currency of share.", "example": "CZK" }, "percent": { "type": "string", "description": "Share percentage.", "example": "100" }, "percentPaid": { "type": "string", "description": "Share percentage paid.", "example": "100" } } }, "info": { "type": "array", "description": "Textual information about the share.", "items": { "type": "string", "description": "Information about share", "example": "Druh podílu: základní, se kterým nejsou spojené žádné zvláštní práva a povinnosti" } } } } }, "stocks": { "type": "array", "description": "Textual description of the stock amount and value.", "items": { "type": "string", "description": "List of stocks.", "example": "100 ks akcie na jméno v listinné podobě ve jmenovité hodnotě 20 000 ,- Kč." } } } }, "tradeLicences": { "type": "array", "description": "Trade licence information.", "items": { "type": "object", "properties": { "type": { "type": "string", "description": "Type of trade licence.", "example": "Ohlašovací volná" }, "name": { "type": "string", "description": "Name of trade licenses.", "example": "Výroba, obchod a služby neuvedené v přílohách 1 až 3 živnostenského zákona" }, "valid": { "type": "object", "properties": { "from": { "type": "string", "description": "Valid from.", "example": "2016-04-15" }, "fromText": { "type": [ "string", "null" ], "description": "Description of validation (from).", "example": "Dnem zápisu do spolkového rejstříku." }, "to": { "type": [ "string", "null" ], "description": "Valid to.", "example": "2030-04-15" }, "toText": { "type": [ "string", "null" ], "description": "Description of validation (to).", "example": "Na dobu neurčitou." } } }, "interrupted": { "type": "object", "description": "Dates of interuption.", "properties": { "from": { "type": [ "string", "null" ], "description": "Validity of the authorisation (from).", "format": "date", "example": "2021-08-15" }, "to": { "type": [ "string", "null" ], "description": "Validity of the authorisation (to).", "format": "date", "example": "2025-08-15" } } }, "responsiblePerson": { "type": [ "string", "null" ], "description": "Responsible person.", "example": "Jan Novák" }, "activitySubjects": { "type": "array", "items": { "type": "string", "description": "Subject of activity.", "example": "Broušení technického a šperkového kamene" } } } } }, "vat": { "type": "object", "description": "Vat payer information.", "properties": { "status": { "type": [ "string", "null" ], "description": "Vat current status. Payer, non payer and subject. Subject means the company is a VAT payer only for non domestic transactions (identifikovaná osoba).", "example": "payer", "enum": [ "payer", "nonpayer", "subject" ] }, "reliability": { "type": "object", "description": "Reliability of the VAT payer.", "properties": { "reliable": { "type": [ "boolean", "null" ], "description": "Determines whether or not the subject is reliable.", "example": true }, "unreliableFrom": { "type": [ "string", "null" ], "format": "date", "description": "Determines from when the subject is unreliable.", "example": "2018-09-01" } } }, "bankAccounts": { "type": "array", "description": "Bank accounts associated with the VAT payer.", "items": { "type": "object", "properties": { "number": { "type": "string", "example": "55567899/2010" } } } }, "history": { "type": "array", "description": "History of the VAT payer.", "items": { "type": "object", "properties": { "vatNumber": { "type": "string", "description": "Company vat number.", "example": "CZ04997476" }, "registrationType": { "type": "string", "description": "Company registration type.", "example": "payer" }, "validFrom": { "type": "string", "description": "Valid from.", "example": "2017-09-01" }, "validTo": { "type": [ "string", "null" ], "description": "Valid to.", "example": null }, "isGroupRegistration": { "type": "boolean", "description": "Is part of group registration.", "example": false } } } } } } } } }, "required": [ "data" ] } } }, "required": [ "results" ] }, "errors": { "description": "List of errors related to the request. Should be empty if the request finished successfully.", "type": "array", "items": {}, "maxItems": 0 } }, "required": [ "status", "request", "response" ] }, "examples": { "basicDataScope": { "value": { "status": 200, "request": { "endpoint": "company/get", "code": "29ec5c92-a03e-4e3d-97d9-8c4de4591394", "query": { "registrationNumber": "04997476", "country": "CZ" }, "options": { "dataSource": [ "CZ", "SK", "PL" ], "dataScope": "basic", "includeTerminatedSubjects": false, "nameFormat": "normalized", "countryFormat": "alpha2", "cityFormat": "basic", "zipFormat": false } }, "response": { "results": [ { "data": { "uuid": "ca3665de-ded1-47f7-9bcd-b8c3eb8c52e1", "country": "CZ", "name": "AVANTRO s.r.o.", "nameOfficial": "AVANTRO s.r.o.", "nameAlternative": null, "nameNormalized": "AVANTRO s.r.o.", "registrationNumber": "04997476", "taxNumber": null, "vatNumber": "CZ04997476", "vatNumberSpecial": null, "address": { "data": { "country": "CZ", "state": null, "region": "Hlavní město Praha", "district": "území Hlavního města Prahy", "ids": { "internal": "d2ade877-1e95-4a83-baa6-5431ce5b3ca8", "external": "22349995" }, "street": "Thámova", "number": { "type": "č.p.", "part1": "137", "part1Number": "137", "part1Letter": null, "part2": "16", "part2Number": "16", "part2Letter": null, "full": "137/16" }, "streetWithNumber": "Thámova 137/16", "city": "Praha 8", "zip": "18600", "full": "Thámova 137/16, 18600 Praha 8" } }, "addressOfficial": { "data": { "country": "CZ", "street": "Thámova", "number": { "part1": null, "part1Number": null, "part1Letter": null, "part2": null, "part2Number": null, "part2Letter": null, "full": "137/16" }, "streetWithNumber": "Thámova 137/16", "city": "Praha", "zip": "18600", "full": "Thámova 137/16, 18600 Praha" } }, "legalForm": { "type": "juridical" } }, "flags": { "isActive": true } } ] }, "errors": [] } }, "extendedDataScope": { "value": { "status": 200, "request": { "endpoint": "company/get", "code": "20fe2bb6-b256-4482-ba0d-354102fca964", "query": { "registrationNumber": "04997476", "country": "CZ" }, "options": { "dataSource": [ "CZ", "SK", "PL" ], "dataScope": "extended", "includeTerminatedSubjects": false, "nameFormat": "normalized", "countryFormat": "alpha2", "cityFormat": "basic", "zipFormat": false } }, "response": { "results": [ { "data": { "uuid": "ca3665de-ded1-47f7-9bcd-b8c3eb8c52e1", "country": "CZ", "name": "AVANTRO s.r.o.", "nameOfficial": "AVANTRO s.r.o.", "nameAlternative": null, "nameNormalized": "AVANTRO s.r.o.", "registrationNumber": "04997476", "taxNumber": null, "vatNumber": "CZ04997476", "vatNumberSpecial": null, "address": { "data": { "country": "CZ", "state": null, "region": "Hlavní město Praha", "district": "území Hlavního města Prahy", "ids": { "internal": "d2ade877-1e95-4a83-baa6-5431ce5b3ca8", "external": "22349995" }, "street": "Thámova", "number": { "type": "č.p.", "part1": "137", "part1Number": "137", "part1Letter": null, "part2": "16", "part2Number": "16", "part2Letter": null, "full": "137/16" }, "streetWithNumber": "Thámova 137/16", "city": "Praha 8", "zip": "18600", "full": "Thámova 137/16, 18600 Praha 8" } }, "addressOfficial": { "data": { "country": "CZ", "street": "Thámova", "number": { "part1": null, "part1Number": null, "part1Letter": null, "part2": null, "part2Number": null, "part2Letter": null, "full": "137/16" }, "streetWithNumber": "Thámova 137/16", "city": "Praha", "zip": "18600", "full": "Thámova 137/16, 18600 Praha" } }, "legalForm": { "type": "juridical", "code": "112", "name": "Společnost s ručením omezeným" }, "legalFormSpecific": { "code": null, "name": null }, "nace": [ { "code": "00", "name": "Výroba, obchod a služby neuvedené v přílohách 1 až 3 živnostenského zákona", "isPrimary": null }, { "code": "74", "name": "Ostatní odborné, vědecké a technické činnosti", "isPrimary": null }, { "code": "68200", "name": "Pronájem a správa vlastních nebo pronajatých nemovitostí", "isPrimary": null } ], "registrations": [ { "type": "businessRegister", "data": { "register": { "code": null, "name": null, "detail": null }, "registrator": { "code": "MSPH", "name": "Městský soud v Praze", "detail": null }, "reference": "C 256795" } }, { "type": "vatRegister", "data": { "register": { "code": null, "name": null, "detail": null }, "registrator": { "code": "008", "name": "Územní pracoviště pro Prahu 8", "detail": null }, "reference": null } } ], "esa2010": { "code": "11002", "name": "Národní soukromé nefinanční podniky" }, "dates": { "created": "2016-04-15", "terminated": null }, "tradeLicences": [ { "type": "živnost volná", "name": "Výroba, obchod a služby neuvedené v přílohách 1 až 3 živnostenského zákona", "valid": { "from": "2016-04-15", "fromText": null, "to": null, "toText": null }, "interrupted": { "from": null, "to": null }, "responsiblePerson": null, "activitySubjects": [ "Povrchové úpravy a svařování kovů a dalších materiálů", "Výroba neelektrických zařízení pro domácnost", "Výroba a opravy čalounických výrobků", "Sklenářské práce, rámování a paspartování", "Výroba jízdních kol, vozíků pro invalidy a jiných nemotorových dopravních prostředků", "Provozování vodovodů a kanalizací a úprava a rozvod vody", "Stavba a výroba plavidel", "Výroba motorových a přípojných vozidel a karoserií", "Výroba zdravotnických prostředků", "Výroba elektronických součástek, elektrických zařízení a výroba a opravy elektrických strojů, přístrojů a elektronických zařízení pracujících na malém napětí", "Výroba a opravy zdrojů ionizujícího záření", "Umělecko-řemeslné zpracování kovů", "Broušení technického a šperkového kamene", "Výroba brusiv a ostatních minerálních nekovových výrobků", "Výroba stavebních hmot, porcelánových, keramických a sádrových výrobků", "Výroba koksu, surového dehtu a jiných pevných paliv", "Výroba, rozmnožování, distribuce, prodej, pronájem zvukových a zvukově-obrazových záznamů a výroba nenahraných nosičů údajů a záznamů", "Výroba potravinářských a škrobárenských výrobků", "Pěstitelské pálení", "Úprava nerostů, dobývání rašeliny a bahna", "Zastavárenská činnost a maloobchod s použitým zbožím", "Výroba a zpracování skla", "Údržba motorových vozidel a jejich příslušenství", "Poskytování služeb pro rodinu a domácnost", "Výroba, vývoj, projektování, zkoušky, instalace, údržba, opravy, modifikace a konstrukční změny letadel, motorů letadel, vrtulí, letadlových částí a zařízení a leteckých pozemních zařízení", "Zpracování dřeva, výroba dřevěných, korkových, proutěných a slaměných výrobků", "Služby v oblasti administrativní správy a služby organizačně hospodářské povahy", "Reklamní činnost, marketing, mediální zastoupení", "Výroba a opravy obuvi, brašnářského a sedlářského zboží", "Diagnostická, zkušební a poradenská činnost v ochraně rostlin a ošetřování rostlin, rostlinných produktů, objektů a půdy proti škodlivým organismům přípravky na ochranu rostlin nebo biocidními přípravky", "Skladování, balení zboží, manipulace s nákladem a technické činnosti v dopravě", "Velkoobchod a maloobchod", "Zprostředkování obchodu a služeb", "Přípravné a dokončovací stavební práce, specializované stavební činnosti", "Výroba drážních hnacích vozidel a drážních vozidel na dráze tramvajové, trolejbusové a lanové a železničního parku", "Nakládání s odpady (vyjma nebezpečných)", "Výroba dalších výrobků zpracovatelského průmyslu", "Výroba školních a kancelářských potřeb, kromě výrobků z papíru, výroba bižuterie, kartáčnického a konfekčního zboží, deštníků, upomínkových předmětů", "Výroba strojů a zařízení", "Provozování cestovní agentury a průvodcovská činnost v oblasti cestovního ruchu", "Návrhářská, designérská, aranžérská činnost a modeling", "Projektování pozemkových úprav", "Poradenská a konzultační činnost, zpracování odborných studií a posudků", "Činnost informačních a zpravodajských kanceláří", "Poskytování technických služeb", "Praní pro domácnost, žehlení, opravy a údržba oděvů, bytového textilu a osobního zboží", "Provozování tělovýchovných a sportovních zařízení a organizování sportovní činnosti", "Provozování kulturních, kulturně-vzdělávacích a zábavních zařízení, pořádání kulturních produkcí, zábav, výstav, veletrhů, přehlídek, prodejních a obdobných akcí", "Mimoškolní výchova a vzdělávání, pořádání kurzů, školení, včetně lektorské činnosti", "Nakládání s reprodukčním materiálem lesních dřevin", "Testování, měření, analýzy a kontroly", "Výzkum a vývoj v oblasti přírodních a technických věd nebo společenských věd", "Projektování elektrických zařízení", "Příprava a vypracování technických návrhů, grafické a kresličské práce", "Pronájem a půjčování věcí movitých", "Poskytování software, poradenství v oblasti informačních technologií, zpracování dat, hostingové a související činnosti a webové portály", "Ubytovací služby", "Zasilatelství a zastupování v celním řízení", "Potrubní a pozemní doprava (vyjma železniční a silniční motorové dopravy)", "Fotografické služby", "Chov zvířat a jejich výcvik (s výjimkou živočišné výroby)", "Činnost odborného lesního hospodáře a vyhotovování lesních hospodářských plánů a osnov", "Výroba, opravy a údržba sportovních potřeb, her, hraček a dětských kočárků", "Výroba měřicích, zkušebních, navigačních, optických a fotografických přístrojů a zařízení", "Výroba kovových konstrukcí a kovodělných výrobků", "Výroba a hutní zpracování železa, drahých a neželezných kovů a jejich slitin", "Výroba plastových a pryžových výrobků", "Výroba hnojiv", "Výroba chemických látek a chemických směsí nebo předmětů a kosmetických přípravků", "Vydavatelské činnosti, polygrafická výroba, knihařské a kopírovací práce", "Výroba vlákniny, papíru a lepenky a zboží z těchto materiálů", "Výroba textilií, textilních výrobků, oděvů a oděvních doplňků", "Výroba krmiv, krmných směsí, doplňkových látek a premixů", "Poskytování služeb pro zemědělství, zahradnictví, rybníkářství, lesnictví a myslivost", "Výroba, obchod a služby jinde nezařazené", "Poskytování služeb osobního charakteru a pro osobní hygienu", "Opravy a údržba potřeb pro domácnost, předmětů kulturní povahy, výrobků jemné mechaniky, optických přístrojů a měřidel", "Překladatelská a tlumočnická činnost", "Nákup, prodej, správa a údržba nemovitostí" ] } ], "vat": { "status": "payer", "reliability": { "reliable": true, "unreliableFrom": null }, "bankAccounts": [ { "number": "55567899/2010" }, { "number": "CZ8920100000002301370338" }, { "number": "CZ1420100000002801976854" }, { "number": "CZ6620100000002902049945" } ], "history": [] } }, "flags": { "isActive": true, "isVatPayer": true, "isVatSubject": false } } ] }, "errors": [] } }, "fullDataScope": { "value": { "status": 200, "request": { "endpoint": "company/get", "code": "aabe7368-020d-4d39-bd73-186da0ddfcd0", "query": { "registrationNumber": "04997476", "country": "CZ" }, "options": { "dataSource": [ "CZ", "SK", "PL" ], "dataScope": "full", "includeTerminatedSubjects": false, "nameFormat": "normalized", "countryFormat": "alpha2", "cityFormat": "basic", "zipFormat": false } }, "response": { "results": [ { "data": { "uuid": "ca3665de-ded1-47f7-9bcd-b8c3eb8c52e1", "country": "CZ", "name": "AVANTRO s.r.o.", "nameOfficial": "AVANTRO s.r.o.", "nameAlternative": null, "nameNormalized": "AVANTRO s.r.o.", "registrationNumber": "04997476", "taxNumber": null, "vatNumber": "CZ04997476", "vatNumberSpecial": null, "address": { "data": { "country": "CZ", "state": null, "region": "Hlavní město Praha", "district": "území Hlavního města Prahy", "cityDistrictSpecial": "Praha 8", "cityDistrict": "Praha 8", "cityPart": "Karlín", "cityAdministrative": null, "cadastralArea": "Karlín", "ids": { "internal": "d2ade877-1e95-4a83-baa6-5431ce5b3ca8", "external": "22349995", "region": "19", "district": "9999", "cityDistrictSpecial": "86", "cityDistrict": "500208", "cityPart": "400637", "cadastralArea": "730955", "city": "554782", "street": "472093" }, "street": "Thámova", "number": { "type": "č.p.", "part1": "137", "part1Number": "137", "part1Letter": null, "part2": "16", "part2Number": "16", "part2Letter": null, "full": "137/16" }, "streetWithNumber": "Thámova 137/16", "city": "Praha 8", "zip": "18600", "geometry": { "gps": { "lat": 50.0920005, "lon": 14.4527363 }, "custom": [ { "type": "JTSK", "coordinates": { "x": 1042819.66, "y": 740509.43 } } ] }, "postOffice": { "name": "Praha 86" }, "full": "Thámova 137/16, 18600 Praha 8" } }, "addressOfficial": { "data": { "country": "CZ", "street": "Thámova", "number": { "part1": null, "part1Number": null, "part1Letter": null, "part2": null, "part2Number": null, "part2Letter": null, "full": "137/16" }, "streetWithNumber": "Thámova 137/16", "city": "Praha", "zip": "18600", "full": "Thámova 137/16, 18600 Praha" } }, "legalForm": { "type": "juridical", "code": "112", "name": "Společnost s ručením omezeným" }, "legalFormSpecific": { "code": null, "name": null }, "nace": [ { "code": "00", "name": "Výroba, obchod a služby neuvedené v přílohách 1 až 3 živnostenského zákona", "isPrimary": null }, { "code": "74", "name": "Ostatní odborné, vědecké a technické činnosti", "isPrimary": null }, { "code": "68200", "name": "Pronájem a správa vlastních nebo pronajatých nemovitostí", "isPrimary": null } ], "databoxes": [ { "code": "txutpba", "name": "AVANTRO s.r.o.", "receivingMessages": true } ], "registrations": [ { "type": "businessRegister", "data": { "register": { "code": null, "name": null, "detail": null }, "registrator": { "code": "MSPH", "name": "Městský soud v Praze", "detail": null }, "reference": "C 256795" } }, { "type": "vatRegister", "data": { "register": { "code": null, "name": null, "detail": null }, "registrator": { "code": "008", "name": "Územní pracoviště pro Prahu 8", "detail": null }, "reference": null } } ], "esa2010": { "code": "11002", "name": "Národní soukromé nefinanční podniky" }, "dates": { "created": "2016-04-15", "terminated": null }, "employees": { "category": "1-5", "count": null }, "insolvency": null, "businessPremises": [], "authority": [ { "name": "Statutární orgán", "members": [ { "name": "PAVEL HRDLIČKA", "address": { "data": { "country": "CZ", "state": null, "region": "Olomoucký kraj", "district": "Přerov", "cityDistrictSpecial": null, "cityDistrict": null, "cityPart": "Radslavice", "cityAdministrative": null, "cadastralArea": "Radslavice u Přerova", "ids": { "internal": "4beb117d-e8e1-48ef-a14f-81d906c79ba6", "external": "11148616", "region": "124", "district": "3808", "cityDistrictSpecial": null, "cityDistrict": null, "cityPart": "138819", "cadastralArea": "738816", "city": "517534", "street": "524549" }, "street": "V Zahradách", "number": { "type": "č.p.", "part1": "277", "part1Number": "277", "part1Letter": null, "part2": null, "part2Number": null, "part2Letter": null, "full": "277" }, "streetWithNumber": "V Zahradách 277", "city": "Radslavice", "zip": "75111", "geometry": { "gps": { "lat": 49.4781175, "lon": 17.5104831 }, "custom": [ { "type": "JTSK", "coordinates": { "x": 1136105.4, "y": 529721.06 } } ] }, "postOffice": { "name": "Radslavice" }, "full": "V Zahradách 277, 75111 Radslavice" } }, "addressOfficial": { "data": { "country": "CZ", "street": "V Zahradách", "number": { "part1": null, "part1Number": null, "part1Letter": null, "part2": null, "part2Number": null, "part2Letter": null, "full": "277" }, "streetWithNumber": "V Zahradách 277", "city": "Radslavice", "zip": "75111", "full": null } }, "function": "jednatel", "birthDate": "1990-11-14", "registrationNumber": null } ], "decisions": [ "Společnost zastupuje jednatel samostatně." ] } ], "capital": { "value": { "amount": null, "currency": null }, "shareholders": [], "stocks": [] }, "tradeLicences": [ { "type": "živnost volná", "name": "Výroba, obchod a služby neuvedené v přílohách 1 až 3 živnostenského zákona", "valid": { "from": "2016-04-15", "fromText": null, "to": null, "toText": null }, "interrupted": { "from": null, "to": null }, "responsiblePerson": null, "activitySubjects": [ "Povrchové úpravy a svařování kovů a dalších materiálů", "Výroba neelektrických zařízení pro domácnost", "Výroba a opravy čalounických výrobků", "Sklenářské práce, rámování a paspartování", "Výroba jízdních kol, vozíků pro invalidy a jiných nemotorových dopravních prostředků", "Provozování vodovodů a kanalizací a úprava a rozvod vody", "Stavba a výroba plavidel", "Výroba motorových a přípojných vozidel a karoserií", "Výroba zdravotnických prostředků", "Výroba elektronických součástek, elektrických zařízení a výroba a opravy elektrických strojů, přístrojů a elektronických zařízení pracujících na malém napětí", "Výroba a opravy zdrojů ionizujícího záření", "Umělecko-řemeslné zpracování kovů", "Broušení technického a šperkového kamene", "Výroba brusiv a ostatních minerálních nekovových výrobků", "Výroba stavebních hmot, porcelánových, keramických a sádrových výrobků", "Výroba koksu, surového dehtu a jiných pevných paliv", "Výroba, rozmnožování, distribuce, prodej, pronájem zvukových a zvukově-obrazových záznamů a výroba nenahraných nosičů údajů a záznamů", "Výroba potravinářských a škrobárenských výrobků", "Pěstitelské pálení", "Úprava nerostů, dobývání rašeliny a bahna", "Zastavárenská činnost a maloobchod s použitým zbožím", "Výroba a zpracování skla", "Údržba motorových vozidel a jejich příslušenství", "Poskytování služeb pro rodinu a domácnost", "Výroba, vývoj, projektování, zkoušky, instalace, údržba, opravy, modifikace a konstrukční změny letadel, motorů letadel, vrtulí, letadlových částí a zařízení a leteckých pozemních zařízení", "Zpracování dřeva, výroba dřevěných, korkových, proutěných a slaměných výrobků", "Služby v oblasti administrativní správy a služby organizačně hospodářské povahy", "Reklamní činnost, marketing, mediální zastoupení", "Výroba a opravy obuvi, brašnářského a sedlářského zboží", "Diagnostická, zkušební a poradenská činnost v ochraně rostlin a ošetřování rostlin, rostlinných produktů, objektů a půdy proti škodlivým organismům přípravky na ochranu rostlin nebo biocidními přípravky", "Skladování, balení zboží, manipulace s nákladem a technické činnosti v dopravě", "Velkoobchod a maloobchod", "Zprostředkování obchodu a služeb", "Přípravné a dokončovací stavební práce, specializované stavební činnosti", "Výroba drážních hnacích vozidel a drážních vozidel na dráze tramvajové, trolejbusové a lanové a železničního parku", "Nakládání s odpady (vyjma nebezpečných)", "Výroba dalších výrobků zpracovatelského průmyslu", "Výroba školních a kancelářských potřeb, kromě výrobků z papíru, výroba bižuterie, kartáčnického a konfekčního zboží, deštníků, upomínkových předmětů", "Výroba strojů a zařízení", "Provozování cestovní agentury a průvodcovská činnost v oblasti cestovního ruchu", "Návrhářská, designérská, aranžérská činnost a modeling", "Projektování pozemkových úprav", "Poradenská a konzultační činnost, zpracování odborných studií a posudků", "Činnost informačních a zpravodajských kanceláří", "Poskytování technických služeb", "Praní pro domácnost, žehlení, opravy a údržba oděvů, bytového textilu a osobního zboží", "Provozování tělovýchovných a sportovních zařízení a organizování sportovní činnosti", "Provozování kulturních, kulturně-vzdělávacích a zábavních zařízení, pořádání kulturních produkcí, zábav, výstav, veletrhů, přehlídek, prodejních a obdobných akcí", "Mimoškolní výchova a vzdělávání, pořádání kurzů, školení, včetně lektorské činnosti", "Nakládání s reprodukčním materiálem lesních dřevin", "Testování, měření, analýzy a kontroly", "Výzkum a vývoj v oblasti přírodních a technických věd nebo společenských věd", "Projektování elektrických zařízení", "Příprava a vypracování technických návrhů, grafické a kresličské práce", "Pronájem a půjčování věcí movitých", "Poskytování software, poradenství v oblasti informačních technologií, zpracování dat, hostingové a související činnosti a webové portály", "Ubytovací služby", "Zasilatelství a zastupování v celním řízení", "Potrubní a pozemní doprava (vyjma železniční a silniční motorové dopravy)", "Fotografické služby", "Chov zvířat a jejich výcvik (s výjimkou živočišné výroby)", "Činnost odborného lesního hospodáře a vyhotovování lesních hospodářských plánů a osnov", "Výroba, opravy a údržba sportovních potřeb, her, hraček a dětských kočárků", "Výroba měřicích, zkušebních, navigačních, optických a fotografických přístrojů a zařízení", "Výroba kovových konstrukcí a kovodělných výrobků", "Výroba a hutní zpracování železa, drahých a neželezných kovů a jejich slitin", "Výroba plastových a pryžových výrobků", "Výroba hnojiv", "Výroba chemických látek a chemických směsí nebo předmětů a kosmetických přípravků", "Vydavatelské činnosti, polygrafická výroba, knihařské a kopírovací práce", "Výroba vlákniny, papíru a lepenky a zboží z těchto materiálů", "Výroba textilií, textilních výrobků, oděvů a oděvních doplňků", "Výroba krmiv, krmných směsí, doplňkových látek a premixů", "Poskytování služeb pro zemědělství, zahradnictví, rybníkářství, lesnictví a myslivost", "Výroba, obchod a služby jinde nezařazené", "Poskytování služeb osobního charakteru a pro osobní hygienu", "Opravy a údržba potřeb pro domácnost, předmětů kulturní povahy, výrobků jemné mechaniky, optických přístrojů a měřidel", "Překladatelská a tlumočnická činnost", "Nákup, prodej, správa a údržba nemovitostí" ] } ], "vat": { "status": "payer", "reliability": { "reliable": true, "unreliableFrom": null }, "bankAccounts": [ { "number": "55567899/2010" }, { "number": "CZ8920100000002301370338" }, { "number": "CZ1420100000002801976854" }, { "number": "CZ6620100000002902049945" } ], "history": [ { "vatNumber": "CZ04997476", "registrationType": "payer", "validFrom": "2017-09-01", "validTo": null, "isGroupRegistration": false } ] } }, "flags": { "isActive": true, "isVatPayer": true, "isVatSubject": false, "isInInsolvency": false } } ] }, "errors": [] } } } } } }, "400": { "description": "Bad Request.", "headers": { "foxentry-api-version": { "$ref": "#/paths/~1company~1get/post/responses/200/headers/foxentry-api-version" }, "foxentry-rate-limit": { "$ref": "#/paths/~1company~1get/post/responses/200/headers/foxentry-rate-limit" }, "foxentry-rate-limit-period": { "$ref": "#/paths/~1company~1get/post/responses/200/headers/foxentry-rate-limit-period" }, "foxentry-rate-limit-remaining": { "$ref": "#/paths/~1company~1get/post/responses/200/headers/foxentry-rate-limit-remaining" } }, "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "properties": { "status": { "type": "integer", "description": "Status of API response.", "example": 400 } } }, { "type": "object", "properties": { "request": { "$ref": "#/paths/~1company~1get/post/responses/200/content/application~1json/schema/properties/request/allOf/1" } } }, { "type": "object", "properties": { "status": { "type": "integer", "description": "Status of API response.", "example": 400 }, "errors": { "description": "List of errors related to the request. Should be empty if the request finished successfully.", "type": "array", "items": { "oneOf": [ { "title": "Empty request body error", "type": "object", "properties": { "group": { "enum": [ "REQUEST" ], "description": "Group of error.", "example": "REQUEST" }, "type": { "enum": [ "BODY" ], "description": "Type of error.", "example": "BODY" }, "subtype": { "enum": [ "EMPTY" ], "description": "Subtype of error.", "example": "EMPTY" }, "severity": { "enum": [ "critical" ], "description": "Severity of error. Info = cosmetic changes that don't change the overall meaning. Warning = typos and other errors that could affect the meaning. Critical = critical errors.", "example": "critical" }, "relatedTo": { "description": "List of the affected inputs.", "type": "array", "items": { "type": "string", "description": "Error related to." } }, "description": { "type": [ "string", "null" ], "description": "Description of error.", "example": "Cannot process the request because of the empty body. Please check Foxentry.dev for more information." } } }, { "title": "Request body not JSON error", "type": "object", "properties": { "group": { "enum": [ "REQUEST" ], "description": "Group of error.", "example": "REQUEST" }, "type": { "enum": [ "BODY" ], "description": "Type of error.", "example": "BODY" }, "subtype": { "enum": [ "NOT_JSON" ], "description": "Subtype of error.", "example": "NOT_JSON" }, "severity": { "enum": [ "critical" ], "description": "Severity of error. Info = cosmetic changes that don't change the overall meaning. Warning = typos and other errors that could affect the meaning. Critical = critical errors.", "example": "critical" }, "relatedTo": { "description": "List of the affected inputs.", "type": "array", "items": { "type": "string", "description": "Error related to." } }, "description": { "type": [ "string", "null" ], "description": "Description of error.", "example": "Cannot process the request because the JSON is not valid. Please check Foxentry.dev for more information." } } }, { "title": "No request in request body error", "type": "object", "properties": { "group": { "enum": [ "REQUEST" ], "description": "Group of error.", "example": "REQUEST" }, "type": { "enum": [ "BODY" ], "description": "Type of error.", "example": "BODY" }, "subtype": { "enum": [ "NOT_JSON" ], "description": "Subtype of error.", "example": "NOT_JSON" }, "severity": { "enum": [ "critical" ], "description": "Severity of error. Info = cosmetic changes that don't change the overall meaning. Warning = typos and other errors that could affect the meaning. Critical = critical errors.", "example": "critical" }, "relatedTo": { "description": "List of the affected inputs.", "type": "array", "items": { "type": "string", "description": "Error related to." } }, "description": { "type": [ "string", "null" ], "description": "Description of error.", "example": "Your API call body does not contain any requests." } } }, { "title": "Request body too big error", "type": "object", "properties": { "group": { "enum": [ "REQUEST" ], "description": "Group of error.", "example": "REQUEST" }, "type": { "enum": [ "BODY" ], "description": "Type of error.", "example": "BODY" }, "subtype": { "enum": [ "TOO_BIG" ], "description": "Subtype of error.", "example": "TOO_BIG" }, "severity": { "enum": [ "critical" ], "description": "Severity of error. Info = cosmetic changes that don't change the overall meaning. Warning = typos and other errors that could affect the meaning. Critical = critical errors.", "example": "critical" }, "relatedTo": { "description": "List of the affected inputs.", "type": "array", "items": { "type": "string", "description": "Error related to." } }, "description": { "type": [ "string", "null" ], "description": "Description of error.", "example": "Your request length is bigger than allowed. Please contact us if you think this is a mistake." } } }, { "title": "Options parameter not supported error", "type": "object", "properties": { "group": { "enum": [ "REQUEST" ], "description": "Group of error.", "example": "REQUEST" }, "type": { "enum": [ "OPTIONS" ], "description": "Type of error.", "example": "OPTIONS" }, "subtype": { "enum": [ "PARAMETER_NOT_SUPPORTED" ], "description": "Subtype of error.", "example": "PARAMETER_NOT_SUPPORTED" }, "severity": { "enum": [ "critical" ], "description": "Severity of error. Info = cosmetic changes that don't change the overall meaning. Warning = typos and other errors that could affect the meaning. Critical = critical errors.", "example": "critical" }, "relatedTo": { "description": "List of the affected inputs.", "type": "array", "items": { "type": "string", "description": "Error related to." } }, "description": { "type": [ "string", "null" ], "description": "Description of error.", "example": "Options parameter is not supported for this endpoint." } } }, { "title": "Option parameter value not supported error", "type": "object", "properties": { "group": { "enum": [ "REQUEST" ], "description": "Group of error.", "example": "REQUEST" }, "type": { "enum": [ "OPTIONS" ], "description": "Type of error.", "example": "OPTIONS" }, "subtype": { "enum": [ "PARAMETER_VALUE_NOT_SUPPORTED" ], "description": "Subtype of error.", "example": "PARAMETER_VALUE_NOT_SUPPORTED" }, "severity": { "enum": [ "critical" ], "description": "Severity of error. Info = cosmetic changes that don't change the overall meaning. Warning = typos and other errors that could affect the meaning. Critical = critical errors.", "example": "critical" }, "relatedTo": { "description": "List of the affected inputs.", "type": "array", "items": { "type": "string", "description": "Error related to." } }, "description": { "type": [ "string", "null" ], "description": "Description of error.", "example": "Value in paramater is not valid. Please check Foxentry.dev for more information." } } }, { "title": "Options parameter not supported error", "type": "object", "properties": { "group": { "enum": [ "REQUEST" ], "description": "Group of error.", "example": "REQUEST" }, "type": { "enum": [ "CLIENT" ], "description": "Type of error.", "example": "CLIENT" }, "subtype": { "enum": [ "PARAMETER_NOT_SUPPORTED" ], "description": "Subtype of error.", "example": "PARAMETER_NOT_SUPPORTED" }, "severity": { "enum": [ "critical" ], "description": "Severity of error. Info = cosmetic changes that don't change the overall meaning. Warning = typos and other errors that could affect the meaning. Critical = critical errors.", "example": "critical" }, "relatedTo": { "description": "List of the affected inputs.", "type": "array", "items": { "type": "string", "description": "Error related to." } }, "description": { "type": [ "string", "null" ], "description": "Description of error.", "example": "Options parameter is not supported for this endpoint." } } }, { "title": "Options parameter not supported error", "type": "object", "properties": { "group": { "enum": [ "REQUEST" ], "description": "Group of error.", "example": "REQUEST" }, "type": { "enum": [ "CLIENT" ], "description": "Type of error.", "example": "CLIENT" }, "subtype": { "enum": [ "PARAMETER_VALUE_NOT_SUPPORTED" ], "description": "Subtype of error.", "example": "PARAMETER_VALUE_NOT_SUPPORTED" }, "severity": { "enum": [ "critical" ], "description": "Severity of error. Info = cosmetic changes that don't change the overall meaning. Warning = typos and other errors that could affect the meaning. Critical = critical errors.", "example": "critical" }, "relatedTo": { "description": "List of the affected inputs.", "type": "array", "items": { "type": "string", "description": "Error related to." } }, "description": { "type": [ "string", "null" ], "description": "Description of error.", "example": "Options parameter is not supported for this endpoint." } } }, { "title": "Request query empty error", "type": "object", "properties": { "group": { "enum": [ "REQUEST" ], "description": "Group of error.", "example": "REQUEST" }, "type": { "enum": [ "QUERY" ], "description": "Type of error.", "example": "QUERY" }, "subtype": { "enum": [ "NOT_SENT" ], "description": "Subtype of error.", "example": "NOT_SENT" }, "severity": { "enum": [ "critical" ], "description": "Severity of error. Info = cosmetic changes that don't change the overall meaning. Warning = typos and other errors that could affect the meaning. Critical = critical errors.", "example": "critical" }, "relatedTo": { "description": "List of the affected inputs.", "type": "array", "items": { "type": "string", "description": "Error related to." } }, "description": { "type": [ "string", "null" ], "description": "Description of error.", "example": "Your request query is empty. Please check Foxentry.dev for more information about how to set up the query properly." } } }, { "title": "Query parameter combination error", "type": "object", "properties": { "group": { "enum": [ "REQUEST" ], "description": "Group of error.", "example": "REQUEST" }, "type": { "enum": [ "QUERY" ], "description": "Type of error.", "example": "QUERY" }, "subtype": { "enum": [ "PARAMETERS_COMBINATION" ], "description": "Subtype of error.", "example": "PARAMETERS_COMBINATION" }, "severity": { "enum": [ "critical" ], "description": "Severity of error. Info = cosmetic changes that don't change the overall meaning. Warning = typos and other errors that could affect the meaning. Critical = critical errors.", "example": "critical" }, "relatedTo": { "description": "List of the affected inputs.", "type": "array", "items": { "type": "string", "description": "Error related to.", "example": "streetWithNumber" }, "example": [ "streetWithNumber", "street" ] }, "description": { "type": [ "string", "null" ], "description": "Description of error.", "example": "It is not possible to use these parameters at the same time in one request." } } }, { "title": "Request query parameter not supported for this query error", "type": "object", "properties": { "group": { "enum": [ "REQUEST" ], "description": "Group of error.", "example": "REQUEST" }, "type": { "enum": [ "OPTIONS" ], "description": "Type of error.", "example": "OPTIONS" }, "subtype": { "enum": [ "PARAMETER_NOT_SUPPORTED_FOR_QUERY" ], "description": "Subtype of error.", "example": "PARAMETER_NOT_SUPPORTED_FOR_QUERY" }, "severity": { "enum": [ "critical" ], "description": "Severity of error. Info = cosmetic changes that don't change the overall meaning. Warning = typos and other errors that could affect the meaning. Critical = critical errors.", "example": "critical" }, "relatedTo": { "description": "List of the affected inputs.", "type": "array", "items": { "type": "string", "description": "Error related to.", "example": "allowPartialResults" }, "example": [ "allowPartialResults" ] }, "description": { "type": [ "string", "null" ], "description": "Description of error.", "example": "Parameter can not be used in combination with this query parameters." } } }, { "title": "Request options parameter combination error", "type": "object", "properties": { "group": { "enum": [ "REQUEST" ], "description": "Group of error.", "example": "REQUEST" }, "type": { "enum": [ "OPTIONS" ], "description": "Type of error.", "example": "OPTIONS" }, "subtype": { "enum": [ "PARAMETERS_COMBINATION" ], "description": "Subtype of error.", "example": "PARAMETERS_COMBINATION" }, "severity": { "enum": [ "critical" ], "description": "Severity of error. Info = cosmetic changes that don't change the overall meaning. Warning = typos and other errors that could affect the meaning. Critical = critical errors.", "example": "critical" }, "relatedTo": { "description": "List of the affected inputs.", "type": "array", "items": { "type": "string", "description": "Error related to." } }, "description": { "type": [ "string", "null" ], "description": "Description of error.", "example": "Combination of options or their values is not valid." } } }, { "title": "Query parameter missing error", "type": "object", "properties": { "group": { "enum": [ "REQUEST" ], "description": "Group of error.", "example": "REQUEST" }, "type": { "enum": [ "QUERY" ], "description": "Type of error.", "example": "QUERY" }, "subtype": { "enum": [ "PARAMETERS_MISSING" ], "description": "Subtype of error.", "example": "PARAMETERS_MISSING" }, "severity": { "enum": [ "critical" ], "description": "Severity of error. Info = cosmetic changes that don't change the overall meaning. Warning = typos and other errors that could affect the meaning. Critical = critical errors.", "example": "critical" }, "relatedTo": { "description": "List of the affected inputs.", "type": "array", "items": { "type": "string", "description": "Error related to.", "example": "prefix" } }, "description": { "type": [ "string", "null" ], "description": "Description of error.", "example": "Query parameter is missing. Please check Foxentry.dev for more information about how to set up the query properly." } } }, { "title": "Request query parameter not supported error", "type": "object", "properties": { "group": { "enum": [ "REQUEST" ], "description": "Group of error.", "example": "REQUEST" }, "type": { "enum": [ "QUERY" ], "description": "Type of error.", "example": "QUERY" }, "subtype": { "enum": [ "PARAMETERS_NOT_SUPPORTED" ], "description": "Subtype of error.", "example": "PARAMETERS_NOT_SUPPORTED" }, "severity": { "enum": [ "critical" ], "description": "Severity of error. Info = cosmetic changes that don't change the overall meaning. Warning = typos and other errors that could affect the meaning. Critical = critical errors.", "example": "critical" }, "relatedTo": { "description": "List of the affected inputs.", "type": "array", "items": { "type": "string", "description": "Error related to." }, "example": [ "unsupportedParameter" ] }, "description": { "type": [ "string", "null" ], "description": "Description of error.", "example": "Query parameter is not supported for this endpoint." } } }, { "title": "Request query parameter required error", "type": "object", "properties": { "group": { "enum": [ "REQUEST" ], "description": "Group of error.", "example": "REQUEST" }, "type": { "enum": [ "QUERY" ], "description": "Type of error.", "example": "QUERY" }, "subtype": { "enum": [ "PARAMETERS_REQUIRED" ], "description": "Subtype of error.", "example": "PARAMETERS_REQUIRED" }, "severity": { "enum": [ "critical" ], "description": "Severity of error. Info = cosmetic changes that don't change the overall meaning. Warning = typos and other errors that could affect the meaning. Critical = critical errors.", "example": "critical" }, "relatedTo": { "description": "List of the affected inputs.", "type": "array", "items": { "type": "string", "description": "Error related to.", "example": "email" } }, "description": { "type": [ "string", "null" ], "description": "Description of error.", "example": "At least one of listed parameters is required." } } } ] } } } } ] } } } }, "401": { "description": "Unauthorized.", "headers": { "foxentry-api-version": { "$ref": "#/paths/~1company~1get/post/responses/200/headers/foxentry-api-version" }, "foxentry-rate-limit": { "$ref": "#/paths/~1company~1get/post/responses/200/headers/foxentry-rate-limit" }, "foxentry-rate-limit-period": { "$ref": "#/paths/~1company~1get/post/responses/200/headers/foxentry-rate-limit-period" }, "foxentry-rate-limit-remaining": { "$ref": "#/paths/~1company~1get/post/responses/200/headers/foxentry-rate-limit-remaining" } }, "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "properties": { "status": { "type": "integer", "description": "Status of API response.", "example": 401 } } }, { "type": "object", "properties": { "request": { "$ref": "#/paths/~1company~1get/post/responses/200/content/application~1json/schema/properties/request/allOf/1" } } }, { "type": "object", "properties": { "errors": { "description": "List of errors related to the request. Should be empty if the request finished successfully.", "type": "array", "items": { "title": "Request authorization error", "type": "object", "properties": { "group": { "enum": [ "REQUEST" ], "description": "Group of error.", "example": "REQUEST" }, "type": { "enum": [ "AUTH" ], "description": "Type of error.", "example": "AUTH" }, "subtype": { "type": [ "string", "null" ], "description": "Subtype of error." }, "severity": { "enum": [ "critical" ], "description": "Severity of error. Info = cosmetic changes that don't change the overall meaning. Warning = typos and other errors that could affect the meaning. Critical = critical errors.", "example": "critical" }, "relatedTo": { "description": "List of the affected inputs.", "type": "array", "items": { "type": "string", "description": "Error related to." } }, "description": { "type": [ "string", "null" ], "description": "Description of error.", "example": "Invalid authorization credentials sent. Check Foxentry.dev for more information how to set up the AUTH properly." } } } } } } ] } } } }, "402": { "description": "Payment Required.", "headers": { "foxentry-api-version": { "$ref": "#/paths/~1company~1get/post/responses/200/headers/foxentry-api-version" }, "foxentry-rate-limit": { "$ref": "#/paths/~1company~1get/post/responses/200/headers/foxentry-rate-limit" }, "foxentry-rate-limit-period": { "$ref": "#/paths/~1company~1get/post/responses/200/headers/foxentry-rate-limit-period" }, "foxentry-rate-limit-remaining": { "$ref": "#/paths/~1company~1get/post/responses/200/headers/foxentry-rate-limit-remaining" } }, "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "properties": { "status": { "type": "integer", "description": "Status of API response.", "example": 402 } } }, { "type": "object", "properties": { "request": { "$ref": "#/paths/~1company~1get/post/responses/200/content/application~1json/schema/properties/request/allOf/1" } } }, { "type": "object", "properties": { "errors": { "description": "List of errors related to the request. Should be empty if the request finished successfully.", "type": "array", "items": { "title": "Request billing error - no credit", "type": "object", "properties": { "group": { "enum": [ "REQUEST" ], "description": "Group of error.", "example": "REQUEST" }, "type": { "enum": [ "BILLING" ], "description": "Type of error.", "example": "BILLING" }, "subtype": { "enum": [ "NO_CREDIT" ], "description": "Subtype of error.", "example": "NO_CREDIT" }, "severity": { "enum": [ "critical" ], "description": "Severity of error. Info = cosmetic changes that don't change the overall meaning. Warning = typos and other errors that could affect the meaning. Critical = critical errors.", "example": "critical" }, "relatedTo": { "description": "List of the affected inputs.", "type": "array", "items": { "type": "string", "description": "Error related to." } }, "description": { "type": [ "string", "null" ], "description": "Description of error.", "example": "No credit available. You need to purchase a sufficient amount of credits in the project administration at app.foxentry.com." } } } } } } ] } } } }, "403": { "description": "Forbidden.", "headers": { "foxentry-api-version": { "$ref": "#/paths/~1company~1get/post/responses/200/headers/foxentry-api-version" }, "foxentry-rate-limit": { "$ref": "#/paths/~1company~1get/post/responses/200/headers/foxentry-rate-limit" }, "foxentry-rate-limit-period": { "$ref": "#/paths/~1company~1get/post/responses/200/headers/foxentry-rate-limit-period" }, "foxentry-rate-limit-remaining": { "$ref": "#/paths/~1company~1get/post/responses/200/headers/foxentry-rate-limit-remaining" } }, "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "properties": { "status": { "type": "integer", "description": "Status of API response.", "example": 403 } } }, { "type": "object", "properties": { "request": { "$ref": "#/paths/~1company~1get/post/responses/200/content/application~1json/schema/properties/request/allOf/1" } } }, { "type": "object", "properties": { "errors": { "description": "List of errors related to the request. Should be empty if the request finished successfully.", "type": "array", "items": { "oneOf": [ { "title": "Invalid api key error", "type": "object", "properties": { "group": { "enum": [ "REQUEST" ], "description": "Group of error.", "example": "REQUEST" }, "type": { "enum": [ "AUTH" ], "description": "Type of error.", "example": "AUTH" }, "subtype": { "enum": [ "KEY" ], "description": "Subtype of error.", "example": "KEY" }, "severity": { "enum": [ "critical" ], "description": "Severity of error. Info = cosmetic changes that don't change the overall meaning. Warning = typos and other errors that could affect the meaning. Critical = critical errors.", "example": "critical" }, "relatedTo": { "description": "List of the affected inputs.", "type": "array", "items": { "type": "string", "description": "Error related to." } }, "description": { "type": [ "string", "null" ], "description": "Description of error.", "example": "Provided API key is not valid. Please check the project settings at app.foxentry.com." } } }, { "title": "Invalid access token error", "type": "object", "properties": { "group": { "enum": [ "REQUEST" ], "description": "Group of error.", "example": "REQUEST" }, "type": { "enum": [ "AUTH" ], "description": "Type of error.", "example": "AUTH" }, "subtype": { "enum": [ "TOKEN" ], "description": "Subtype of error.", "example": "TOKEN" }, "severity": { "enum": [ "critical" ], "description": "Severity of error. Info = cosmetic changes that don't change the overall meaning. Warning = typos and other errors that could affect the meaning. Critical = critical errors.", "example": "critical" }, "relatedTo": { "description": "List of the affected inputs.", "type": "array", "items": { "type": "string", "description": "Error related to." } }, "description": { "type": [ "string", "null" ], "description": "Description of error.", "example": "Provided access token is not valid. Please check the project settings at app.foxentry.com." } } }, { "title": "Domain not allowed error", "type": "object", "properties": { "group": { "enum": [ "REQUEST" ], "description": "Group of error.", "example": "REQUEST" }, "type": { "enum": [ "NOT_ALLOWED" ], "description": "Type of error.", "example": "NOT_ALLOWED" }, "subtype": { "enum": [ "DOMAIN" ], "description": "Subtype of error.", "example": "DOMAIN" }, "severity": { "enum": [ "critical" ], "description": "Severity of error. Info = cosmetic changes that don't change the overall meaning. Warning = typos and other errors that could affect the meaning. Critical = critical errors.", "example": "critical" }, "relatedTo": { "description": "List of the affected inputs.", "type": "array", "items": { "type": "string", "description": "Error related to." } }, "description": { "type": [ "string", "null" ], "description": "Description of error.", "example": "Website domain is not allowed in the project settings." } } }, { "title": "IP address not allowed error", "type": "object", "properties": { "group": { "enum": [ "REQUEST" ], "description": "Group of error.", "example": "REQUEST" }, "type": { "enum": [ "NOT_ALLOWED" ], "description": "Type of error.", "example": "NOT_ALLOWED" }, "subtype": { "enum": [ "IP" ], "description": "Subtype of error.", "example": "IP" }, "severity": { "enum": [ "critical" ], "description": "Severity of error. Info = cosmetic changes that don't change the overall meaning. Warning = typos and other errors that could affect the meaning. Critical = critical errors.", "example": "critical" }, "relatedTo": { "description": "List of the affected inputs.", "type": "array", "items": { "type": "string", "description": "Error related to." } }, "description": { "type": [ "string", "null" ], "description": "Description of error.", "example": "The API key has IP limits set and your IP address is not allowed. Change the project settings at app.foxentry.com." } } } ] } } } } ] } } } }, "404": { "description": "Not Found.", "headers": { "foxentry-api-version": { "$ref": "#/paths/~1company~1get/post/responses/200/headers/foxentry-api-version" }, "foxentry-rate-limit": { "$ref": "#/paths/~1company~1get/post/responses/200/headers/foxentry-rate-limit" }, "foxentry-rate-limit-period": { "$ref": "#/paths/~1company~1get/post/responses/200/headers/foxentry-rate-limit-period" }, "foxentry-rate-limit-remaining": { "$ref": "#/paths/~1company~1get/post/responses/200/headers/foxentry-rate-limit-remaining" } }, "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "properties": { "status": { "type": "integer", "description": "Status of API response.", "example": 404 } } }, { "type": "object", "properties": { "request": { "$ref": "#/paths/~1company~1get/post/responses/200/content/application~1json/schema/properties/request/allOf/1" } } }, { "type": "object", "properties": { "errors": { "description": "List of errors related to the request. Should be empty if the request finished successfully.", "type": "array", "items": { "oneOf": [ { "title": "Api version not found error", "type": "object", "properties": { "group": { "enum": [ "REQUEST" ], "description": "Group of error.", "example": "REQUEST" }, "type": { "enum": [ "API_VERSION" ], "description": "Type of error.", "example": "API_VERSION" }, "subtype": { "type": [ "string", "null" ], "description": "Subtype of error." }, "severity": { "enum": [ "critical" ], "description": "Severity of error. Info = cosmetic changes that don't change the overall meaning. Warning = typos and other errors that could affect the meaning. Critical = critical errors.", "example": "critical" }, "relatedTo": { "description": "List of the affected inputs.", "type": "array", "items": { "type": "string", "description": "Error related to." } }, "description": { "type": [ "string", "null" ], "description": "Description of error.", "example": "Requested API version is not available. Please check Foxentry.dev for the supported versions." } } }, { "title": "Endpoint not found error", "type": "object", "properties": { "group": { "enum": [ "REQUEST" ], "description": "Group of error.", "example": "REQUEST" }, "type": { "enum": [ "ENDPOINT" ], "description": "Type of error.", "example": "ENDPOINT" }, "subtype": { "enum": [ "NOT_FOUND" ], "description": "Subtype of error.", "example": "NOT_FOUND" }, "severity": { "enum": [ "critical" ], "description": "Severity of error. Info = cosmetic changes that don't change the overall meaning. Warning = typos and other errors that could affect the meaning. Critical = critical errors.", "example": "critical" }, "relatedTo": { "description": "List of the affected inputs.", "type": "array", "items": { "type": "string", "description": "Error related to." } }, "description": { "type": [ "string", "null" ], "description": "Description of error.", "example": "Endpoint not found. Please check Foxentry.dev for the supported endpoints." } } }, { "title": "Project not found error", "type": "object", "properties": { "group": { "enum": [ "REQUEST" ], "description": "Group of error.", "example": "REQUEST" }, "type": { "enum": [ "PROJECT" ], "description": "Type of error.", "example": "PROJECT" }, "subtype": { "enum": [ "NOT_FOUND" ], "description": "Subtype of error.", "example": "NOT_FOUND" }, "severity": { "enum": [ "critical" ], "description": "Severity of error. Info = cosmetic changes that don't change the overall meaning. Warning = typos and other errors that could affect the meaning. Critical = critical errors.", "example": "critical" }, "relatedTo": { "description": "List of the affected inputs.", "type": "array", "items": { "type": "string", "description": "Error related to." } }, "description": { "type": [ "string", "null" ], "description": "Description of error.", "example": "The project does not exist. Please check the available projects at app.foxentry.com or contact the support." } } } ] } } } } ] } } } }, "405": { "description": "Method Not Allowed.", "headers": { "foxentry-api-version": { "$ref": "#/paths/~1company~1get/post/responses/200/headers/foxentry-api-version" }, "foxentry-rate-limit": { "$ref": "#/paths/~1company~1get/post/responses/200/headers/foxentry-rate-limit" }, "foxentry-rate-limit-period": { "$ref": "#/paths/~1company~1get/post/responses/200/headers/foxentry-rate-limit-period" }, "foxentry-rate-limit-remaining": { "$ref": "#/paths/~1company~1get/post/responses/200/headers/foxentry-rate-limit-remaining" } }, "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "properties": { "status": { "type": "integer", "description": "Status of API response.", "example": 405 } } }, { "type": "object", "properties": { "request": { "$ref": "#/paths/~1company~1get/post/responses/200/content/application~1json/schema/properties/request/allOf/1" } } }, { "type": "object", "properties": { "errors": { "type": "array", "items": { "title": "Request method not allowed error", "type": "object", "properties": { "group": { "enum": [ "REQUEST" ], "description": "Group of error.", "example": "REQUEST" }, "type": { "enum": [ "ENDPOINT" ], "description": "Type of error.", "example": "ENDPOINT" }, "subtype": { "enum": [ "NOT_ALLOWED" ], "description": "Subtype of error.", "example": "NOT_ALLOWED" }, "severity": { "enum": [ "critical" ], "description": "Severity of error. Info = cosmetic changes that don't change the overall meaning. Warning = typos and other errors that could affect the meaning. Critical = critical errors.", "example": "critical" }, "relatedTo": { "description": "List of the affected inputs.", "type": "array", "items": { "type": "string", "description": "Error related to." } }, "description": { "type": [ "string", "null" ], "description": "Description of error.", "example": "HTTP method is not allowed for this endpoint. Please check Foxentry.dev for more information." } } } } } } ] } } } }, "429": { "description": "Too Many Requests.", "headers": { "foxentry-api-version": { "$ref": "#/paths/~1company~1get/post/responses/200/headers/foxentry-api-version" }, "foxentry-rate-limit": { "$ref": "#/paths/~1company~1get/post/responses/200/headers/foxentry-rate-limit" }, "foxentry-rate-limit-period": { "$ref": "#/paths/~1company~1get/post/responses/200/headers/foxentry-rate-limit-period" }, "foxentry-rate-limit-remaining": { "$ref": "#/paths/~1company~1get/post/responses/200/headers/foxentry-rate-limit-remaining" } }, "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "properties": { "status": { "type": "integer", "description": "Status of API response.", "example": 429 } } }, { "type": "object", "properties": { "request": { "$ref": "#/paths/~1company~1get/post/responses/200/content/application~1json/schema/properties/request/allOf/1" } } }, { "type": "object", "properties": { "errors": { "description": "List of errors related to the request. Should be empty if the request finished successfully.", "type": "array", "items": { "oneOf": [ { "title": "Maximum service limit reached error", "type": "object", "properties": { "group": { "enum": [ "REQUEST" ], "description": "Group of error.", "example": "REQUEST" }, "type": { "enum": [ "BILLING" ], "description": "Type of error.", "example": "BILLING" }, "subtype": { "enum": [ "SERVICE_LIMIT_REACHED" ], "description": "Subtype of error.", "example": "SERVICE_LIMIT_REACHED" }, "severity": { "enum": [ "critical" ], "description": "Severity of error. Info = cosmetic changes that don't change the overall meaning. Warning = typos and other errors that could affect the meaning. Critical = critical errors.", "example": "critical" }, "relatedTo": { "description": "List of the affected inputs.", "type": "array", "items": { "type": "string", "description": "Error related to." } }, "description": { "type": [ "string", "null" ], "description": "Description of error.", "example": "The maximum service limit has been reached. Move to the higher paying plan or allow requests over the subscription." } } }, { "title": "Daily credit limit reached error", "type": "object", "properties": { "group": { "enum": [ "REQUEST" ], "description": "Group of error.", "example": "REQUEST" }, "type": { "enum": [ "RATE_LIMIT" ], "description": "Type of error.", "example": "RATE_LIMIT" }, "subtype": { "enum": [ "CREDIT_PER_DAY" ], "description": "Subtype of error.", "example": "CREDIT_PER_DAY" }, "severity": { "enum": [ "critical" ], "description": "Severity of error. Info = cosmetic changes that don't change the overall meaning. Warning = typos and other errors that could affect the meaning. Critical = critical errors.", "example": "critical" }, "relatedTo": { "description": "List of the affected inputs.", "type": "array", "items": { "type": "string", "description": "Error related to." } }, "description": { "type": [ "string", "null" ], "description": "Description of error.", "example": "The maximum daily limit has been reached. Adjust the settings in the project or wait until the limit is reset." } } }, { "title": "Daily credit limit per IP reached error", "type": "object", "properties": { "group": { "enum": [ "REQUEST" ], "description": "Group of error.", "example": "REQUEST" }, "type": { "enum": [ "RATE_LIMIT" ], "description": "Type of error.", "example": "RATE_LIMIT" }, "subtype": { "enum": [ "CREDIT_PER_IP" ], "description": "Subtype of error.", "example": "CREDIT_PER_IP" }, "severity": { "enum": [ "critical" ], "description": "Severity of error. Info = cosmetic changes that don't change the overall meaning. Warning = typos and other errors that could affect the meaning. Critical = critical errors.", "example": "critical" }, "relatedTo": { "description": "List of the affected inputs.", "type": "array", "items": { "type": "string", "description": "Error related to." } }, "description": { "type": [ "string", "null" ], "description": "Description of error.", "example": "The maximum daily limit per IP address has been reached. Adjust the settings in the project or wait until the limit is reset." } } }, { "title": "Request rate limit reached error", "type": "object", "properties": { "group": { "enum": [ "REQUEST" ], "description": "Group of error.", "example": "REQUEST" }, "type": { "enum": [ "RATE_LIMIT" ], "description": "Type of error.", "example": "RATE_LIMIT" }, "subtype": { "enum": [ "TOO_MANY_REQUESTS" ], "description": "Subtype of error.", "example": "TOO_MANY_REQUESTS" }, "severity": { "enum": [ "critical" ], "description": "Severity of error. Info = cosmetic changes that don't change the overall meaning. Warning = typos and other errors that could affect the meaning. Critical = critical errors.", "example": "critical" }, "relatedTo": { "description": "List of the affected inputs.", "type": "array", "items": { "type": "string", "description": "Error related to." } }, "description": { "type": [ "string", "null" ], "description": "Description of error.", "example": "The maximum allowed request rate limit has been reached. Check Foxentry.dev for more information or contact the support." } } } ] } } } } ] } } } }, "500": { "description": "Internal Server Error.", "headers": { "foxentry-api-version": { "$ref": "#/paths/~1company~1get/post/responses/200/headers/foxentry-api-version" }, "foxentry-rate-limit": { "$ref": "#/paths/~1company~1get/post/responses/200/headers/foxentry-rate-limit" }, "foxentry-rate-limit-period": { "$ref": "#/paths/~1company~1get/post/responses/200/headers/foxentry-rate-limit-period" }, "foxentry-rate-limit-remaining": { "$ref": "#/paths/~1company~1get/post/responses/200/headers/foxentry-rate-limit-remaining" } }, "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "properties": { "status": { "type": "integer", "description": "Status of API response.", "example": 500 } } }, { "type": "object", "properties": { "request": { "$ref": "#/paths/~1company~1get/post/responses/200/content/application~1json/schema/properties/request/allOf/1" } } }, { "type": "object", "properties": { "errors": { "description": "List of errors related to the request. Should be empty if the request finished successfully.", "type": "array", "items": { "oneOf": [ { "title": "Internal billing error", "type": "object", "properties": { "group": { "enum": [ "INTERNAL" ], "description": "Group of error.", "example": "INTERNAL" }, "type": { "enum": [ "BILLING" ], "description": "Type of error.", "example": "BILLING" }, "subtype": { "type": [ "string", "null" ], "description": "Subtype of error." }, "severity": { "type": "string", "description": "Severity of error. Info = cosmetic changes that don't change the overall meaning. Warning = typos and other errors that could affect the meaning. Critical = critical errors.", "example": "critical" }, "relatedTo": { "description": "List of the affected inputs.", "type": "array", "items": { "type": "string", "description": "Error related to." } }, "description": { "type": [ "string", "null" ], "description": "Description of error.", "example": "Failed to process your request due to a billing internal error. Please contact us if the error persists." } } }, { "title": "Database connection error", "type": "object", "properties": { "group": { "enum": [ "INTERNAL" ], "description": "Group of error.", "example": "INTERNAL" }, "type": { "enum": [ "DATABASE" ], "description": "Type of error.", "example": "DATABASE" }, "subtype": { "enum": [ "CONNECTION" ], "description": "Subtype of error.", "example": "CONNECTION" }, "severity": { "type": "string", "description": "Severity of error. Info = cosmetic changes that don't change the overall meaning. Warning = typos and other errors that could affect the meaning. Critical = critical errors.", "example": "critical" }, "relatedTo": { "description": "List of the affected inputs.", "type": "array", "items": { "type": "string", "description": "Error related to." } }, "description": { "type": [ "string", "null" ], "description": "Description of error.", "example": "Failed to establish connection with the database server. Please contact us if the error persists." } } }, { "title": "Internal database error", "type": "object", "properties": { "group": { "enum": [ "INTERNAL" ], "description": "Group of error.", "example": "INTERNAL" }, "type": { "enum": [ "DATABASE" ], "description": "Type of error.", "example": "DATABASE" }, "subtype": { "enum": [ "ERROR" ], "description": "Subtype of error.", "example": "ERROR" }, "severity": { "type": "string", "description": "Severity of error. Info = cosmetic changes that don't change the overall meaning. Warning = typos and other errors that could affect the meaning. Critical = critical errors.", "example": "critical" }, "relatedTo": { "description": "List of the affected inputs.", "type": "array", "items": { "type": "string", "description": "Error related to." } }, "description": { "type": [ "string", "null" ], "description": "Description of error.", "example": "An error has occurred during the communication with our database. Please contact us if the error persists." } } }, { "title": "Database not available error", "type": "object", "properties": { "group": { "enum": [ "INTERNAL" ], "description": "Group of error.", "example": "INTERNAL" }, "type": { "enum": [ "DATABASE" ], "description": "Type of error.", "example": "DATABASE" }, "subtype": { "enum": [ "NOT_AVAILABLE" ], "description": "Subtype of error.", "example": "NOT_AVAILABLE" }, "severity": { "type": "string", "description": "Severity of error. Info = cosmetic changes that don't change the overall meaning. Warning = typos and other errors that could affect the meaning. Critical = critical errors.", "example": "critical" }, "relatedTo": { "description": "List of the affected inputs.", "type": "array", "items": { "type": "string", "description": "Error related to." } }, "description": { "type": [ "string", "null" ], "description": "Description of error.", "example": "Internal datastore is not available at the moment. No operation on this datastore is possible." } } }, { "title": "Internal server error", "type": "object", "properties": { "group": { "enum": [ "INTERNAL" ], "description": "Group of error.", "example": "INTERNAL" }, "type": { "enum": [ "ERROR" ], "description": "Type of error.", "example": "ERROR" }, "subtype": { "type": [ "string", "null" ], "description": "Subtype of error." }, "severity": { "enum": [ "CRITICAL" ], "description": "Severity of error. Info = cosmetic changes that don't change the overall meaning. Warning = typos and other errors that could affect the meaning. Critical = critical errors.", "example": "CRITICAL" }, "relatedTo": { "description": "List of the affected inputs.", "type": "array", "items": { "type": "string", "description": "Error related to." } }, "description": { "type": [ "string", "null" ], "description": "Description of error.", "example": "Failed to process your request. Please try again later or contact us." } } }, { "title": "API timeout error", "type": "object", "properties": { "group": { "enum": [ "INTERNAL" ], "description": "Group of error.", "example": "INTERNAL" }, "type": { "enum": [ "TIMEOUT" ], "description": "Type of error.", "example": "TIMEOUT" }, "subtype": { "type": [ "string", "null" ], "description": "Subtype of error." }, "severity": { "enum": [ "CRITICAL" ], "description": "Severity of error. Info = cosmetic changes that don't change the overall meaning. Warning = typos and other errors that could affect the meaning. Critical = critical errors.", "example": "CRITICAL" }, "relatedTo": { "description": "List of the affected inputs.", "type": "array", "items": { "type": "string", "description": "Error related to." } }, "description": { "type": [ "string", "null" ], "description": "Description of error.", "example": "API timeout in effect. Your request took too much time to process." } } }, { "title": "Project data not available error", "type": "object", "properties": { "group": { "enum": [ "INTERNAL" ], "description": "Group of error.", "example": "INTERNAL" }, "type": { "enum": [ "PROJECT" ], "description": "Type of error.", "example": "PROJECT" }, "subtype": { "enum": [ "NO_DATA" ], "description": "Subtype of error.", "example": "NO_DATA" }, "severity": { "enum": [ "CRITICAL" ], "description": "Severity of error. Info = cosmetic changes that don't change the overall meaning. Warning = typos and other errors that could affect the meaning. Critical = critical errors.", "example": "CRITICAL" }, "relatedTo": { "description": "List of the affected inputs.", "type": "array", "items": { "type": "string", "description": "Error related to." } }, "description": { "type": [ "string", "null" ], "description": "Description of error.", "example": "Failed to fetch project data needed for processing your request. Please contact us if the error persists." } } } ] } } } } ] } } } }, "503": { "description": "Service Unavailable.", "headers": { "foxentry-api-version": { "$ref": "#/paths/~1company~1get/post/responses/200/headers/foxentry-api-version" }, "foxentry-rate-limit": { "$ref": "#/paths/~1company~1get/post/responses/200/headers/foxentry-rate-limit" }, "foxentry-rate-limit-period": { "$ref": "#/paths/~1company~1get/post/responses/200/headers/foxentry-rate-limit-period" }, "foxentry-rate-limit-remaining": { "$ref": "#/paths/~1company~1get/post/responses/200/headers/foxentry-rate-limit-remaining" } }, "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "properties": { "status": { "type": "integer", "description": "Status of API response.", "example": 503 } } }, { "type": "object", "properties": { "request": { "$ref": "#/paths/~1company~1get/post/responses/200/content/application~1json/schema/properties/request/allOf/1" } } }, { "type": "object", "properties": { "errors": { "description": "List of errors related to the request. Should be empty if the request finished successfully.", "type": "array", "items": { "title": "Request endpoint not available error", "type": "object", "properties": { "group": { "enum": [ "INTERNAL" ], "description": "Group of error.", "example": "INTERNAL" }, "type": { "enum": [ "ENDPOINT" ], "description": "Type of error.", "example": "ENDPOINT" }, "subtype": { "enum": [ "NOT_AVAILABLE" ], "description": "Subtype of error.", "example": "NOT_AVAILABLE" }, "severity": { "enum": [ "critical" ], "description": "Severity of error. Info = cosmetic changes that don't change the overall meaning. Warning = typos and other errors that could affect the meaning. Critical = critical errors.", "example": "critical" }, "relatedTo": { "description": "List of the affected inputs.", "type": "array", "items": { "type": "string", "description": "Error related to." } }, "description": { "type": [ "string", "null" ], "description": "Description of error.", "example": "API endpoint is temporary unavailable. Please contact us at info@foxentry.com if the error persists." } } } } } } ] } } } } }, "security": [ { "BearerAuth": [] } ] } }, "/email/validate": { "post": { "tags": [ "Email" ], "summary": "Validate email", "description": "This endpoint will let you check if the e-mail address sent in query is valid.

Please pay attention to the validationType option since it has direct impact on the returned data. Extended validation (default) is the more advanced type that checks the real existence of the e-mail address and its deliverability. It also informs you about various flags such as freemail and disposable mail detection.

Foxentry validator is able not only to evaluate the validity of the entered 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.", "operationId": "EmailValidation", "parameters": [ { "$ref": "#/paths/~1company~1get/post/parameters/0" }, { "$ref": "#/paths/~1company~1get/post/parameters/1" } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "request": { "type": "object", "allOf": [ { "type": "object", "properties": { "customId": { "type": [ "string", "null" ], "description": "Custom ID assigned by you if you need so.", "example": "customer567914" }, "query": { "type": "object", "properties": { "email": { "type": "string", "example": "info@foxentry.com" } }, "required": [ "email" ] }, "options": { "type": "object", "description": "Query options.", "properties": { "validationType": { "enum": [ "basic", "extended" ], "description": "Type of validation. Basic = only the format of e-mail is checked and only standard corrections are included. Extended = in depth check of deliverability. Additional information is returned such as temporary mail check or freemail check. More complicated corrections are included.", "default": "extended", "example": "extended" }, "acceptDisposableEmails": { "type": "boolean", "description": "If true, the disposable e-mails will be marked as valid. Works only in Extended validation.", "default": true, "example": true }, "acceptFreemails": { "type": "boolean", "description": "If true, the freemails will be marked as valid. Works only in Extended validation.", "default": true, "example": true }, "acceptPhishingDomains": { "type": "boolean", "description": "If true, the e-mails from domains used for phishing will be marked as valid. Works only in Extended validation.", "default": true, "example": true }, "correctionMode": { "description": "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.", "type": "string", "enum": [ "full", "format", "suggestion", "none" ], "default": "full", "example": "full" } } }, "client": { "$ref": "#/paths/~1company~1get/post/requestBody/content/application~1json/schema/properties/request/allOf/0/properties/client" } } } ], "required": [ "query" ] } }, "required": [ "request" ] }, "examples": { "Request Example": { "value": { "request": { "query": { "email": "p.novak@gamil.com" }, "options": { "validationType": "extended", "acceptDisposableEmails": true, "acceptFreemails": true }, "client": { "country": "CZ", "location": { "lat": 50.0628, "lon": 13.9271 } } } } } } } } }, "responses": { "200": { "description": "Successful response", "headers": { "foxentry-api-version": { "$ref": "#/paths/~1company~1get/post/responses/200/headers/foxentry-api-version" }, "foxentry-daily-credits-left": { "$ref": "#/paths/~1company~1get/post/responses/200/headers/foxentry-daily-credits-left" }, "foxentry-daily-credits-limit": { "$ref": "#/paths/~1company~1get/post/responses/200/headers/foxentry-daily-credits-limit" }, "foxentry-rate-limit": { "$ref": "#/paths/~1company~1get/post/responses/200/headers/foxentry-rate-limit" }, "foxentry-rate-limit-period": { "$ref": "#/paths/~1company~1get/post/responses/200/headers/foxentry-rate-limit-period" }, "foxentry-rate-limit-remaining": { "$ref": "#/paths/~1company~1get/post/responses/200/headers/foxentry-rate-limit-remaining" } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status of API response.", "example": 200 }, "request": { "allOf": [ { "type": "object", "properties": { "endpoint": { "example": "email/validate" } } }, { "$ref": "#/paths/~1company~1get/post/responses/200/content/application~1json/schema/properties/request/allOf/1" }, { "$ref": "#/paths/~1email~1validate/post/requestBody/content/application~1json/schema/properties/request/allOf/0" } ] }, "response": { "type": "object", "properties": { "result": { "type": "object", "description": "Evaluation of the sent query.", "properties": { "isValid": { "type": "boolean", "description": "Determines the validity of the response. True = valid response / False = invalid response. Can be also null, which indicates a non-specific error.", "example": false }, "proposal": { "type": "string", "examples": [ "valid", "validWithSuggestion", "invalid", "invalidWithSuggestion", "invalidWithCorrection", "invalidWithCorrectionWithSuggestion", "invalidWithPartialCorrection", "invalidWithPartialCorrectionWithSuggestion", "unknown", "unknownWithSuggestion", "unknownWithCorrection", "unknownWithCorrectionWithSuggestion", "unknownWithPartialCorrection", "unknownWithPartialCorrectionWithSuggestion" ], "description": "Proposed solution by Foxentry how you should process the response in\nyour form or application.\n\nThe value is composed of three parts: the validity of `result`, the\nvalidity of `resultCorrected` (appending `WithCorrection` or\n`WithPartialCorrection`), and the presence of `suggestions`\n(appending `WithSuggestion`). It is always a string and is never null.\n\nComplete list of possible values:\n\n- `valid`\n- `validWithSuggestion`\n- `invalid`\n- `invalidWithSuggestion`\n- `invalidWithCorrection`\n- `invalidWithCorrectionWithSuggestion`\n- `invalidWithPartialCorrection`\n- `invalidWithPartialCorrectionWithSuggestion`\n- `unknown`\n- `unknownWithSuggestion`\n- `unknownWithCorrection`\n- `unknownWithCorrectionWithSuggestion`\n- `unknownWithPartialCorrection`\n- `unknownWithPartialCorrectionWithSuggestion`\n\nIn practice the `unknown*` variants occur mainly as `unknown`,\n`unknownWithCorrection` and `unknownWithSuggestion`." } }, "allOf": [ { "title": "Email validation result", "type": [ "object", "null" ], "properties": { "isValid": { "type": "boolean", "description": "Determines the validity of the response. True = valid response / False = invalid response. Can be also null, which indicates a non-specific error.", "example": true }, "data": { "type": "object", "properties": { "email": { "type": "string", "description": "Email address.", "example": "me@gmali.com" }, "user": { "type": "string", "description": "Customer user name.", "example": "me" }, "domain": { "type": [ "string", "null" ], "description": "Customer domain.", "example": "gmali.com" } } }, "flags": { "type": "object", "properties": { "isCatchAllServer": { "type": [ "boolean", "null" ], "description": "Determines if the domain is set as catchAll. That means no matter what is in front the '@' sign, every e-mail is deliverable", "example": false }, "isDisposableEmailAddress": { "type": [ "boolean", "null" ], "description": "Determines if the email address is disposable.", "example": false }, "isFreemail": { "type": [ "boolean", "null" ], "description": "Determines if the email address is hosted on freemail.", "example": false }, "isPhishingDomain": { "type": [ "boolean", "null" ], "description": "Determines if the email address is a domain used for phishing.", "example": false } } }, "errors": { "type": "array", "description": "List of errors related to the query. Provides information about which query fields were deemed invalid and why.", "items": { "anyOf": [ { "$ref": "#/paths/~1name~1validate/post/responses/200/content/application~1json/schema/properties/response/properties/result/allOf/0/properties/errors/items/anyOf/0" }, { "title": "Email specific syntax error", "type": "object", "properties": { "group": { "enum": [ "SYNTAX" ], "description": "Group of error.", "example": "SYNTAX" }, "type": { "enum": [ "INVALID", "VALUE_PART", "VALUE_PART_EXTRA", "VALUE_PART_MISSING", "VALUE_PART_POSITION" ], "description": "Type of error.", "example": "VALUE_PART_EXTRA" }, "subtype": { "enum": [ "DOMAIN", "AT_SIGN", "TLD", null ], "description": "Subtype of error.", "example": "DOMAIN" }, "severity": { "enum": [ "info", "warning", "critical", null ], "description": "Severity of error. Info = cosmetic changes that don't change the overall meaning. Warning = typos and other errors that could affect the meaning. Critical = critical errors.", "example": "critical" }, "relatedTo": { "description": "List of the affected inputs.", "type": "array", "items": { "type": "string", "description": "Error related to.", "example": "email" } }, "description": { "type": [ "string", "null" ], "description": "Description of error.", "example": "The domain contains invalid syntax." } } }, { "$ref": "#/paths/~1name~1validate/post/responses/200/content/application~1json/schema/properties/response/properties/result/allOf/0/properties/errors/items/anyOf/2" }, { "$ref": "#/paths/~1name~1validate/post/responses/200/content/application~1json/schema/properties/response/properties/result/allOf/0/properties/errors/items/anyOf/3" }, { "title": "Email specific value error", "type": "object", "properties": { "group": { "enum": [ "VALUE" ], "description": "Group of error.", "example": "VALUE" }, "type": { "enum": [ "INVALID", "NOT_ALLOWED" ], "description": "Type of error.", "example": "INVALID" }, "subtype": { "enum": [ "DOMAIN", "DOMAIN_DNS", "DISPOSABLE", "FREEMAIL", null ], "description": "Subtype of error.", "example": "DOMAIN" }, "severity": { "enum": [ "info", "warning", "critical" ], "description": "Severity of error. Info = cosmetic changes that don't change the overall meaning. Warning = typos and other errors that could affect the meaning. Critical = critical errors.", "example": "critical" }, "relatedTo": { "description": "List of the affected inputs.", "type": "array", "items": { "type": "string", "description": "Error related to.", "example": "email" } }, "description": { "type": [ "string", "null" ], "description": "Description of error.", "example": "Domain name is invalid." } } }, { "title": "Email specific temporary value error", "type": "object", "properties": { "group": { "enum": [ "VALUE" ], "description": "Group of error.", "example": "VALUE" }, "type": { "enum": [ "TEMPORARY_INVALID" ], "description": "Type of error.", "example": "TEMPORARY_INVALID" }, "subtype": { "enum": [ "OVER_QUOTA", null ], "description": "Subtype of error.", "example": "OVER_QUOTA" }, "severity": { "enum": [ "info", "warning", "critical" ], "description": "Severity of error. Info = cosmetic changes that don't change the overall meaning. Warning = typos and other errors that could affect the meaning. Critical = critical errors.", "example": "critical" }, "relatedTo": { "description": "List of the affected inputs.", "type": "array", "items": { "type": "string", "description": "Error related to.", "example": "email" } }, "description": { "type": [ "string", "null" ], "description": "Description of error.", "example": "Mailbox is full and cannot receive any e-mails at the moment." } } } ] } } }, "required": [ "isValid", "errors" ] } ] }, "resultCorrected": { "oneOf": [ { "$ref": "#/paths/~1email~1validate/post/responses/200/content/application~1json/schema/properties/response/properties/suggestions/items" }, { "type": "null", "title": "No data" } ] }, "suggestions": { "type": "array", "description": "Alternatives suggested for the sent query.", "items": { "type": "object", "allOf": [ { "$ref": "#/paths/~1email~1validate/post/responses/200/content/application~1json/schema/properties/response/properties/result/allOf/0" }, { "type": "object", "properties": { "fixes": { "type": "array", "description": "List of all changes applied to the query data in order to get the corrected result.", "items": { "anyOf": [ { "$ref": "#/paths/~1name~1validate/post/responses/200/content/application~1json/schema/properties/response/properties/suggestions/items/allOf/1/properties/fixes/items/anyOf/0" }, { "$ref": "#/paths/~1name~1validate/post/responses/200/content/application~1json/schema/properties/response/properties/suggestions/items/allOf/1/properties/fixes/items/anyOf/1" }, { "title": "Email specific syntax fix", "type": "object", "properties": { "group": { "enum": [ "SYNTAX" ], "description": "Group of fix.", "example": "SYNTAX" }, "type": { "enum": [ "VALUE_PART_ADDED", "VALUE_PART_CHANGED", "VALUE_PART_REMOVED" ], "description": "Type of fix.", "example": "VALUE_PART_ADDED" }, "subtype": { "enum": [ "AT_SIGN", "DOMAIN_TLD", "DOMAIN" ], "description": "Subtype of fix.", "example": "AT_SIGN" }, "data": { "$ref": "#/paths/~1name~1validate/post/responses/200/content/application~1json/schema/properties/response/properties/suggestions/items/allOf/1/properties/fixes/items/anyOf/0/properties/data" } } }, { "$ref": "#/paths/~1name~1validate/post/responses/200/content/application~1json/schema/properties/response/properties/suggestions/items/allOf/1/properties/fixes/items/anyOf/2" } ] } } } } ], "required": [ "isValid", "errors", "fixes" ] } } }, "required": [ "result" ] }, "errors": { "description": "List of errors related to the request. Should be empty if the request finished successfully.", "type": "array", "items": {}, "maxItems": 0 } }, "required": [ "errors", "status", "request", "response" ] }, "examples": { "valid": { "value": { "status": 200, "request": { "endpoint": "email/validate", "code": "eb609869-6e2c-488b-b1bd-e9bed9948d1d", "query": { "email": "info@foxentry.com" }, "options": { "validationType": "extended", "acceptDisposableEmails": true, "acceptFreemails": true, "acceptPhishingDomains": true, "correctionMode": "full" } }, "response": { "result": { "isValid": true, "proposal": "valid", "data": { "user": "info", "domain": "foxentry.com", "email": "info@foxentry.com" }, "flags": { "isCatchAllServer": false, "isDisposableEmailAddress": false, "isFreemail": false, "isPhishingDomain": false }, "errors": [] }, "resultCorrected": null, "suggestions": [] }, "errors": [] } }, "invalidWithSuggestion": { "value": { "status": 200, "request": { "endpoint": "email/validate", "code": "4897d079-9861-4b19-a5b9-e335924abbc6", "query": { "email": "info@gmali.com" }, "options": { "validationType": "extended", "acceptDisposableEmails": true, "acceptFreemails": true, "acceptPhishingDomains": true, "correctionMode": "suggestion" } }, "response": { "result": { "isValid": false, "proposal": "invalidWithSuggestion", "data": { "user": "info", "domain": "gmali.com", "email": "info@gmali.com" }, "flags": { "isCatchAllServer": false, "isDisposableEmailAddress": true, "isFreemail": true, "isPhishingDomain": false }, "errors": [ { "group": "VALUE", "type": "INVALID", "subtype": null, "severity": "critical", "relatedTo": [ "email" ], "description": "Value is not valid." } ] }, "resultCorrected": null, "suggestions": [ { "isValid": false, "data": { "user": "info", "domain": "gmail.com", "email": "info@gmail.com" }, "flags": { "isCatchAllServer": false, "isDisposableEmailAddress": false, "isFreemail": true, "isPhishingDomain": false }, "fixes": [ { "group": "VALUE", "type": "CHANGED", "subtype": null, "data": { "typeFrom": "email", "type": "email", "valueFrom": "info@gmali.com", "value": "info@gmail.com" } } ], "errors": [ { "group": "VALUE", "type": "INVALID", "subtype": null, "severity": "critical", "relatedTo": [ "email" ], "description": "Value is not valid." } ] } ] }, "errors": [] } }, "invalid": { "value": { "status": 200, "request": { "endpoint": "email/validate", "code": "a8021c47-d510-48a0-a30a-fb895b845235", "query": { "email": "invalid@example.com" }, "options": { "validationType": "extended", "acceptDisposableEmails": true, "acceptFreemails": true, "acceptPhishingDomains": true, "correctionMode": "full" } }, "response": { "result": { "isValid": false, "proposal": "invalid", "data": { "user": "invalid", "domain": "example.com", "email": "invalid@example.com" }, "flags": { "isCatchAllServer": false, "isDisposableEmailAddress": false, "isFreemail": false, "isPhishingDomain": false }, "errors": [ { "group": "VALUE", "type": "INVALID", "subtype": null, "severity": "critical", "relatedTo": [ "email" ], "description": "Value is not valid." } ] }, "resultCorrected": null, "suggestions": [] }, "errors": [] } }, "invalidWithCorrection": { "value": { "status": 200, "request": { "endpoint": "email/validate", "code": "3bef44ee-d813-4ad4-8ff1-efdd7c2062e5", "query": { "email": "info@foxentry,com" }, "options": { "validationType": "extended", "acceptDisposableEmails": true, "acceptFreemails": true, "acceptPhishingDomains": true, "correctionMode": "full" } }, "response": { "result": { "isValid": false, "proposal": "invalidWithCorrection", "data": { "user": "info", "domain": "foxentry,com", "email": "info@foxentry,com" }, "flags": { "isCatchAllServer": null, "isDisposableEmailAddress": null, "isFreemail": null, "isPhishingDomain": null }, "errors": [ { "group": "SYNTAX", "type": "INVALID", "subtype": null, "severity": "critical", "relatedTo": [ "email" ], "description": "Value has invalid syntax." } ] }, "resultCorrected": { "isValid": true, "data": { "user": "info", "domain": "foxentry.com", "email": "info@foxentry.com" }, "flags": { "isCatchAllServer": false, "isDisposableEmailAddress": false, "isFreemail": false, "isPhishingDomain": false }, "errors": [], "fixes": [ { "group": "SYNTAX", "type": "VALUE_PART_CHANGED", "subtype": "CHARACTERS", "data": { "typeFrom": "email", "type": "email", "valueFrom": "info@foxentry,com", "value": "info@foxentry.com" } } ] }, "suggestions": [] }, "errors": [] } }, "invalidWithPartialCorrection": { "value": { "status": 200, "request": { "endpoint": "email/validate", "code": "ff89e9b3-fd8f-463a-80ec-699aa7954a3f", "query": { "email": "infogmail.com" }, "options": { "validationType": "extended", "acceptDisposableEmails": true, "acceptFreemails": true, "acceptPhishingDomains": true, "correctionMode": "full" } }, "response": { "result": { "isValid": false, "proposal": "invalidWithPartialCorrection", "data": { "user": "infogmail.com", "domain": null, "email": "infogmail.com" }, "flags": { "isCatchAllServer": null, "isDisposableEmailAddress": null, "isFreemail": null, "isPhishingDomain": null }, "errors": [ { "group": "SYNTAX", "type": "VALUE_PART_MISSING", "subtype": "AT_SIGN", "severity": "critical", "relatedTo": [ "email" ], "description": "Value does not contain '@' sign." } ] }, "resultCorrected": { "isValid": false, "data": { "user": "info", "domain": "gmail.com", "email": "info@gmail.com" }, "flags": { "isCatchAllServer": false, "isDisposableEmailAddress": false, "isFreemail": true, "isPhishingDomain": false }, "errors": [ { "group": "VALUE", "type": "INVALID", "subtype": null, "severity": "critical", "relatedTo": [ "email" ], "description": "Value is not valid." } ], "fixes": [ { "group": "SYNTAX", "type": "VALUE_PART_ADDED", "subtype": "AT_SIGN", "data": { "typeFrom": "email", "type": "email", "valueFrom": "infogmail.com", "value": "info@gmail.com" } } ] }, "suggestions": [] }, "errors": [] } }, "disallowedDisposable": { "value": { "status": 200, "request": { "endpoint": "email/validate", "code": "62a7c777-1f84-4959-8c1e-2b70105b4837", "query": { "email": "rasini3451@naymedia.com" }, "options": { "validationType": "extended", "acceptDisposableEmails": false, "acceptFreemails": true, "acceptPhishingDomains": true, "correctionMode": "full" } }, "response": { "result": { "isValid": false, "proposal": "invalid", "data": { "user": "rasini3451", "domain": "naymedia.com", "email": "rasini3451@naymedia.com" }, "flags": { "isCatchAllServer": false, "isDisposableEmailAddress": true, "isFreemail": false, "isPhishingDomain": false }, "errors": [ { "group": "VALUE", "type": "NOT_ALLOWED", "subtype": "DISPOSABLE", "severity": "critical", "relatedTo": [ "email" ], "description": "Disposable emails are not allowed." } ] }, "resultCorrected": null, "suggestions": [] }, "errors": [] } }, "disallowedFreemails": { "value": { "status": 200, "request": { "endpoint": "email/validate", "code": "70591652-210c-49af-88ea-aaae5a9ad5db", "query": { "email": "info@gmail.com" }, "options": { "validationType": "extended", "acceptDisposableEmails": true, "acceptFreemails": false, "acceptPhishingDomains": true, "correctionMode": "full" } }, "response": { "result": { "isValid": false, "proposal": "invalid", "data": { "user": "info", "domain": "gmail.com", "email": "info@gmail.com" }, "flags": { "isCatchAllServer": false, "isDisposableEmailAddress": false, "isFreemail": true, "isPhishingDomain": false }, "errors": [ { "group": "VALUE", "type": "NOT_ALLOWED", "subtype": "FREEMAIL", "severity": "critical", "relatedTo": [ "email" ], "description": "Freemails are not allowed." } ] }, "resultCorrected": null, "suggestions": [] }, "errors": [] } } } } } }, "400": { "$ref": "#/paths/~1company~1get/post/responses/400" }, "401": { "$ref": "#/paths/~1company~1get/post/responses/401" }, "402": { "$ref": "#/paths/~1company~1get/post/responses/402" }, "403": { "$ref": "#/paths/~1company~1get/post/responses/403" }, "404": { "$ref": "#/paths/~1company~1get/post/responses/404" }, "405": { "$ref": "#/paths/~1company~1get/post/responses/405" }, "429": { "$ref": "#/paths/~1company~1get/post/responses/429" }, "500": { "$ref": "#/paths/~1company~1get/post/responses/500" }, "503": { "$ref": "#/paths/~1company~1get/post/responses/503" } }, "security": [ { "BearerAuth": [] } ] } }, "/email/search": { "post": { "tags": [ "Email" ], "summary": "Search email", "description": "Foxentry will automatically offer you suggestions to complete the e-mail address you are writing down. This mainly serves as autocomplete.

Pay attention to the client section in the request body. You can specify the user's location in order to receive more relevant suggestions.", "operationId": "EmailSearch", "parameters": [ { "$ref": "#/paths/~1company~1get/post/parameters/0" }, { "$ref": "#/paths/~1company~1get/post/parameters/1" } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "request": { "type": "object", "allOf": [ { "type": "object", "properties": { "customId": { "type": [ "string", "null" ], "description": "Custom ID assigned by you if you need so.", "example": "customer567914" }, "query": { "type": "object", "properties": { "value": { "type": "string", "example": "info@foxentry.com" } }, "required": [ "value" ] }, "options": { "type": "object", "description": "Query options.", "properties": { "resultsLimit": { "type": "number", "description": "Limits number of results returned by the endpoint.", "minimum": 1, "maximum": 5, "example": 5 } } }, "client": { "$ref": "#/paths/~1company~1get/post/requestBody/content/application~1json/schema/properties/request/allOf/0/properties/client" } } } ], "required": [ "query" ] } }, "required": [ "request" ] }, "examples": { "Request Example": { "value": { "request": { "query": { "value": "p.novak@" }, "options": { "resultsLimit": 5 }, "client": { "country": "CZ", "location": { "lat": 50.0628, "lon": 13.9271 } } } } } } } } }, "responses": { "200": { "description": "Successful response", "headers": { "foxentry-api-version": { "$ref": "#/paths/~1company~1get/post/responses/200/headers/foxentry-api-version" }, "foxentry-daily-credits-left": { "$ref": "#/paths/~1company~1get/post/responses/200/headers/foxentry-daily-credits-left" }, "foxentry-daily-credits-limit": { "$ref": "#/paths/~1company~1get/post/responses/200/headers/foxentry-daily-credits-limit" }, "foxentry-rate-limit": { "$ref": "#/paths/~1company~1get/post/responses/200/headers/foxentry-rate-limit" }, "foxentry-rate-limit-period": { "$ref": "#/paths/~1company~1get/post/responses/200/headers/foxentry-rate-limit-period" }, "foxentry-rate-limit-remaining": { "$ref": "#/paths/~1company~1get/post/responses/200/headers/foxentry-rate-limit-remaining" } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status of API response.", "example": 200 }, "request": { "allOf": [ { "type": "object", "properties": { "endpoint": { "example": "email/search" } } }, { "$ref": "#/paths/~1company~1get/post/responses/200/content/application~1json/schema/properties/request/allOf/1" }, { "$ref": "#/paths/~1email~1search/post/requestBody/content/application~1json/schema/properties/request/allOf/0" } ] }, "response": { "type": "object", "properties": { "resultsCount": { "type": "number", "description": "Number of results", "minimum": 1, "maximum": 5, "example": 1 }, "results": { "type": "array", "items": { "type": "object", "properties": { "data": { "type": "object", "properties": { "email": { "type": "string", "description": "Suggested e-mail", "example": "info@gmail.com" }, "user": { "type": "string", "description": "Suggested user", "example": "info" }, "domain": { "type": "string", "description": "Suggested domain", "example": "gmail.com" } }, "required": [ "email", "domain" ] } }, "required": [ "data" ] } } }, "required": [ "resultsCount", "results" ] }, "errors": { "description": "List of errors related to the request. Should be empty if the request finished successfully.", "type": "array", "items": {}, "maxItems": 0 } }, "required": [ "status", "request" ] }, "examples": { "searchResults": { "value": { "status": 200, "request": { "endpoint": "email/search", "code": "61903486-39f4-48ab-8d2d-a7a0381bca7c", "query": { "value": "info" }, "options": { "resultsLimit": 5 } }, "response": { "resultsCount": 5, "results": [ { "data": { "email": "info@seznam.cz", "domain": "seznam.cz" } }, { "data": { "email": "info@gmail.com", "domain": "gmail.com" } }, { "data": { "email": "info@email.cz", "domain": "email.cz" } }, { "data": { "email": "info@centrum.cz", "domain": "centrum.cz" } }, { "data": { "email": "info@post.cz", "domain": "post.cz" } } ] }, "errors": [] } } } } } }, "400": { "$ref": "#/paths/~1company~1get/post/responses/400" }, "401": { "$ref": "#/paths/~1company~1get/post/responses/401" }, "402": { "$ref": "#/paths/~1company~1get/post/responses/402" }, "403": { "$ref": "#/paths/~1company~1get/post/responses/403" }, "404": { "$ref": "#/paths/~1company~1get/post/responses/404" }, "405": { "$ref": "#/paths/~1company~1get/post/responses/405" }, "429": { "$ref": "#/paths/~1company~1get/post/responses/429" }, "500": { "$ref": "#/paths/~1company~1get/post/responses/500" }, "503": { "$ref": "#/paths/~1company~1get/post/responses/503" } }, "security": [ { "BearerAuth": [] } ] } }, "/location/validate": { "post": { "tags": [ "Location" ], "summary": "Validate location data", "description": "This endpoint requires at least 1 query parameter and will check if the parameters and their combinations are valid. Returns information about the location based on the datascope set in the options.

Foxentry validator is able not only to evaluate the validity of the entered 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.", "operationId": "LocationValidation", "parameters": [ { "$ref": "#/paths/~1company~1get/post/parameters/0" }, { "$ref": "#/paths/~1company~1get/post/parameters/1" } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "request": { "type": "object", "allOf": [ { "type": "object", "properties": { "customId": { "type": [ "string", "null" ], "description": "Custom ID assigned by you if you need so.", "example": "customer567914" }, "query": { "type": "object", "properties": { "street": { "type": [ "string", "null" ], "description": "Street.", "example": "Jeseniova" }, "streetWithNumber": { "type": [ "string", "null" ], "description": "Street with number.", "example": "Jeseniova 55" }, "number.full": { "type": [ "string", "null" ], "description": "Full house number.", "example": "1151/55d" }, "number.part1": { "type": [ "string", "null" ], "description": "First section of house number.", "example": "1151" }, "number.part1Number": { "type": [ "string", "null" ], "description": "Numerical part of the first section.", "example": "1151" }, "number.part1Letter": { "type": [ "string", "null" ], "description": "Textual part of the first section.", "example": null }, "number.part2": { "type": [ "string", "null" ], "description": "Second section of house number.", "example": "55d" }, "number.part2Number": { "type": [ "string", "null" ], "description": "Numerical part of the second section.", "example": "55" }, "number.part2Letter": { "type": [ "string", "null" ], "description": "Textual part of the second section.", "example": "d" }, "city": { "type": [ "string", "null" ], "description": "City.", "example": "Praha" }, "zip": { "type": [ "string", "null" ], "description": "ZIP code.", "example": "130 00" }, "full": { "type": [ "string", "null" ], "description": "Full address.", "example": "Jeseniova 2770/56d, 130 00 Praha" }, "country": { "type": [ "string", "null" ], "description": "Country code. Supported formats: alpha2 = CZ, alpha3 = CZE, local = Česká republika, international = Czech Republic, localShortened = Česko, internationalShortened = Czechia.", "example": "CZ" } } }, "options": { "allOf": [ { "allOf": [ { "$ref": "#/paths/~1location~1get/post/requestBody/content/application~1json/schema/properties/request/allOf/0/properties/options/allOf/0" }, { "type": "object", "description": "Query options.", "properties": { "resultsLimit": { "description": "Limits number of suggestions returned by the endpoint.", "type": "integer", "minimum": 1, "maximum": 20, "default": 10, "example": 10 }, "acceptPostOfficeAsCity": { "type": "boolean", "description": "If true, the postOffice name is accepted as city. For example Thámova 137/16, Praha 8 and Thámova 137/16, Praha 86 would be both valid.", "default": false, "example": true }, "correctionMode": { "description": "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.", "type": "string", "enum": [ "full", "format", "suggestion", "none" ], "default": "full", "example": "full" }, "correctionModeCrossCountry": { "description": "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.", "type": "string", "enum": [ "full", "format", "suggestion", "none" ], "default": "format", "example": "format" } } } ] } ] }, "client": { "$ref": "#/paths/~1company~1get/post/requestBody/content/application~1json/schema/properties/request/allOf/0/properties/client" } } } ], "required": [ "query" ] } }, "required": [ "request" ] }, "examples": { "Request Example": { "value": { "request": { "query": { "streetWithNumber": "Jeseniova 55", "city": "Praha", "zip": "13000", "country": "CZ" }, "options": { "dataScope": "full", "resultsLimit": 10, "acceptPostOfficeAsCity": true }, "client": { "country": "CZ", "location": { "lat": 50.0628, "lon": 13.9271 } } } } } } } } }, "responses": { "200": { "description": "Successful response", "headers": { "foxentry-api-version": { "$ref": "#/paths/~1company~1get/post/responses/200/headers/foxentry-api-version" }, "foxentry-daily-credits-left": { "$ref": "#/paths/~1company~1get/post/responses/200/headers/foxentry-daily-credits-left" }, "foxentry-daily-credits-limit": { "$ref": "#/paths/~1company~1get/post/responses/200/headers/foxentry-daily-credits-limit" }, "foxentry-rate-limit": { "$ref": "#/paths/~1company~1get/post/responses/200/headers/foxentry-rate-limit" }, "foxentry-rate-limit-period": { "$ref": "#/paths/~1company~1get/post/responses/200/headers/foxentry-rate-limit-period" }, "foxentry-rate-limit-remaining": { "$ref": "#/paths/~1company~1get/post/responses/200/headers/foxentry-rate-limit-remaining" } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status of API response.", "example": 200 }, "request": { "allOf": [ { "type": "object", "properties": { "endpoint": { "example": "location/validate" } } }, { "$ref": "#/paths/~1company~1get/post/responses/200/content/application~1json/schema/properties/request/allOf/1" }, { "$ref": "#/paths/~1location~1validate/post/requestBody/content/application~1json/schema/properties/request/allOf/0" } ] }, "response": { "type": "object", "properties": { "result": { "type": "object", "description": "Evaluation of the sent query.", "properties": { "isValid": { "type": "boolean", "description": "Determines the validity of the response. True = valid response / False = invalid response. Can be also null, which indicates a non-specific error.", "example": false }, "proposal": { "type": "string", "examples": [ "valid", "validWithSuggestion", "invalid", "invalidWithSuggestion", "invalidWithCorrection", "invalidWithCorrectionWithSuggestion", "invalidWithPartialCorrection", "invalidWithPartialCorrectionWithSuggestion" ], "description": "Proposed solution by Foxentry how you should process the response in\nyour form or application.\n\nThe value is composed of three parts: the validity of `result`, the\nvalidity of `resultCorrected` (appending `WithCorrection` or\n`WithPartialCorrection`), and the presence of `suggestions`\n(appending `WithSuggestion`). It is always a string and is never null.\n\nComplete list of possible values:\n\n- `valid`\n- `validWithSuggestion`\n- `invalid`\n- `invalidWithSuggestion`\n- `invalidWithCorrection`\n- `invalidWithCorrectionWithSuggestion`\n- `invalidWithPartialCorrection`\n- `invalidWithPartialCorrectionWithSuggestion`" } }, "allOf": [ { "title": "Location validation result", "type": "object", "allOf": [ { "$ref": "#/paths/~1location~1get/post/responses/200/content/application~1json/schema/properties/response/properties/results/items" } ], "properties": { "dataTypes": { "description": "List of data types that were validated. Provides information about which types were valid and which were invalid.", "type": "object", "properties": { "valid": { "type": "array", "items": { "type": "string", "example": "city" } }, "invalid": { "type": "array", "items": { "type": "string", "example": "street" } } } }, "errors": { "type": "array", "description": "List of errors related to the query. Provides information about which query fields were deemed invalid and why.", "items": { "anyOf": [ { "$ref": "#/paths/~1name~1validate/post/responses/200/content/application~1json/schema/properties/response/properties/result/allOf/0/properties/errors/items/anyOf/0" }, { "title": "Location specific syntax error", "type": "object", "properties": { "group": { "enum": [ "SYNTAX" ], "description": "Group of error.", "example": "SYNTAX" }, "type": { "enum": [ "VALUE_PART_MISSING" ], "description": "Type of error.", "example": "VALUE_PART_MISSING" }, "subtype": { "enum": [ "CITY", "NUMBER", "NUMBER_PART", "STREET", "ZIP" ], "description": "Subtype of error.", "example": "CITY" }, "severity": { "enum": [ "info", "warning", "critical" ], "description": "Severity of error. Info = cosmetic changes that don't change the overall meaning. Warning = typos and other errors that could affect the meaning. Critical = critical errors.", "example": "critical" }, "relatedTo": { "description": "List of the affected inputs.", "type": "array", "items": { "type": "string", "description": "Error related to.", "example": "streetWithNumber" } }, "description": { "type": [ "string", "null" ], "description": "Description of error.", "example": "Value is missing the city." } } }, { "$ref": "#/paths/~1name~1validate/post/responses/200/content/application~1json/schema/properties/response/properties/result/allOf/0/properties/errors/items/anyOf/2" }, { "$ref": "#/paths/~1name~1validate/post/responses/200/content/application~1json/schema/properties/response/properties/result/allOf/0/properties/errors/items/anyOf/3" } ] } } }, "required": [ "errors" ] } ], "required": [ "isValid", "proposal", "data" ] }, "resultCorrected": { "oneOf": [ { "$ref": "#/paths/~1location~1validate/post/responses/200/content/application~1json/schema/properties/response/properties/suggestions/items" }, { "type": "null", "title": "No data" } ] }, "suggestions": { "type": "array", "description": "Alternatives suggested for the sent query.", "items": { "type": "object", "allOf": [ { "$ref": "#/paths/~1location~1validate/post/responses/200/content/application~1json/schema/properties/response/properties/result/allOf/0" }, { "type": "object", "properties": { "fixes": { "type": "array", "description": "List of all changes applied to the query data in order to get the corrected result.", "items": { "anyOf": [ { "$ref": "#/paths/~1name~1validate/post/responses/200/content/application~1json/schema/properties/response/properties/suggestions/items/allOf/1/properties/fixes/items/anyOf/0" }, { "$ref": "#/paths/~1name~1validate/post/responses/200/content/application~1json/schema/properties/response/properties/suggestions/items/allOf/1/properties/fixes/items/anyOf/1" }, { "title": "Location specific syntax fix", "type": "object", "properties": { "group": { "enum": [ "SYNTAX" ], "description": "Group of fix.", "example": "SYNTAX" }, "type": { "enum": [ "VALUE_PART_ADDED" ], "description": "Type of fix.", "example": "VALUE_PART_ADDED" }, "subtype": { "enum": [ "NUMBER", "NUMBER_PART" ], "description": "Subtype of fix.", "example": "NUMBER" }, "data": { "$ref": "#/paths/~1name~1validate/post/responses/200/content/application~1json/schema/properties/response/properties/suggestions/items/allOf/1/properties/fixes/items/anyOf/0/properties/data" } } }, { "$ref": "#/paths/~1name~1validate/post/responses/200/content/application~1json/schema/properties/response/properties/suggestions/items/allOf/1/properties/fixes/items/anyOf/2" }, { "title": "Location specific value fix", "type": "object", "properties": { "group": { "enum": [ "VALUE" ], "description": "Group of fix.", "example": "VALUE" }, "type": { "enum": [ "PART_CHANGED" ], "description": "Type of fix.", "example": "PART_CHANGED" }, "subtype": { "enum": [ "CITY", "NUMBER", "STREET", "ZIP" ], "description": "Subtype of error.", "example": "CITY" }, "data": { "$ref": "#/paths/~1name~1validate/post/responses/200/content/application~1json/schema/properties/response/properties/suggestions/items/allOf/1/properties/fixes/items/anyOf/0/properties/data" } } } ] } } } } ] } } }, "required": [ "result" ] }, "errors": { "description": "List of errors related to the request. Should be empty if the request finished successfully.", "type": "array", "items": {}, "maxItems": 0 } }, "required": [ "status", "errors", "request", "response" ] }, "examples": { "valid": { "value": { "status": 200, "request": { "endpoint": "location/validate", "code": "a738d661-ea52-4345-9354-e6a8748b3466", "query": { "streetWithNumber": "Thámova 137/16", "city": "Praha 8", "zip": "18600", "country": "CZ" }, "options": { "dataSource": [ "CZ", "SK", "PL" ], "dataScope": "basic", "resultsLimit": 10, "cityFormat": "basic", "countryFormat": "alpha2", "zipFormat": false, "acceptPostOfficeAsCity": false, "correctionMode": "full", "correctionModeCrossCountry": "format" } }, "response": { "result": { "isValid": true, "proposal": "valid", "dataTypes": { "valid": [ "city", "country", "number.full", "street", "streetWithNumber", "zip" ], "invalid": [] }, "data": { "country": "CZ", "state": null, "region": "Hlavní město Praha", "district": "území Hlavního města Prahy", "ids": { "internal": "d2ade877-1e95-4a83-baa6-5431ce5b3ca8", "external": "22349995" }, "street": "Thámova", "number": { "type": "č.p.", "part1": "137", "part1Number": "137", "part1Letter": null, "part2": "16", "part2Number": "16", "part2Letter": null, "full": "137/16" }, "streetWithNumber": "Thámova 137/16", "city": "Praha 8", "zip": "18600", "full": "Thámova 137/16, 18600 Praha 8" }, "errors": [] }, "resultCorrected": null, "suggestions": [] }, "errors": [] } }, "invalid": { "value": { "status": 200, "request": { "endpoint": "location/validate", "code": "6c31c353-56aa-4f7e-b097-8a9368febe18", "query": { "streetWithNumber": "Thámova 123456789", "city": "Parharlin", "zip": "457545754" }, "options": { "dataSource": [ "CZ", "SK", "PL" ], "dataScope": "basic", "resultsLimit": 10, "cityFormat": "basic", "countryFormat": "alpha2", "zipFormat": false, "acceptPostOfficeAsCity": false, "correctionMode": "full", "correctionModeCrossCountry": "format" } }, "response": { "result": { "isValid": false, "proposal": "invalid", "dataTypes": { "valid": [ "number.full", "street" ], "invalid": [ "city", "streetWithNumber", "zip" ] }, "data": { "country": null, "state": null, "region": null, "district": null, "ids": { "internal": null, "external": null }, "street": null, "number": { "type": null, "part1": null, "part1Number": null, "part1Letter": null, "part2": null, "part2Number": null, "part2Letter": null, "full": null }, "streetWithNumber": "Thámova 123456789", "city": "Parharlin", "zip": "457545754", "full": "Thámova 123456789, 457545754 Parharlin" }, "errors": [ { "group": "VALUE", "type": "INVALID", "subtype": null, "severity": "critical", "relatedTo": [ "streetWithNumber", "city", "zip" ], "description": "Value is not valid." } ] }, "resultCorrected": null, "suggestions": [] }, "errors": [] } }, "invalidWithCorrection": { "value": { "status": 200, "request": { "endpoint": "location/validate", "code": "4c7693c8-1ff7-48bc-a339-99758f95f3c5", "query": { "streetWithNumber": "Thámova 137", "city": "Praha", "zip": "18600" }, "options": { "dataSource": [ "CZ", "SK", "PL" ], "dataScope": "basic", "resultsLimit": 10, "cityFormat": "basic", "countryFormat": "alpha2", "zipFormat": false, "acceptPostOfficeAsCity": false, "correctionMode": "full", "correctionModeCrossCountry": "format" } }, "response": { "result": { "isValid": false, "proposal": "invalidWithCorrection", "dataTypes": { "valid": [ "street", "zip" ], "invalid": [ "city", "number.full", "streetWithNumber" ] }, "data": { "country": null, "state": null, "region": null, "district": null, "ids": { "internal": null, "external": null }, "street": null, "number": { "type": null, "part1": null, "part1Number": null, "part1Letter": null, "part2": null, "part2Number": null, "part2Letter": null, "full": null }, "streetWithNumber": "Thámova 137", "city": "Praha", "zip": "18600", "full": "Thámova 137, 18600 Praha" }, "errors": [ { "group": "SYNTAX", "type": "VALUE_PART_MISSING", "subtype": "NUMBER_PART", "severity": "critical", "relatedTo": [ "streetWithNumber" ], "description": "Value is missing some part of the number." }, { "group": "FORMAT", "type": "INVALID", "subtype": null, "severity": "warning", "relatedTo": [ "city" ], "description": null } ] }, "resultCorrected": { "isValid": true, "dataTypes": { "valid": [ "city", "number.full", "street", "streetWithNumber", "zip" ], "invalid": [] }, "data": { "country": "CZ", "state": null, "region": "Hlavní město Praha", "district": "území Hlavního města Prahy", "ids": { "internal": "d2ade877-1e95-4a83-baa6-5431ce5b3ca8", "external": "22349995" }, "street": "Thámova", "number": { "type": "č.p.", "part1": "137", "part1Number": "137", "part1Letter": null, "part2": "16", "part2Number": "16", "part2Letter": null, "full": "137/16" }, "streetWithNumber": "Thámova 137/16", "city": "Praha 8", "zip": "18600", "full": "Thámova 137/16, 18600 Praha 8" }, "errors": [], "fixes": [ { "group": "SYNTAX", "type": "VALUE_PART_ADDED", "subtype": "NUMBER_PART", "data": { "typeFrom": "streetWithNumber", "type": "streetWithNumber", "valueFrom": "Thámova 137", "value": "Thámova 137/16" } }, { "group": "FORMAT", "type": "CHANGED", "subtype": null, "data": { "typeFrom": "city", "type": "city", "valueFrom": "Praha", "value": "Praha 8" } } ] }, "suggestions": [] }, "errors": [] } }, "invalidWithSuggestion": { "value": { "status": 200, "request": { "endpoint": "location/validate", "code": "62adb6c2-5d11-424e-900a-d50fec612218", "query": { "streetWithNumber": "Olšanská 2898/4", "city": "Praha 3", "zip": "13000" }, "options": { "dataSource": [ "CZ", "SK", "PL" ], "dataScope": "basic", "resultsLimit": 10, "cityFormat": "basic", "countryFormat": "alpha2", "zipFormat": false, "acceptPostOfficeAsCity": false, "correctionMode": "full", "correctionModeCrossCountry": "format" } }, "response": { "result": { "isValid": false, "proposal": "invalidWithSuggestion", "dataTypes": { "valid": [ "city", "number.full", "street", "zip" ], "invalid": [ "number", "streetWithNumber" ] }, "data": { "country": null, "state": null, "region": null, "district": null, "ids": { "internal": null, "external": null }, "street": null, "number": { "type": null, "part1": null, "part1Number": null, "part1Letter": null, "part2": null, "part2Number": null, "part2Letter": null, "full": null }, "streetWithNumber": "Olšanská 2898/4", "city": "Praha 3", "zip": "13000", "full": "Olšanská 2898/4, 13000 Praha 3" }, "errors": [ { "group": "VALUE", "type": "INVALID", "subtype": null, "severity": "critical", "relatedTo": [ "streetWithNumber" ], "description": "Value is not valid." } ] }, "resultCorrected": null, "suggestions": [ { "isValid": true, "dataTypes": { "valid": [ "city", "number.full", "street", "streetWithNumber", "zip" ], "invalid": [] }, "data": { "country": "CZ", "state": null, "region": "Hlavní město Praha", "district": "území Hlavního města Prahy", "ids": { "internal": "8a978ce4-d769-456e-abdd-7b6174848237", "external": "75429195" }, "street": "Olšanská", "number": { "type": "č.p.", "part1": "2898", "part1Number": "2898", "part1Letter": null, "part2": "4d", "part2Number": "4", "part2Letter": "d", "full": "2898/4d" }, "streetWithNumber": "Olšanská 2898/4d", "city": "Praha 3", "zip": "13000", "full": "Olšanská 2898/4d, 13000 Praha 3" }, "errors": [], "fixes": [ { "group": "VALUE", "type": "CHANGED", "subtype": "TYPO", "data": { "typeFrom": "streetWithNumber", "type": "streetWithNumber", "valueFrom": "Olšanská 2898/4", "value": "Olšanská 2898/4d" } } ] }, { "isValid": true, "dataTypes": { "valid": [ "city", "number.full", "street", "streetWithNumber", "zip" ], "invalid": [] }, "data": { "country": "CZ", "state": null, "region": "Hlavní město Praha", "district": "území Hlavního města Prahy", "ids": { "internal": "f07afd40-b8be-45e5-89ae-828ce059f719", "external": "75429446" }, "street": "Olšanská", "number": { "type": "č.p.", "part1": "2898", "part1Number": "2898", "part1Letter": null, "part2": "4f", "part2Number": "4", "part2Letter": "f", "full": "2898/4f" }, "streetWithNumber": "Olšanská 2898/4f", "city": "Praha 3", "zip": "13000", "full": "Olšanská 2898/4f, 13000 Praha 3" }, "errors": [], "fixes": [ { "group": "VALUE", "type": "CHANGED", "subtype": "TYPO", "data": { "typeFrom": "streetWithNumber", "type": "streetWithNumber", "valueFrom": "Olšanská 2898/4", "value": "Olšanská 2898/4f" } } ] }, { "isValid": true, "dataTypes": { "valid": [ "city", "number.full", "street", "streetWithNumber", "zip" ], "invalid": [] }, "data": { "country": "CZ", "state": null, "region": "Hlavní město Praha", "district": "území Hlavního města Prahy", "ids": { "internal": "33bb5444-73c5-474e-8ce7-2f157b947230", "external": "75429411" }, "street": "Olšanská", "number": { "type": "č.p.", "part1": "2898", "part1Number": "2898", "part1Letter": null, "part2": "4e", "part2Number": "4", "part2Letter": "e", "full": "2898/4e" }, "streetWithNumber": "Olšanská 2898/4e", "city": "Praha 3", "zip": "13000", "full": "Olšanská 2898/4e, 13000 Praha 3" }, "errors": [], "fixes": [ { "group": "VALUE", "type": "CHANGED", "subtype": "TYPO", "data": { "typeFrom": "streetWithNumber", "type": "streetWithNumber", "valueFrom": "Olšanská 2898/4", "value": "Olšanská 2898/4e" } } ] }, { "isValid": true, "dataTypes": { "valid": [ "city", "number.full", "street", "streetWithNumber", "zip" ], "invalid": [] }, "data": { "country": "CZ", "state": null, "region": "Hlavní město Praha", "district": "území Hlavního města Prahy", "ids": { "internal": "37b9bfcc-733b-49e0-ae68-c32d2634732e", "external": "75429152" }, "street": "Olšanská", "number": { "type": "č.p.", "part1": "2898", "part1Number": "2898", "part1Letter": null, "part2": "4c", "part2Number": "4", "part2Letter": "c", "full": "2898/4c" }, "streetWithNumber": "Olšanská 2898/4c", "city": "Praha 3", "zip": "13000", "full": "Olšanská 2898/4c, 13000 Praha 3" }, "errors": [], "fixes": [ { "group": "VALUE", "type": "CHANGED", "subtype": "TYPO", "data": { "typeFrom": "streetWithNumber", "type": "streetWithNumber", "valueFrom": "Olšanská 2898/4", "value": "Olšanská 2898/4c" } } ] }, { "isValid": true, "dataTypes": { "valid": [ "city", "number.full", "street", "streetWithNumber", "zip" ], "invalid": [] }, "data": { "country": "CZ", "state": null, "region": "Hlavní město Praha", "district": "území Hlavního města Prahy", "ids": { "internal": "0794e4b1-2ac8-498a-b02f-23b1e59b7178", "external": "75429527" }, "street": "Olšanská", "number": { "type": "č.p.", "part1": "2898", "part1Number": "2898", "part1Letter": null, "part2": "4h", "part2Number": "4", "part2Letter": "h", "full": "2898/4h" }, "streetWithNumber": "Olšanská 2898/4h", "city": "Praha 3", "zip": "13000", "full": "Olšanská 2898/4h, 13000 Praha 3" }, "errors": [], "fixes": [ { "group": "VALUE", "type": "CHANGED", "subtype": "TYPO", "data": { "typeFrom": "streetWithNumber", "type": "streetWithNumber", "valueFrom": "Olšanská 2898/4", "value": "Olšanská 2898/4h" } } ] }, { "isValid": true, "dataTypes": { "valid": [ "city", "number.full", "street", "streetWithNumber", "zip" ], "invalid": [] }, "data": { "country": "CZ", "state": null, "region": "Hlavní město Praha", "district": "území Hlavního města Prahy", "ids": { "internal": "9266190a-76da-45e5-86b4-d168d631ddf8", "external": "75429462" }, "street": "Olšanská", "number": { "type": "č.p.", "part1": "2898", "part1Number": "2898", "part1Letter": null, "part2": "4g", "part2Number": "4", "part2Letter": "g", "full": "2898/4g" }, "streetWithNumber": "Olšanská 2898/4g", "city": "Praha 3", "zip": "13000", "full": "Olšanská 2898/4g, 13000 Praha 3" }, "errors": [], "fixes": [ { "group": "VALUE", "type": "CHANGED", "subtype": "TYPO", "data": { "typeFrom": "streetWithNumber", "type": "streetWithNumber", "valueFrom": "Olšanská 2898/4", "value": "Olšanská 2898/4g" } } ] }, { "isValid": true, "dataTypes": { "valid": [ "city", "number.full", "street", "streetWithNumber", "zip" ], "invalid": [] }, "data": { "country": "CZ", "state": null, "region": "Hlavní město Praha", "district": "území Hlavního města Prahy", "ids": { "internal": "2b57d49a-4e21-4c09-aba4-211fbc49ba93", "external": "75428920" }, "street": "Olšanská", "number": { "type": "č.p.", "part1": "2898", "part1Number": "2898", "part1Letter": null, "part2": "4a", "part2Number": "4", "part2Letter": "a", "full": "2898/4a" }, "streetWithNumber": "Olšanská 2898/4a", "city": "Praha 3", "zip": "13000", "full": "Olšanská 2898/4a, 13000 Praha 3" }, "errors": [], "fixes": [ { "group": "VALUE", "type": "CHANGED", "subtype": "TYPO", "data": { "typeFrom": "streetWithNumber", "type": "streetWithNumber", "valueFrom": "Olšanská 2898/4", "value": "Olšanská 2898/4a" } } ] }, { "isValid": true, "dataTypes": { "valid": [ "city", "number.full", "street", "streetWithNumber", "zip" ], "invalid": [] }, "data": { "country": "CZ", "state": null, "region": "Hlavní město Praha", "district": "území Hlavního města Prahy", "ids": { "internal": "a3c8146d-ff67-4e97-80bc-40cacdd06a4d", "external": "75429551" }, "street": "Olšanská", "number": { "type": "č.p.", "part1": "2898", "part1Number": "2898", "part1Letter": null, "part2": "4i", "part2Number": "4", "part2Letter": "i", "full": "2898/4i" }, "streetWithNumber": "Olšanská 2898/4i", "city": "Praha 3", "zip": "13000", "full": "Olšanská 2898/4i, 13000 Praha 3" }, "errors": [], "fixes": [ { "group": "VALUE", "type": "CHANGED", "subtype": "TYPO", "data": { "typeFrom": "streetWithNumber", "type": "streetWithNumber", "valueFrom": "Olšanská 2898/4", "value": "Olšanská 2898/4i" } } ] }, { "isValid": true, "dataTypes": { "valid": [ "city", "number.full", "street", "streetWithNumber", "zip" ], "invalid": [] }, "data": { "country": "CZ", "state": null, "region": "Hlavní město Praha", "district": "území Hlavního města Prahy", "ids": { "internal": "d56e5b6b-6742-4978-ba01-aaa0929910a0", "external": "75429098" }, "street": "Olšanská", "number": { "type": "č.p.", "part1": "2898", "part1Number": "2898", "part1Letter": null, "part2": "4b", "part2Number": "4", "part2Letter": "b", "full": "2898/4b" }, "streetWithNumber": "Olšanská 2898/4b", "city": "Praha 3", "zip": "13000", "full": "Olšanská 2898/4b, 13000 Praha 3" }, "errors": [], "fixes": [ { "group": "VALUE", "type": "CHANGED", "subtype": "TYPO", "data": { "typeFrom": "streetWithNumber", "type": "streetWithNumber", "valueFrom": "Olšanská 2898/4", "value": "Olšanská 2898/4b" } } ] } ] }, "errors": [] } }, "countryInternationalFormat": { "value": { "status": 200, "request": { "endpoint": "location/validate", "code": "1acc9a52-68b4-4b71-9098-597e7eaf5174", "query": { "streetWithNumber": "Thámova 137/16", "city": "Praha 8", "zip": "18600", "country": "Czech Republic" }, "options": { "dataSource": [ "CZ", "SK", "PL" ], "dataScope": "basic", "resultsLimit": 10, "cityFormat": "basic", "countryFormat": "international", "zipFormat": false, "acceptPostOfficeAsCity": false, "correctionMode": "full", "correctionModeCrossCountry": "format" } }, "response": { "result": { "isValid": true, "proposal": "valid", "dataTypes": { "valid": [ "city", "country", "number.full", "street", "streetWithNumber", "zip" ], "invalid": [] }, "data": { "country": "Czech Republic", "state": null, "region": "Hlavní město Praha", "district": "území Hlavního města Prahy", "ids": { "internal": "d2ade877-1e95-4a83-baa6-5431ce5b3ca8", "external": "22349995" }, "street": "Thámova", "number": { "type": "č.p.", "part1": "137", "part1Number": "137", "part1Letter": null, "part2": "16", "part2Number": "16", "part2Letter": null, "full": "137/16" }, "streetWithNumber": "Thámova 137/16", "city": "Praha 8", "zip": "18600", "full": "Thámova 137/16, 18600 Praha 8" }, "errors": [] }, "resultCorrected": null, "suggestions": [] }, "errors": [] } }, "countryInternationalShortenedFormat": { "value": { "status": 200, "request": { "endpoint": "location/validate", "code": "1b3c9373-2f7d-4fbd-8fa7-e489cc1d9019", "query": { "streetWithNumber": "Thámova 137/16", "city": "Praha 8", "zip": "18600", "country": "Czechia" }, "options": { "dataSource": [ "CZ", "SK", "PL" ], "dataScope": "basic", "resultsLimit": 10, "cityFormat": "basic", "countryFormat": "internationalShortened", "zipFormat": false, "acceptPostOfficeAsCity": false, "correctionMode": "full", "correctionModeCrossCountry": "format" } }, "response": { "result": { "isValid": true, "proposal": "valid", "dataTypes": { "valid": [ "city", "country", "number.full", "street", "streetWithNumber", "zip" ], "invalid": [] }, "data": { "country": "Czechia", "state": null, "region": "Hlavní město Praha", "district": "území Hlavního města Prahy", "ids": { "internal": "d2ade877-1e95-4a83-baa6-5431ce5b3ca8", "external": "22349995" }, "street": "Thámova", "number": { "type": "č.p.", "part1": "137", "part1Number": "137", "part1Letter": null, "part2": "16", "part2Number": "16", "part2Letter": null, "full": "137/16" }, "streetWithNumber": "Thámova 137/16", "city": "Praha 8", "zip": "18600", "full": "Thámova 137/16, 18600 Praha 8" }, "errors": [] }, "resultCorrected": null, "suggestions": [] }, "errors": [] } }, "countryLocalFormat": { "value": { "status": 200, "request": { "endpoint": "location/validate", "code": "387e224f-6589-4b6b-a775-b1713d8a90a4", "query": { "streetWithNumber": "Thámova 137/16", "city": "Praha 8", "zip": "18600", "country": "Česká republika" }, "options": { "dataSource": [ "CZ", "SK", "PL" ], "dataScope": "basic", "resultsLimit": 10, "cityFormat": "basic", "countryFormat": "local", "zipFormat": false, "acceptPostOfficeAsCity": false, "correctionMode": "full", "correctionModeCrossCountry": "format" } }, "response": { "result": { "isValid": true, "proposal": "valid", "dataTypes": { "valid": [ "city", "country", "number.full", "street", "streetWithNumber", "zip" ], "invalid": [] }, "data": { "country": "Česká republika", "state": null, "region": "Hlavní město Praha", "district": "území Hlavního města Prahy", "ids": { "internal": "d2ade877-1e95-4a83-baa6-5431ce5b3ca8", "external": "22349995" }, "street": "Thámova", "number": { "type": "č.p.", "part1": "137", "part1Number": "137", "part1Letter": null, "part2": "16", "part2Number": "16", "part2Letter": null, "full": "137/16" }, "streetWithNumber": "Thámova 137/16", "city": "Praha 8", "zip": "18600", "full": "Thámova 137/16, 18600 Praha 8" }, "errors": [] }, "resultCorrected": null, "suggestions": [] }, "errors": [] } }, "countryLocalShortenedFormat": { "value": { "status": 200, "request": { "endpoint": "location/validate", "code": "b2c56b4a-13dc-4dbc-9f5d-9702f0e8e0f3", "query": { "streetWithNumber": "Thámova 137/16", "city": "Praha 8", "zip": "18600", "country": "Česko" }, "options": { "dataSource": [ "CZ", "SK", "PL" ], "dataScope": "basic", "resultsLimit": 10, "cityFormat": "basic", "countryFormat": "localShortened", "zipFormat": false, "acceptPostOfficeAsCity": false, "correctionMode": "full", "correctionModeCrossCountry": "format" } }, "response": { "result": { "isValid": true, "proposal": "valid", "dataTypes": { "valid": [ "city", "country", "number.full", "street", "streetWithNumber", "zip" ], "invalid": [] }, "data": { "country": "Česko", "state": null, "region": "Hlavní město Praha", "district": "území Hlavního města Prahy", "ids": { "internal": "d2ade877-1e95-4a83-baa6-5431ce5b3ca8", "external": "22349995" }, "street": "Thámova", "number": { "type": "č.p.", "part1": "137", "part1Number": "137", "part1Letter": null, "part2": "16", "part2Number": "16", "part2Letter": null, "full": "137/16" }, "streetWithNumber": "Thámova 137/16", "city": "Praha 8", "zip": "18600", "full": "Thámova 137/16, 18600 Praha 8" }, "errors": [] }, "resultCorrected": null, "suggestions": [] }, "errors": [] } }, "correctionModeFormat": { "value": { "status": 200, "request": { "endpoint": "location/validate", "code": "c254a9bc-4bc8-463c-8bed-b34f427209e9", "query": { "streetWithNumber": "thmova 137/16", "city": "Praha 8", "zip": "18600", "country": "cz" }, "options": { "dataSource": [ "CZ", "SK", "PL" ], "dataScope": "basic", "resultsLimit": 10, "cityFormat": "basic", "countryFormat": "alpha2", "zipFormat": false, "acceptPostOfficeAsCity": false, "correctionMode": "format", "correctionModeCrossCountry": "format" }, "client": { "country": "CZ" } }, "response": { "result": { "isValid": false, "proposal": "invalidWithPartialCorrectionWithSuggestion", "dataTypes": { "valid": [ "city", "number.full", "zip" ], "invalid": [ "country", "street", "streetWithNumber" ] }, "data": { "country": "CZ", "state": null, "region": null, "district": null, "ids": { "internal": null, "external": null }, "street": null, "number": { "type": null, "part1": null, "part1Number": null, "part1Letter": null, "part2": null, "part2Number": null, "part2Letter": null, "full": null }, "streetWithNumber": "thmova 137/16", "city": "Praha 8", "zip": "18600", "full": "thmova 137/16, 18600 Praha 8" }, "errors": [ { "group": "FORMAT", "type": "CHARACTERS", "subtype": "CASE_SENSITIVITY", "severity": "warning", "relatedTo": [ "country" ], "description": "Invalid case sensitivity. Specific rules are applied to the use of upper and lower case letters." }, { "group": "VALUE", "type": "INVALID", "subtype": null, "severity": "critical", "relatedTo": [ "streetWithNumber" ], "description": "Value is not valid." } ] }, "resultCorrected": { "isValid": false, "dataTypes": { "valid": [ "city", "country", "number.full", "street", "zip" ], "invalid": [ "streetWithNumber" ] }, "data": { "country": "CZ", "state": null, "region": "Hlavní město Praha", "district": "území Hlavního města Prahy", "ids": { "internal": null, "external": null }, "street": "Thámova", "number": { "type": "č.p.", "part1": "137", "part1Number": "137", "part1Letter": null, "part2": "16", "part2Number": "16", "part2Letter": null, "full": "137/16" }, "streetWithNumber": "thmova 137/16", "city": "Praha 8", "zip": "18600", "full": "Thámova 137/16, 18600 Praha 8" }, "errors": [ { "group": "VALUE", "type": "INVALID", "subtype": null, "severity": "critical", "relatedTo": [ "streetWithNumber" ], "description": "Value is not valid." } ], "fixes": [ { "group": "FORMAT", "type": "CHANGED", "subtype": "CASE_SENSITIVITY", "data": { "typeFrom": "country", "type": "country", "valueFrom": "cz", "value": "CZ" } } ] }, "suggestions": [ { "isValid": true, "dataTypes": { "valid": [ "city", "country", "number.full", "street", "streetWithNumber", "zip" ], "invalid": [] }, "data": { "country": "CZ", "state": null, "region": "Hlavní město Praha", "district": "území Hlavního města Prahy", "ids": { "internal": "d2ade877-1e95-4a83-baa6-5431ce5b3ca8", "external": "22349995" }, "street": "Thámova", "number": { "type": "č.p.", "part1": "137", "part1Number": "137", "part1Letter": null, "part2": "16", "part2Number": "16", "part2Letter": null, "full": "137/16" }, "streetWithNumber": "Thámova 137/16", "city": "Praha 8", "zip": "18600", "full": "Thámova 137/16, 18600 Praha 8" }, "errors": [], "fixes": [ { "group": "FORMAT", "type": "CHANGED", "subtype": "CASE_SENSITIVITY", "data": { "typeFrom": "country", "type": "country", "valueFrom": "cz", "value": "CZ" } }, { "group": "VALUE", "type": "CHANGED", "subtype": "TYPO", "data": { "typeFrom": "streetWithNumber", "type": "streetWithNumber", "valueFrom": "thmova 137/16", "value": "Thámova 137/16" } } ] } ] }, "errors": [] } }, "correctionModeFormatCorrected": { "value": { "status": 200, "request": { "endpoint": "location/validate", "code": "3c65cd18-97d2-4f45-8ab7-f25e7ceeef1c", "query": { "streetWithNumber": "thamova 137/16", "city": "praha 8", "zip": "186 00", "country": "cz" }, "options": { "dataSource": [ "CZ", "SK", "PL" ], "dataScope": "basic", "resultsLimit": 10, "cityFormat": "basic", "countryFormat": "alpha2", "zipFormat": false, "acceptPostOfficeAsCity": false, "correctionMode": "format", "correctionModeCrossCountry": "format" }, "client": { "country": "CZ" } }, "response": { "result": { "isValid": false, "proposal": "invalidWithCorrection", "dataTypes": { "valid": [ "number.full" ], "invalid": [ "city", "country", "street", "streetWithNumber", "zip" ] }, "data": { "country": "CZ", "state": null, "region": null, "district": null, "ids": { "internal": null, "external": null }, "street": null, "number": { "type": null, "part1": null, "part1Number": null, "part1Letter": null, "part2": null, "part2Number": null, "part2Letter": null, "full": null }, "streetWithNumber": "thamova 137/16", "city": "praha 8", "zip": "186 00", "full": "thamova 137/16, 186 00 praha 8" }, "errors": [ { "group": "FORMAT", "type": "CHARACTERS", "subtype": "CASE_SENSITIVITY", "severity": "warning", "relatedTo": [ "country", "streetWithNumber", "city" ], "description": "Invalid case sensitivity. Specific rules are applied to the use of upper and lower case letters." }, { "group": "FORMAT", "type": "CHARACTERS", "subtype": "DIACRITICS", "severity": "warning", "relatedTo": [ "streetWithNumber" ], "description": "Invalid diacritics. Specific rules are applied to the use of diacritics." }, { "group": "FORMAT", "type": "CHARACTERS", "subtype": "WHITESPACES", "severity": "warning", "relatedTo": [ "zip" ], "description": "Invalid use of spaces. Specific rules are applied to the use of spaces." } ] }, "resultCorrected": { "isValid": true, "dataTypes": { "valid": [ "city", "country", "number.full", "street", "streetWithNumber", "zip" ], "invalid": [] }, "data": { "country": "CZ", "state": null, "region": "Hlavní město Praha", "district": "území Hlavního města Prahy", "ids": { "internal": "d2ade877-1e95-4a83-baa6-5431ce5b3ca8", "external": "22349995" }, "street": "Thámova", "number": { "type": "č.p.", "part1": "137", "part1Number": "137", "part1Letter": null, "part2": "16", "part2Number": "16", "part2Letter": null, "full": "137/16" }, "streetWithNumber": "Thámova 137/16", "city": "Praha 8", "zip": "18600", "full": "Thámova 137/16, 18600 Praha 8" }, "errors": [], "fixes": [ { "group": "FORMAT", "type": "CHANGED", "subtype": "CASE_SENSITIVITY", "data": { "typeFrom": "country", "type": "country", "valueFrom": "cz", "value": "CZ" } }, { "group": "FORMAT", "type": "CHANGED", "subtype": "CASE_SENSITIVITY", "data": { "typeFrom": "streetWithNumber", "type": "streetWithNumber", "valueFrom": "thamova 137/16", "value": "Thamova 137/16" } }, { "group": "FORMAT", "type": "CHANGED", "subtype": "DIACRITICS", "data": { "typeFrom": "streetWithNumber", "type": "streetWithNumber", "valueFrom": "Thamova 137/16", "value": "Thámova 137/16" } }, { "group": "FORMAT", "type": "CHANGED", "subtype": "CASE_SENSITIVITY", "data": { "typeFrom": "city", "type": "city", "valueFrom": "praha 8", "value": "Praha 8" } }, { "group": "FORMAT", "type": "CHANGED", "subtype": "WHITESPACES", "data": { "typeFrom": "zip", "type": "zip", "valueFrom": "186 00", "value": "18600" } } ] }, "suggestions": [] }, "errors": [] } }, "correctionModeCrossCountryFormat": { "value": { "status": 200, "request": { "endpoint": "location/validate", "code": "58e78c7e-188d-497d-a9d0-46a1cacdf114", "query": { "streetWithNumber": "thmova 137/16", "city": "Praha 8", "zip": "18600", "country": "sk" }, "options": { "dataSource": [ "CZ", "SK", "PL" ], "dataScope": "basic", "resultsLimit": 10, "cityFormat": "basic", "countryFormat": "alpha2", "zipFormat": false, "acceptPostOfficeAsCity": false, "correctionMode": "full", "correctionModeCrossCountry": "format" }, "client": { "country": "CZ" } }, "response": { "result": { "isValid": false, "proposal": "invalidWithCorrection", "dataTypes": { "valid": [ "city", "number.full" ], "invalid": [ "country", "street", "streetWithNumber", "zip" ] }, "data": { "country": "SK", "state": null, "region": null, "district": null, "ids": { "internal": null, "external": null }, "street": null, "number": { "type": null, "part1": null, "part1Number": null, "part1Letter": null, "part2": null, "part2Number": null, "part2Letter": null, "full": null }, "streetWithNumber": "thmova 137/16", "city": "Praha 8", "zip": "18600", "full": "thmova 137/16, 18600 Praha 8" }, "errors": [ { "group": "VALUE", "type": "INVALID", "subtype": null, "severity": "critical", "relatedTo": [ "country", "streetWithNumber", "zip" ], "description": "Value is not valid." } ] }, "resultCorrected": { "isValid": true, "dataTypes": { "valid": [ "city", "country", "number.full", "street", "streetWithNumber", "zip" ], "invalid": [] }, "data": { "country": "CZ", "state": null, "region": "Hlavní město Praha", "district": "území Hlavního města Prahy", "ids": { "internal": "d2ade877-1e95-4a83-baa6-5431ce5b3ca8", "external": "22349995" }, "street": "Thámova", "number": { "type": "č.p.", "part1": "137", "part1Number": "137", "part1Letter": null, "part2": "16", "part2Number": "16", "part2Letter": null, "full": "137/16" }, "streetWithNumber": "Thámova 137/16", "city": "Praha 8", "zip": "18600", "full": "Thámova 137/16, 18600 Praha 8" }, "errors": [], "fixes": [] }, "suggestions": [] }, "errors": [] } }, "correctionModeCrossCountryFull": { "value": { "status": 200, "request": { "endpoint": "location/validate", "code": "69252511-3371-479a-b909-92fc4adc8362", "query": { "streetWithNumber": "thmova 137/16", "city": "Praha", "zip": "18600", "country": "sk" }, "options": { "dataSource": [ "CZ", "SK", "PL" ], "dataScope": "basic", "resultsLimit": 10, "cityFormat": "basic", "countryFormat": "alpha2", "zipFormat": false, "acceptPostOfficeAsCity": false, "correctionMode": "full", "correctionModeCrossCountry": "full" }, "client": { "country": "CZ" } }, "response": { "result": { "isValid": false, "proposal": "invalidWithCorrection", "dataTypes": { "valid": [ "number.full" ], "invalid": [ "city", "country", "street", "streetWithNumber", "zip" ] }, "data": { "country": "SK", "state": null, "region": null, "district": null, "ids": { "internal": null, "external": null }, "street": null, "number": { "type": null, "part1": null, "part1Number": null, "part1Letter": null, "part2": null, "part2Number": null, "part2Letter": null, "full": null }, "streetWithNumber": "thmova 137/16", "city": "Praha", "zip": "18600", "full": "thmova 137/16, 18600 Praha" }, "errors": [ { "group": "VALUE", "type": "INVALID", "subtype": null, "severity": "critical", "relatedTo": [ "country", "streetWithNumber", "zip" ], "description": "Value is not valid." }, { "group": "FORMAT", "type": "INVALID", "subtype": null, "severity": "warning", "relatedTo": [ "city" ], "description": null } ] }, "resultCorrected": { "isValid": true, "dataTypes": { "valid": [ "city", "country", "number.full", "street", "streetWithNumber", "zip" ], "invalid": [] }, "data": { "country": "CZ", "state": null, "region": "Hlavní město Praha", "district": "území Hlavního města Prahy", "ids": { "internal": "d2ade877-1e95-4a83-baa6-5431ce5b3ca8", "external": "22349995" }, "street": "Thámova", "number": { "type": "č.p.", "part1": "137", "part1Number": "137", "part1Letter": null, "part2": "16", "part2Number": "16", "part2Letter": null, "full": "137/16" }, "streetWithNumber": "Thámova 137/16", "city": "Praha 8", "zip": "18600", "full": "Thámova 137/16, 18600 Praha 8" }, "errors": [], "fixes": [ { "group": "VALUE", "type": "CHANGED", "subtype": null, "data": { "typeFrom": "country", "type": "country", "valueFrom": "sk", "value": "CZ" } }, { "group": "VALUE", "type": "CHANGED", "subtype": "TYPO", "data": { "typeFrom": "streetWithNumber", "type": "streetWithNumber", "valueFrom": "thmova 137/16", "value": "Thámova 137/16" } }, { "group": "FORMAT", "type": "CHANGED", "subtype": null, "data": { "typeFrom": "city", "type": "city", "valueFrom": "Praha", "value": "Praha 8" } } ] }, "suggestions": [] }, "errors": [] } } } } } }, "400": { "$ref": "#/paths/~1company~1get/post/responses/400" }, "401": { "$ref": "#/paths/~1company~1get/post/responses/401" }, "402": { "$ref": "#/paths/~1company~1get/post/responses/402" }, "403": { "$ref": "#/paths/~1company~1get/post/responses/403" }, "404": { "$ref": "#/paths/~1company~1get/post/responses/404" }, "405": { "$ref": "#/paths/~1company~1get/post/responses/405" }, "429": { "$ref": "#/paths/~1company~1get/post/responses/429" }, "500": { "$ref": "#/paths/~1company~1get/post/responses/500" }, "503": { "$ref": "#/paths/~1company~1get/post/responses/503" } }, "security": [ { "BearerAuth": [] } ] } }, "/location/search": { "post": { "tags": [ "Location" ], "summary": "Search location", "description": "This enpoint mainly serves as autocomplete but can be used to search for specific addresses based on filter criteria as well. Foxentry will automatically offer you suggestions to complete the address 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.", "operationId": "LocationSearch", "parameters": [ { "$ref": "#/paths/~1company~1get/post/parameters/0" }, { "$ref": "#/paths/~1company~1get/post/parameters/1" } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "request": { "type": "object", "allOf": [ { "type": "object", "properties": { "customId": { "type": [ "string", "null" ], "description": "Custom ID assigned by you if you need so.", "example": "customer567914" }, "query": { "type": "object", "properties": { "type": { "type": "string", "description": "Type of search.", "enum": [ "street", "streetWithNumber", "number.full", "number.part1", "number.part2", "city", "zip", "full" ] }, "value": { "description": "Searched value.", "type": "string" }, "filter": { "type": "object", "description": "Additional filter in order to specify the search results. You can for example set as a filter city of Prague, so the the search engine would look for the addresses only in Prague. Pay attention to the options, which determines how the filter should behave.", "properties": { "street": { "type": [ "string", "null" ], "description": "Street.", "example": "Jeseniova" }, "streetWithNumber": { "type": [ "string", "null" ], "description": "Street with number.", "example": "Jeseniova 55" }, "number.full": { "type": [ "string", "null" ], "description": "Full number.", "example": "1151/55d" }, "number.part1": { "type": [ "string", "null" ], "description": "First part of the number.", "example": "1151" }, "number.part2": { "type": [ "string", "null" ], "description": "Second part of the number.", "example": "55d" }, "city": { "type": [ "string", "null" ], "description": "City.", "example": "Praha" }, "zip": { "type": [ "string", "null" ], "description": "ZIP code.", "example": "130 00" }, "state": { "type": [ "string", "null" ], "description": "Federal state.", "example": "130 00" }, "region": { "type": [ "string", "null" ], "description": "Region.", "example": "Hlavní město Praha" }, "district": { "type": [ "string", "null" ], "description": "District.", "example": "Praha 3" }, "country": { "type": [ "string", "null" ], "description": "Country code in format [ISO-3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).", "example": "CZ" } } } }, "required": [ "type", "value" ] }, "options": { "type": "object", "description": "Query options.", "allOf": [ { "$ref": "#/paths/~1location~1get/post/requestBody/content/application~1json/schema/properties/request/allOf/0/properties/options/allOf/0" } ], "properties": { "resultsLimit": { "description": "Limits number of results returned by the endpoint.", "type": "integer", "minimum": 1, "maximum": 20, "default": 10, "example": 10 }, "resultsOffset": { "type": "integer", "description": "Pagination offset. Available only if the resultsTotal in response is not null.", "format": "int32", "minimum": 0, "example": 0, "default": 0 }, "allowPartialResults": { "type": "boolean", "description": "If true, the results can contain streets without number. This might occur when the street is present in multiple cities. Applicable only when using the streetWithNumber or full search types.", "default": true, "example": true }, "filterMode": { "type": "string", "description": "Prefer = prefer results matching the filter parameters, limit = limit to results matching the filter parameters.", "enum": [ "limit", "prefer" ], "example": "limit", "default": "limit" }, "filterAcceptFormat": { "type": "boolean", "description": "If true, values with different format would be accepted. (Uppercase and diacritics).", "example": true, "default": true }, "filterAcceptAlternatives": { "type": "boolean", "description": "If true, alternative values for filter types would be accepted. For example for City, also CityDistrict and CityDistrictSpecial would be accepted. (Praha, Praha 8, Karlín).", "example": true, "default": true }, "filterExactMatch": { "type": "boolean", "description": "If true, only exact match would be accepted. For example \"Prah\" would return 0 results, since no city with the exact name exists.", "example": true, "default": true } } }, "client": { "$ref": "#/paths/~1company~1get/post/requestBody/content/application~1json/schema/properties/request/allOf/0/properties/client" } } } ], "required": [ "query" ] } }, "required": [ "request" ] }, "examples": { "Request Example": { "value": { "request": { "customId": "customer567914", "query": { "type": "streetWithNumber", "value": "thamo", "filter": { "country": "CZ" } }, "options": { "dataScope": "basic", "resultsLimit": 10, "filterMode": "prefer", "filterAcceptFormat": true, "filterAcceptAlternatives": true, "filterExactMatch": true }, "client": { "ip": "127.0.1.1", "country": "CZ", "location": { "lat": 50.0628, "lon": 13.9271 } } } } } } } } }, "responses": { "200": { "description": "Successful response", "headers": { "foxentry-api-version": { "$ref": "#/paths/~1company~1get/post/responses/200/headers/foxentry-api-version" }, "foxentry-daily-credits-left": { "$ref": "#/paths/~1company~1get/post/responses/200/headers/foxentry-daily-credits-left" }, "foxentry-daily-credits-limit": { "$ref": "#/paths/~1company~1get/post/responses/200/headers/foxentry-daily-credits-limit" }, "foxentry-rate-limit": { "$ref": "#/paths/~1company~1get/post/responses/200/headers/foxentry-rate-limit" }, "foxentry-rate-limit-period": { "$ref": "#/paths/~1company~1get/post/responses/200/headers/foxentry-rate-limit-period" }, "foxentry-rate-limit-remaining": { "$ref": "#/paths/~1company~1get/post/responses/200/headers/foxentry-rate-limit-remaining" } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status of API response.", "example": 200 }, "request": { "allOf": [ { "type": "object", "properties": { "endpoint": { "example": "location/search" } } }, { "$ref": "#/paths/~1company~1get/post/responses/200/content/application~1json/schema/properties/request/allOf/1" }, { "$ref": "#/paths/~1location~1search/post/requestBody/content/application~1json/schema/properties/request/allOf/0" } ] }, "response": { "type": "object", "title": "LocationSearchResponse", "properties": { "resultsCount": { "type": "integer", "description": "Number of results.", "format": "int32", "example": 3 }, "resultsOffset": { "type": "integer", "description": "Pagination offset", "format": "int32", "example": 0 }, "resultsTotal": { "type": [ "integer", "null" ], "description": "Maximum number of results that can be returned. Null if pagination not available.", "format": "int32", "example": 40 }, "results": { "type": "array", "items": { "$ref": "#/paths/~1location~1get/post/responses/200/content/application~1json/schema/properties/response/properties/results/items" } } }, "required": [ "resultsCount", "results" ] }, "errors": { "description": "List of errors related to the request. Should be empty if the request finished successfully.", "type": "array", "items": {}, "maxItems": 0 } }, "required": [ "status", "request" ] }, "examples": { "searchStreet": { "value": { "status": 200, "request": { "endpoint": "location/search", "code": "ee87ba43-7cd5-4857-83c9-5cc5c91fbf19", "query": { "type": "street", "filter": { "city": "Praha", "country": "CZ" }, "value": "tha" }, "options": { "dataSource": [ "CZ", "SK", "PL" ], "dataScope": "basic", "filterMode": "limit", "filterAcceptAlternatives": true, "filterAcceptFormat": true, "filterExactMatch": true, "resultsLimit": 3, "resultsOffset": 0, "cityFormat": "basic", "zipFormat": false, "countryFormat": "alpha2", "allowPartialResults": true } }, "response": { "resultsCount": 2, "resultsOffset": 0, "resultsTotal": null, "results": [ { "data": { "country": "CZ", "state": null, "region": "Hlavní město Praha", "district": "území Hlavního města Prahy", "ids": { "internal": null, "external": null }, "street": "Thákurova", "number": { "type": null, "part1": null, "part1Number": null, "part1Letter": null, "part2": null, "part2Number": null, "part2Letter": null, "full": null }, "streetWithNumber": "Thákurova", "city": "Praha 6", "zip": "16000", "full": "Thákurova, 16000 Praha 6" } }, { "data": { "country": "CZ", "state": null, "region": "Hlavní město Praha", "district": "území Hlavního města Prahy", "ids": { "internal": null, "external": null }, "street": "Thámova", "number": { "type": null, "part1": null, "part1Number": null, "part1Letter": null, "part2": null, "part2Number": null, "part2Letter": null, "full": null }, "streetWithNumber": "Thámova", "city": "Praha 8", "zip": "18600", "full": "Thámova, 18600 Praha 8" } } ] }, "errors": [] } }, "searchCity": { "value": { "status": 200, "request": { "endpoint": "location/search", "code": "f485229f-241d-4392-a7d1-1fb3938902f9", "query": { "type": "city", "value": "Praha" }, "options": { "dataSource": [ "CZ", "SK", "PL" ], "dataScope": "basic", "filterMode": "limit", "filterAcceptAlternatives": true, "filterAcceptFormat": true, "filterExactMatch": true, "resultsLimit": 3, "resultsOffset": 0, "cityFormat": "basic", "zipFormat": false, "countryFormat": "alpha2", "allowPartialResults": true } }, "response": { "resultsCount": 3, "resultsOffset": 0, "resultsTotal": null, "results": [ { "data": { "country": "CZ", "state": null, "region": "Hlavní město Praha", "district": "území Hlavního města Prahy", "ids": { "internal": null, "external": null }, "street": null, "number": { "type": null, "part1": null, "part1Number": null, "part1Letter": null, "part2": null, "part2Number": null, "part2Letter": null, "full": null }, "streetWithNumber": null, "city": "Praha", "zip": null, "full": "Praha" } }, { "data": { "country": "SK", "state": null, "region": "Banskobystrický", "district": "Lučenec", "ids": { "internal": null, "external": null }, "street": "Praha", "number": { "type": null, "part1": null, "part1Number": null, "part1Letter": null, "part2": null, "part2Number": null, "part2Letter": null, "full": null }, "streetWithNumber": "Praha", "city": "Praha", "zip": "98511", "full": "Praha, 98511 Praha" } }, { "data": { "country": "CZ", "state": null, "region": "Hlavní město Praha", "district": "území Hlavního města Prahy", "ids": { "internal": null, "external": null }, "street": null, "number": { "type": null, "part1": null, "part1Number": null, "part1Letter": null, "part2": null, "part2Number": null, "part2Letter": null, "full": null }, "streetWithNumber": null, "city": "Praha", "zip": null, "full": "Praha" } } ] }, "errors": [] } }, "searchStreetWithNumber": { "value": { "status": 200, "request": { "endpoint": "location/search", "code": "8c6fad69-9414-4662-beb2-7028cc0b3b34", "query": { "type": "streetWithNumber", "filter": { "city": "Praha", "country": "CZ" }, "value": "Jeseniova 56" }, "options": { "dataSource": [ "CZ", "SK", "PL" ], "dataScope": "basic", "filterMode": "limit", "filterAcceptAlternatives": true, "filterAcceptFormat": true, "filterExactMatch": true, "resultsLimit": 3, "resultsOffset": 0, "cityFormat": "basic", "zipFormat": false, "countryFormat": "alpha2", "allowPartialResults": true } }, "response": { "resultsCount": 2, "resultsOffset": 0, "resultsTotal": 2, "results": [ { "data": { "country": "CZ", "state": null, "region": "Hlavní město Praha", "district": "území Hlavního města Prahy", "ids": { "internal": null, "external": null }, "street": "Jeseniova", "number": { "type": null, "part1": "2760", "part1Number": "2760", "part1Letter": null, "part2": "56", "part2Number": "56", "part2Letter": null, "full": "2760/56" }, "streetWithNumber": "Jeseniova 2760/56", "city": "Praha 3", "zip": "13000", "full": "Jeseniova 2760/56, 13000 Praha 3" } }, { "data": { "country": "CZ", "state": null, "region": "Hlavní město Praha", "district": "území Hlavního města Prahy", "ids": { "internal": null, "external": null }, "street": "Jeseniova", "number": { "type": null, "part1": "2770", "part1Number": "2770", "part1Letter": null, "part2": "56", "part2Number": "56", "part2Letter": null, "full": "2770/56" }, "streetWithNumber": "Jeseniova 2770/56", "city": "Praha 3", "zip": "13000", "full": "Jeseniova 2770/56, 13000 Praha 3" } } ] }, "errors": [] } }, "searchStreetWithNumberFederal": { "value": { "status": 200, "request": { "endpoint": "location/search", "code": "d05b6745-f2f9-4b9c-9b4d-54ba68bf76c7", "query": { "type": "streetWithNumber", "filter": { "city": "Peine", "country": "DE" }, "value": "Amselweg 12H" }, "options": { "dataSource": [ "AD", "AL", "AT", "BA", "BE", "BG", "CH", "CY", "CZ", "DE", "DK", "ES", "GR", "HR", "HU", "IS", "IT", "LI", "LU", "ME", "MK", "MT", "NL", "PL", "RO", "RS", "SI", "SK", "XK" ], "dataScope": "basic", "filterMode": "limit", "filterAcceptAlternatives": true, "filterAcceptFormat": true, "filterExactMatch": true, "resultsLimit": 3, "resultsOffset": 0, "cityFormat": "basic", "zipFormat": false, "countryFormat": "alpha2", "allowPartialResults": true } }, "response": { "resultsCount": 1, "resultsOffset": 0, "resultsTotal": 1, "results": [ { "data": { "country": "DE", "state": "Niedersachsen", "region": "Peine", "district": null, "ids": { "internal": "bc0e60e6-94dd-4ead-b9b4-715eb7a4265e", "external": null }, "street": "Amselweg", "number": { "type": null, "part1": null, "part1Number": null, "part1Letter": null, "part2": null, "part2Number": null, "part2Letter": null, "full": "12H" }, "streetWithNumber": "Amselweg 12H", "city": "Peine", "zip": "31224", "full": "Amselweg 12H, 31224 Peine" } } ] }, "errors": [] } }, "searchZip": { "value": { "status": 200, "request": { "endpoint": "location/search", "code": "913b7096-49ac-44f9-a626-f6796307044e", "query": { "type": "zip", "value": "10000" }, "options": { "dataSource": [ "CZ", "SK", "PL" ], "dataScope": "basic", "filterMode": "limit", "filterAcceptAlternatives": true, "filterAcceptFormat": true, "filterExactMatch": true, "resultsLimit": 3, "resultsOffset": 0, "cityFormat": "basic", "zipFormat": false, "countryFormat": "alpha2", "allowPartialResults": true } }, "response": { "resultsCount": 18, "resultsOffset": 0, "resultsTotal": null, "results": [ { "data": { "country": "CZ", "state": null, "region": "Hlavní město Praha", "district": "území Hlavního města Prahy", "ids": { "internal": null, "external": null }, "street": null, "number": { "type": null, "part1": null, "part1Number": null, "part1Letter": null, "part2": null, "part2Number": null, "part2Letter": null, "full": null }, "streetWithNumber": null, "city": "Praha", "zip": "10000", "full": "10000 Praha" } }, { "data": { "country": "CZ", "state": null, "region": "Hlavní město Praha", "district": "území Hlavního města Prahy", "ids": { "internal": null, "external": null }, "street": null, "number": { "type": null, "part1": null, "part1Number": null, "part1Letter": null, "part2": null, "part2Number": null, "part2Letter": null, "full": null }, "streetWithNumber": null, "city": "Praha", "zip": "10100", "full": "10100 Praha" } }, { "data": { "country": "CZ", "state": null, "region": "Hlavní město Praha", "district": "území Hlavního města Prahy", "ids": { "internal": null, "external": null }, "street": null, "number": { "type": null, "part1": null, "part1Number": null, "part1Letter": null, "part2": null, "part2Number": null, "part2Letter": null, "full": null }, "streetWithNumber": null, "city": "Praha 10", "zip": "10200", "full": "10200 Praha 10" } }, { "data": { "country": "CZ", "state": null, "region": "Hlavní město Praha", "district": "území Hlavního města Prahy", "ids": { "internal": null, "external": null }, "street": null, "number": { "type": null, "part1": null, "part1Number": null, "part1Letter": null, "part2": null, "part2Number": null, "part2Letter": null, "full": null }, "streetWithNumber": null, "city": "Praha 10", "zip": "10300", "full": "10300 Praha 10" } }, { "data": { "country": "CZ", "state": null, "region": "Hlavní město Praha", "district": "území Hlavního města Prahy", "ids": { "internal": null, "external": null }, "street": null, "number": { "type": null, "part1": null, "part1Number": null, "part1Letter": null, "part2": null, "part2Number": null, "part2Letter": null, "full": null }, "streetWithNumber": null, "city": "Praha 10", "zip": "10400", "full": "10400 Praha 10" } }, { "data": { "country": "CZ", "state": null, "region": "Hlavní město Praha", "district": "území Hlavního města Prahy", "ids": { "internal": null, "external": null }, "street": null, "number": { "type": null, "part1": null, "part1Number": null, "part1Letter": null, "part2": null, "part2Number": null, "part2Letter": null, "full": null }, "streetWithNumber": null, "city": "Praha 10", "zip": "10600", "full": "10600 Praha 10" } }, { "data": { "country": "CZ", "state": null, "region": "Hlavní město Praha", "district": "území Hlavního města Prahy", "ids": { "internal": null, "external": null }, "street": null, "number": { "type": null, "part1": null, "part1Number": null, "part1Letter": null, "part2": null, "part2Number": null, "part2Letter": null, "full": null }, "streetWithNumber": null, "city": "Praha 10", "zip": "10700", "full": "10700 Praha 10" } }, { "data": { "country": "CZ", "state": null, "region": "Hlavní město Praha", "district": "území Hlavního města Prahy", "ids": { "internal": null, "external": null }, "street": null, "number": { "type": null, "part1": null, "part1Number": null, "part1Letter": null, "part2": null, "part2Number": null, "part2Letter": null, "full": null }, "streetWithNumber": null, "city": "Praha 10", "zip": "10800", "full": "10800 Praha 10" } }, { "data": { "country": "CZ", "state": null, "region": "Hlavní město Praha", "district": "území Hlavního města Prahy", "ids": { "internal": null, "external": null }, "street": null, "number": { "type": null, "part1": null, "part1Number": null, "part1Letter": null, "part2": null, "part2Number": null, "part2Letter": null, "full": null }, "streetWithNumber": null, "city": "Praha 10", "zip": "10900", "full": "10900 Praha 10" } }, { "data": { "country": "CZ", "state": null, "region": "Hlavní město Praha", "district": "území Hlavního města Prahy", "ids": { "internal": null, "external": null }, "street": null, "number": { "type": null, "part1": null, "part1Number": null, "part1Letter": null, "part2": null, "part2Number": null, "part2Letter": null, "full": null }, "streetWithNumber": null, "city": "Praha", "zip": "11000", "full": "11000 Praha" } }, { "data": { "country": "CZ", "state": null, "region": "Hlavní město Praha", "district": "území Hlavního města Prahy", "ids": { "internal": null, "external": null }, "street": null, "number": { "type": null, "part1": null, "part1Number": null, "part1Letter": null, "part2": null, "part2Number": null, "part2Letter": null, "full": null }, "streetWithNumber": null, "city": "Praha", "zip": "12000", "full": "12000 Praha" } }, { "data": { "country": "CZ", "state": null, "region": "Hlavní město Praha", "district": "území Hlavního města Prahy", "ids": { "internal": null, "external": null }, "street": null, "number": { "type": null, "part1": null, "part1Number": null, "part1Letter": null, "part2": null, "part2Number": null, "part2Letter": null, "full": null }, "streetWithNumber": null, "city": "Praha", "zip": "13000", "full": "13000 Praha" } }, { "data": { "country": "CZ", "state": null, "region": "Hlavní město Praha", "district": "území Hlavního města Prahy", "ids": { "internal": null, "external": null }, "street": null, "number": { "type": null, "part1": null, "part1Number": null, "part1Letter": null, "part2": null, "part2Number": null, "part2Letter": null, "full": null }, "streetWithNumber": null, "city": "Praha", "zip": "14000", "full": "14000 Praha" } }, { "data": { "country": "CZ", "state": null, "region": "Hlavní město Praha", "district": "území Hlavního města Prahy", "ids": { "internal": null, "external": null }, "street": null, "number": { "type": null, "part1": null, "part1Number": null, "part1Letter": null, "part2": null, "part2Number": null, "part2Letter": null, "full": null }, "streetWithNumber": null, "city": "Praha", "zip": "15000", "full": "15000 Praha" } }, { "data": { "country": "CZ", "state": null, "region": "Hlavní město Praha", "district": "území Hlavního města Prahy", "ids": { "internal": null, "external": null }, "street": null, "number": { "type": null, "part1": null, "part1Number": null, "part1Letter": null, "part2": null, "part2Number": null, "part2Letter": null, "full": null }, "streetWithNumber": null, "city": "Praha 6", "zip": "16000", "full": "16000 Praha 6" } }, { "data": { "country": "CZ", "state": null, "region": "Hlavní město Praha", "district": "území Hlavního města Prahy", "ids": { "internal": null, "external": null }, "street": null, "number": { "type": null, "part1": null, "part1Number": null, "part1Letter": null, "part2": null, "part2Number": null, "part2Letter": null, "full": null }, "streetWithNumber": null, "city": "Praha 7", "zip": "17000", "full": "17000 Praha 7" } }, { "data": { "country": "CZ", "state": null, "region": "Hlavní město Praha", "district": "území Hlavního města Prahy", "ids": { "internal": null, "external": null }, "street": null, "number": { "type": null, "part1": null, "part1Number": null, "part1Letter": null, "part2": null, "part2Number": null, "part2Letter": null, "full": null }, "streetWithNumber": null, "city": "Praha", "zip": "18000", "full": "18000 Praha" } }, { "data": { "country": "CZ", "state": null, "region": "Hlavní město Praha", "district": "území Hlavního města Prahy", "ids": { "internal": null, "external": null }, "street": null, "number": { "type": null, "part1": null, "part1Number": null, "part1Letter": null, "part2": null, "part2Number": null, "part2Letter": null, "full": null }, "streetWithNumber": null, "city": "Praha", "zip": "19000", "full": "19000 Praha" } } ] }, "errors": [] } }, "searchFull": { "value": { "status": 200, "request": { "endpoint": "location/search", "code": "c96fdfd5-3e65-42c8-852a-ad010525ca87", "query": { "type": "full", "value": "Jeseniova, 13000 Praha 3" }, "options": { "dataSource": [ "CZ", "SK", "PL" ], "dataScope": "basic", "filterMode": "limit", "filterAcceptAlternatives": true, "filterAcceptFormat": true, "filterExactMatch": true, "resultsLimit": 3, "resultsOffset": 0, "cityFormat": "basic", "zipFormat": false, "countryFormat": "alpha2", "allowPartialResults": true } }, "response": { "resultsCount": 3, "resultsOffset": 0, "resultsTotal": null, "results": [ { "data": { "country": "CZ", "state": null, "region": "Hlavní město Praha", "district": "území Hlavního města Prahy", "ids": { "internal": "9589b261-05d7-418d-b6e0-561786a80f68", "external": "21769435" }, "street": "Jeseniova", "number": { "type": "č.p.", "part1": "246", "part1Number": "246", "part1Letter": null, "part2": "3", "part2Number": "3", "part2Letter": null, "full": "246/3" }, "streetWithNumber": "Jeseniova 246/3", "city": "Praha 3", "zip": "13000", "full": "Jeseniova 246/3, 13000 Praha 3" } }, { "data": { "country": "CZ", "state": null, "region": "Hlavní město Praha", "district": "území Hlavního města Prahy", "ids": { "internal": "05bff605-6102-4aef-8546-60c3e431b97b", "external": "21781397" }, "street": "Jeseniova", "number": { "type": "č.p.", "part1": "1373", "part1Number": "1373", "part1Letter": null, "part2": "77", "part2Number": "77", "part2Letter": null, "full": "1373/77" }, "streetWithNumber": "Jeseniova 1373/77", "city": "Praha 3", "zip": "13000", "full": "Jeseniova 1373/77, 13000 Praha 3" } }, { "data": { "country": "CZ", "state": null, "region": "Hlavní město Praha", "district": "území Hlavního města Prahy", "ids": { "internal": "2adaf1f8-1da5-458a-95f0-07ec0f321eb2", "external": "21783373" }, "street": "Jeseniova", "number": { "type": "č.p.", "part1": "1535", "part1Number": "1535", "part1Letter": null, "part2": "134", "part2Number": "134", "part2Letter": null, "full": "1535/134" }, "streetWithNumber": "Jeseniova 1535/134", "city": "Praha 3", "zip": "13000", "full": "Jeseniova 1535/134, 13000 Praha 3" } } ] }, "errors": [] } } } } } }, "400": { "$ref": "#/paths/~1company~1get/post/responses/400" }, "401": { "$ref": "#/paths/~1company~1get/post/responses/401" }, "402": { "$ref": "#/paths/~1company~1get/post/responses/402" }, "403": { "$ref": "#/paths/~1company~1get/post/responses/403" }, "404": { "$ref": "#/paths/~1company~1get/post/responses/404" }, "405": { "$ref": "#/paths/~1company~1get/post/responses/405" }, "429": { "$ref": "#/paths/~1company~1get/post/responses/429" }, "500": { "$ref": "#/paths/~1company~1get/post/responses/500" }, "503": { "$ref": "#/paths/~1company~1get/post/responses/503" } }, "security": [ { "BearerAuth": [] } ] } }, "/location/get": { "post": { "tags": [ "Location" ], "summary": "Get location data", "description": "Foxentry allows you to get information about location based on the dataScope option. Country and ID parameters are required. You can either choose internal ID, which is assigned by Foxentry or external ID from the data source. CZ external = RUIAN, PL external = Gov data, SK external does not exist.", "operationId": "LocationGet", "parameters": [ { "$ref": "#/paths/~1company~1get/post/parameters/0" }, { "$ref": "#/paths/~1company~1get/post/parameters/1" } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "request": { "type": "object", "allOf": [ { "type": "object", "properties": { "customId": { "type": [ "string", "null" ], "description": "Custom ID assigned by you if you need so.", "example": "customer567914" }, "query": { "type": "object", "properties": { "country": { "type": "string", "description": "Country code in format [ISO-3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).", "example": "CZ" }, "id": { "type": "string", "description": "Location ID", "example": "d2ade877-1e95-4a83-baa6-5431ce5b3ca8" } }, "required": [ "country", "id" ] }, "options": { "allOf": [ { "type": "object", "description": "Query options.", "properties": { "dataScope": { "type": "string", "description": "Data scope of returned data.", "enum": [ "basic", "full" ], "default": "basic", "example": "full" }, "dataSource": { "description": "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.", "type": "array", "items": { "type": "string", "example": "CZ" }, "default": [ "AD", "AL", "AT", "BA", "BE", "BG", "CH", "CY", "CZ", "DE", "DK", "ES", "FR", "GB", "GR", "HR", "HU", "IS", "IT", "LI", "LU", "MC", "ME", "MK", "MT", "NL", "PL", "RO", "RS", "SI", "SK", "SM", "VA", "XK" ], "example": [ "CZ", "SK", "PL" ] }, "zipFormat": { "description": "Whether to return locally formatted ZIP code or not. (130 00 vs 13000).", "type": "boolean", "default": false, "example": false }, "countryFormat": { "description": "This option determines the format in which the country is returned. Choices include local (Česká republika) and international (Czech Republic) variants with their shortened counterparts (Česko, Czechia). You can use ISO 3166 alpha codes (CZ, CZE) as well.", "type": "string", "enum": [ "alpha2", "alpha3", "local", "localShortened", "international", "internationalShortened" ], "default": "alpha2", "example": "alpha2" }, "cityFormat": { "description": "This option determines the format in which the city is returned. Minimal = Praha, basic = Praha 8, extended = Praha 8 - Karlín.", "type": "string", "enum": [ "minimal", "basic", "extended" ], "default": "basic", "example": "basic" } } }, { "type": "object", "properties": { "idType": { "description": "Internal is assigned by Foxentry. External ID may vary for every supported country. CZ = RUIAN, PL = Government data, SK = no external ID.", "enum": [ "internal", "external" ], "example": "internal" } } } ] }, "client": { "$ref": "#/paths/~1company~1get/post/requestBody/content/application~1json/schema/properties/request/allOf/0/properties/client" } } } ], "required": [ "query" ] } }, "required": [ "request" ] }, "examples": { "Request Example": { "value": { "request": { "query": { "country": "CZ", "id": "d2ade877-1e95-4a83-baa6-5431ce5b3ca8" }, "options": { "idType": "internal", "dataScope": "full" } } } } } } } }, "responses": { "200": { "description": "Successful response", "headers": { "foxentry-api-version": { "$ref": "#/paths/~1company~1get/post/responses/200/headers/foxentry-api-version" }, "foxentry-daily-credits-left": { "$ref": "#/paths/~1company~1get/post/responses/200/headers/foxentry-daily-credits-left" }, "foxentry-daily-credits-limit": { "$ref": "#/paths/~1company~1get/post/responses/200/headers/foxentry-daily-credits-limit" }, "foxentry-rate-limit": { "$ref": "#/paths/~1company~1get/post/responses/200/headers/foxentry-rate-limit" }, "foxentry-rate-limit-period": { "$ref": "#/paths/~1company~1get/post/responses/200/headers/foxentry-rate-limit-period" }, "foxentry-rate-limit-remaining": { "$ref": "#/paths/~1company~1get/post/responses/200/headers/foxentry-rate-limit-remaining" } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status of API response.", "example": 200 }, "request": { "allOf": [ { "type": "object", "properties": { "endpoint": { "example": "location/get" } } }, { "$ref": "#/paths/~1company~1get/post/responses/200/content/application~1json/schema/properties/request/allOf/1" }, { "$ref": "#/paths/~1location~1get/post/requestBody/content/application~1json/schema/properties/request/allOf/0" } ] }, "response": { "type": "object", "properties": { "results": { "type": "array", "items": { "title": "Location data", "description": "Location data", "type": "object", "properties": { "data": { "type": "object", "properties": { "country": { "type": [ "string", "null" ], "description": "Country code in format [ISO-3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).", "example": "CZ" }, "state": { "type": [ "string", "null" ], "example": "Niedersachsen", "description": "Federal state" }, "region": { "type": [ "string", "null" ], "example": "Hlavní město Praha" }, "district": { "type": [ "string", "null" ], "example": "Hlavní město Praha" }, "cityDistrict": { "type": [ "string", "null" ], "example": "Praha 6" }, "cityDistrictSpecial": { "type": [ "string", "null" ], "description": "Special types of city districts. Used only in Prague at the moment.", "example": "Praha 6" }, "cityPart": { "type": [ "string", "null" ], "example": "Dejvice" }, "cityAdministrative": { "type": [ "string", "null" ], "description": "City Administrative area.", "example": "Kraków" }, "cadastralArea": { "type": [ "string", "null" ], "description": "City cadastral area.", "example": "Dejvice" }, "ids": { "type": "object", "description": "Address internal & external ids.", "properties": { "internal": { "type": [ "string", "null" ], "description": "Internal address ID.", "example": "2070391" }, "external": { "type": [ "string", "null" ], "description": "External address ID. May vary for every supported country. CZ = RUIAN, PL = Government data, SK = no external ID.", "example": "22349995" }, "region": { "type": [ "string", "null" ], "description": "Region ID.", "example": "19" }, "district": { "type": [ "string", "null" ], "description": "District ID.", "example": "9999" }, "cityDistrictSpecial": { "type": [ "string", "null" ], "description": "City district special ID.", "example": "86" }, "cityDistrict": { "type": [ "string", "null" ], "description": "City district ID.", "example": "500208" }, "cityPart": { "type": [ "string", "null" ], "description": "City part ID.", "example": "400637" }, "cadastralArea": { "type": [ "string", "null" ], "description": "Cadastral area ID.", "example": "730955" }, "city": { "type": [ "string", "null" ], "description": "City ID.", "example": "554782" }, "street": { "type": [ "string", "null" ], "description": "Street ID.", "example": "554782" } } }, "street": { "type": [ "string", "null" ], "description": "Street.", "example": "Jeseniova" }, "number": { "type": [ "object", "null" ], "properties": { "part1": { "type": [ "string", "null" ], "description": "First section of house number.", "example": "137" }, "part1Number": { "type": [ "string", "null" ], "description": "Numerical part of the first section.", "example": "137" }, "part1Letter": { "type": [ "string", "null" ], "description": "Textual part of the first section.", "example": null }, "part2": { "type": [ "string", "null" ], "description": "Second section of house number.", "example": "16" }, "part2Number": { "type": [ "string", "null" ], "description": "Numerical part of the second section.", "example": "16" }, "part2Letter": { "type": [ "string", "null" ], "description": "Textual part of the second section.", "example": null }, "full": { "type": [ "string", "null" ], "description": "Full house number.", "example": "137/16" }, "type": { "type": [ "string", "null" ], "description": "Type of house number.", "example": "č.p." } }, "required": [ "part1", "part2" ] }, "streetWithNumber": { "type": [ "string", "null" ], "description": "Street with number.", "example": "Jeseniova 1151/55" }, "city": { "type": [ "string", "null" ], "description": "Location city.", "example": "Praha" }, "zip": { "type": [ "string", "null" ], "description": "ZIP code.", "example": "13000" }, "postOffice": { "type": "object", "description": "In what post office jurisdiction the address falls under.", "properties": { "name": { "type": [ "string", "null" ], "example": "Praha 086" } }, "required": [ "name" ] }, "geometry": { "type": "object", "properties": { "gps": { "type": "object", "properties": { "lat": { "type": [ "number", "null" ], "description": "Latitude coordinate.", "example": 50.087440865479 }, "lon": { "type": [ "number", "null" ], "description": "Longitude coordinate.", "example": 14.463284033285 } }, "required": [ "lat", "lon" ] }, "custom": { "type": "array", "description": "Custom coordinate system. May vary for every country.", "items": { "type": "object", "properties": { "type": { "type": [ "string", "null" ], "description": "Type of coordinate system.", "example": "JTSK", "enum": [ "JTSK", "ETRS89" ] }, "coordinates": { "type": "object", "properties": { "x": { "type": "number", "description": "First coordinate.", "example": 739831.1 }, "y": { "type": "number", "description": "Second coordinate.", "example": 1043425.38 } } } } } } } }, "full": { "type": [ "string", "null" ], "example": "Jeseniova 1151/55, 130 00 Praha 3" } }, "required": [ "country", "ids", "street", "number", "streetWithNumber", "city", "zip", "full" ] } }, "required": [ "data" ] } } }, "required": [ "results" ] }, "errors": { "description": "List of errors related to the request. Should be empty if the request finished successfully.", "type": "array", "items": {}, "maxItems": 0 } }, "required": [ "status", "request", "errors", "response" ] }, "examples": { "getFullDataScopeByInternalID": { "value": { "status": 200, "request": { "endpoint": "location/get", "code": "16a6a659-58a7-4f2f-aac0-5548c2a74958", "query": { "country": "CZ", "id": "d2ade877-1e95-4a83-baa6-5431ce5b3ca8" }, "options": { "dataSource": [ "CZ", "SK", "PL" ], "dataScope": "basic", "idType": "internal", "cityFormat": "basic", "zipFormat": false, "countryFormat": "alpha2" } }, "response": { "results": [ { "data": { "country": "CZ", "state": null, "region": "Hlavní město Praha", "district": "území Hlavního města Prahy", "ids": { "internal": "d2ade877-1e95-4a83-baa6-5431ce5b3ca8", "external": "22349995" }, "street": "Thámova", "number": { "type": "č.p.", "part1": "137", "part1Number": "137", "part1Letter": null, "part2": "16", "part2Number": "16", "part2Letter": null, "full": "137/16" }, "streetWithNumber": "Thámova 137/16", "city": "Praha 8", "zip": "18600", "full": "Thámova 137/16, 18600 Praha 8" } } ] }, "errors": [] } }, "getFullDataScopeByExternalID": { "value": { "status": 200, "request": { "endpoint": "location/get", "code": "c1632057-ea6f-4459-8e8a-5a21fdae49a2", "query": { "country": "CZ", "id": "22349995" }, "options": { "dataSource": [ "CZ", "SK", "PL" ], "dataScope": "basic", "idType": "external", "cityFormat": "basic", "zipFormat": false, "countryFormat": "alpha2" } }, "response": { "results": [ { "data": { "country": "CZ", "state": null, "region": "Hlavní město Praha", "district": "území Hlavního města Prahy", "ids": { "internal": "d2ade877-1e95-4a83-baa6-5431ce5b3ca8", "external": "22349995" }, "street": "Thámova", "number": { "type": "č.p.", "part1": "137", "part1Number": "137", "part1Letter": null, "part2": "16", "part2Number": "16", "part2Letter": null, "full": "137/16" }, "streetWithNumber": "Thámova 137/16", "city": "Praha 8", "zip": "18600", "full": "Thámova 137/16, 18600 Praha 8" } } ] }, "errors": [] } } } } } }, "400": { "$ref": "#/paths/~1company~1get/post/responses/400" }, "401": { "$ref": "#/paths/~1company~1get/post/responses/401" }, "402": { "$ref": "#/paths/~1company~1get/post/responses/402" }, "403": { "$ref": "#/paths/~1company~1get/post/responses/403" }, "404": { "$ref": "#/paths/~1company~1get/post/responses/404" }, "405": { "$ref": "#/paths/~1company~1get/post/responses/405" }, "429": { "$ref": "#/paths/~1company~1get/post/responses/429" }, "500": { "$ref": "#/paths/~1company~1get/post/responses/500" }, "503": { "$ref": "#/paths/~1company~1get/post/responses/503" } }, "security": [ { "BearerAuth": [] } ] } }, "/location/localize": { "post": { "tags": [ "Location" ], "summary": "Localization", "description": "Foxentry allows you to check an area with GPS radius in order to return all the addresses within that area. It can also give you additional information about the addresses based on the dataScope option.

Please pay attention to the singleLocationResultDistance option, which determines the radius of the search area in meters.

", "operationId": "LocationLocalization", "parameters": [ { "$ref": "#/paths/~1company~1get/post/parameters/0" }, { "$ref": "#/paths/~1company~1get/post/parameters/1" } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "request": { "type": "object", "allOf": [ { "type": "object", "properties": { "customId": { "type": [ "string", "null" ], "description": "Custom ID assigned by you if you need so.", "example": "customer567914" }, "query": { "type": "object", "required": [ "lat", "lon" ], "properties": { "lat": { "type": "number", "description": "Latitude of the searched point.", "example": 50.0919999 }, "lon": { "type": "number", "description": "Longitude of the searched point.", "example": 14.4527403 } } }, "options": { "allOf": [ { "$ref": "#/paths/~1location~1get/post/requestBody/content/application~1json/schema/properties/request/allOf/0/properties/options/allOf/0" }, { "type": "object", "properties": { "radius": { "type": "integer", "description": "Radius of the search area in meters. In other words the distance in meters from the user's GPS coordinates. The number of suggested addresses depends on the size of the radius. If there are too many suitable addresses, the result count is limited by the resultsLimit option.", "minimum": 1, "maximum": 1000, "default": 50, "example": 50 }, "acceptNearest": { "type": "boolean", "description": "If the searched area does not contain any addreses, Foxentry can return list of the Nearest locations to the searched area (acceptNearest = true).", "default": false, "example": false } } } ] }, "client": { "type": "object", "description": "Additional information about your user (from whom you've obtained the data sent in query) in order to specify the results in response. Used mainly in web forms when you need more relevant search/autocomplete results.", "properties": { "ip": { "type": "string", "example": "127.0.1.1", "format": "ipv4" }, "country": { "type": "string", "description": "Country code in format [ISO-3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).", "example": "CZ" } } } } } ], "required": [ "query" ] } }, "required": [ "request" ] } } } }, "responses": { "200": { "description": "Successful response", "headers": { "foxentry-api-version": { "$ref": "#/paths/~1company~1get/post/responses/200/headers/foxentry-api-version" }, "foxentry-daily-credits-left": { "$ref": "#/paths/~1company~1get/post/responses/200/headers/foxentry-daily-credits-left" }, "foxentry-daily-credits-limit": { "$ref": "#/paths/~1company~1get/post/responses/200/headers/foxentry-daily-credits-limit" }, "foxentry-rate-limit": { "$ref": "#/paths/~1company~1get/post/responses/200/headers/foxentry-rate-limit" }, "foxentry-rate-limit-period": { "$ref": "#/paths/~1company~1get/post/responses/200/headers/foxentry-rate-limit-period" }, "foxentry-rate-limit-remaining": { "$ref": "#/paths/~1company~1get/post/responses/200/headers/foxentry-rate-limit-remaining" } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status of API response.", "example": 200 }, "request": { "allOf": [ { "type": "object", "properties": { "endpoint": { "example": "location/localize" } } }, { "$ref": "#/paths/~1company~1get/post/responses/200/content/application~1json/schema/properties/request/allOf/1" }, { "$ref": "#/paths/~1location~1localize/post/requestBody/content/application~1json/schema/properties/request/allOf/0" } ] }, "response": { "type": "object", "properties": { "resultsCount": { "type": "number", "description": "Number of results.", "example": 1 }, "results": { "type": "array", "items": { "$ref": "#/paths/~1location~1get/post/responses/200/content/application~1json/schema/properties/response/properties/results/items" } } }, "required": [ "resultsCount", "results" ] }, "errors": { "description": "List of errors related to the request. Should be empty if the request finished successfully.", "type": "array", "items": {}, "maxItems": 0 } }, "required": [ "status", "request", "response" ] }, "examples": { "localizationResults": { "value": { "status": 200, "request": { "endpoint": "location/localize", "code": "5e6e674c-c240-41ef-9344-aa9ed4e49513", "query": { "lat": 50.0919999, "lon": 14.4527403 }, "options": { "dataSource": [ "CZ", "SK", "PL" ], "dataScope": "basic", "resultsLimit": 10, "radius": 50, "acceptNearest": false, "cityFormat": "basic", "zipFormat": false, "countryFormat": "alpha2" } }, "response": { "resultsCount": 5, "results": [ { "data": { "country": "CZ", "state": null, "region": "Hlavní město Praha", "district": "území Hlavního města Prahy", "ids": { "internal": "d2ade877-1e95-4a83-baa6-5431ce5b3ca8", "external": "22349995" }, "street": "Thámova", "number": { "type": "č.p.", "part1": "137", "part1Number": "137", "part1Letter": null, "part2": "16", "part2Number": "16", "part2Letter": null, "full": "137/16" }, "streetWithNumber": "Thámova 137/16", "city": "Praha 8", "zip": "18600", "full": "Thámova 137/16, 18600 Praha 8" } }, { "data": { "country": "CZ", "state": null, "region": "Hlavní město Praha", "district": "území Hlavního města Prahy", "ids": { "internal": "97485ce7-ae19-45b4-8fc6-a3d19406e1b8", "external": "22350489" }, "street": "Thámova", "number": { "type": "č.p.", "part1": "183", "part1Number": "183", "part1Letter": null, "part2": "11", "part2Number": "11", "part2Letter": null, "full": "183/11" }, "streetWithNumber": "Thámova 183/11", "city": "Praha 8", "zip": "18600", "full": "Thámova 183/11, 18600 Praha 8" } }, { "data": { "country": "CZ", "state": null, "region": "Hlavní město Praha", "district": "území Hlavního města Prahy", "ids": { "internal": "078253ba-212b-4767-8176-8eb85f7db3b1", "external": "22349987" }, "street": "Thámova", "number": { "type": "č.p.", "part1": "136", "part1Number": "136", "part1Letter": null, "part2": "8", "part2Number": "8", "part2Letter": null, "full": "136/8" }, "streetWithNumber": "Thámova 136/8", "city": "Praha 8", "zip": "18600", "full": "Thámova 136/8, 18600 Praha 8" } }, { "data": { "country": "CZ", "state": null, "region": "Hlavní město Praha", "district": "území Hlavního města Prahy", "ids": { "internal": "2990893e-c14d-4149-b937-54038c4ebb0f", "external": "22350918" }, "street": "Thámova", "number": { "type": "č.p.", "part1": "221", "part1Number": "221", "part1Letter": null, "part2": "9", "part2Number": "9", "part2Letter": null, "full": "221/9" }, "streetWithNumber": "Thámova 221/9", "city": "Praha 8", "zip": "18600", "full": "Thámova 221/9, 18600 Praha 8" } }, { "data": { "country": "CZ", "state": null, "region": "Hlavní město Praha", "district": "území Hlavního města Prahy", "ids": { "internal": "6e2bb229-d20f-4082-b437-bce6b5d7fe5b", "external": "22350284" }, "street": "Thámova", "number": { "type": "č.p.", "part1": "166", "part1Number": "166", "part1Letter": null, "part2": "18", "part2Number": "18", "part2Letter": null, "full": "166/18" }, "streetWithNumber": "Thámova 166/18", "city": "Praha 8", "zip": "18600", "full": "Thámova 166/18, 18600 Praha 8" } } ] }, "errors": [] } } } } } }, "400": { "$ref": "#/paths/~1company~1get/post/responses/400" }, "401": { "$ref": "#/paths/~1company~1get/post/responses/401" }, "402": { "$ref": "#/paths/~1company~1get/post/responses/402" }, "403": { "$ref": "#/paths/~1company~1get/post/responses/403" }, "404": { "$ref": "#/paths/~1company~1get/post/responses/404" }, "405": { "$ref": "#/paths/~1company~1get/post/responses/405" }, "429": { "$ref": "#/paths/~1company~1get/post/responses/429" }, "500": { "$ref": "#/paths/~1company~1get/post/responses/500" }, "503": { "$ref": "#/paths/~1company~1get/post/responses/503" } }, "security": [ { "BearerAuth": [] } ] } }, "/name/validate": { "post": { "tags": [ "Name" ], "summary": "Validate name data", "description": "Foxentry allows you to check the validity and real existence of names and their combinations. At least one parameter is required in the query. You can either write down the name separately or use nameSurname as connected parameter.

Pay attention to the query options. Especially validationDepth, which determines how strict the validation should be based on your use case. For example you''d want minimal validationDepth for web forms since you usually don''t want to disturb the user too much with error messages and suggestions.

Foxentry validator is able not only to evaluate the validity of the entered 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.", "operationId": "NameValidation", "parameters": [ { "$ref": "#/paths/~1company~1get/post/parameters/0" }, { "$ref": "#/paths/~1company~1get/post/parameters/1" } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "request": { "type": "object", "allOf": [ { "type": "object", "properties": { "customId": { "type": [ "string", "null" ], "description": "Custom ID assigned by you if you need so.", "example": "customer567914" }, "query": { "oneOf": [ { "type": "object", "title": "Separate field for name and surname", "additionalProperties": false, "properties": { "name": { "type": [ "string", "null" ], "description": "First name.", "example": "Petr" }, "surname": { "type": [ "string", "null" ], "description": "Last name / family name.", "example": "Novák" } } }, { "type": "object", "title": "One field for name and surname", "additionalProperties": false, "required": [ "nameSurname" ], "properties": { "nameSurname": { "type": [ "string", "null" ], "description": "Name and surname together.", "example": "Petr Novák" } } } ] }, "options": { "type": "object", "description": "Query options.", "properties": { "dataScope": { "description": "Data scope of returned data. In full datascope information like gender, vocative and date of the name days is returned.", "enum": [ "basic", "full" ], "default": "basic", "example": "full" }, "dataSource": { "description": "Allowed data sources. You can specify the exact data sources that should be used by the validator. This option is not available for the endpoints that do not use any internal databases (e-mails, phone numbers).", "type": "array", "items": { "type": "string", "example": "CZ" }, "default": [ "CZ", "SK" ], "example": [ "CZ", "SK" ] }, "acceptDegrees": { "type": "boolean", "description": "Allow to enter a title directly into the name, surname or nameSurname input. For example \"Ing. Jan Novák\" would be considered as valid/invalid nameSurname", "default": false, "example": false }, "acceptContext": { "type": "boolean", "description": "Allow to insert context directly into name, surname or nameSurname. For example \"Jan Novák ml.\" or \"Jan Novák mladší\" would be considered as valid/invalid nameSurname", "default": false, "example": false }, "correctionMode": { "type": "string", "description": "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.", "enum": [ "full", "format", "suggestion", "none" ], "default": "full", "example": "full" }, "dataLanguage": { "type": "string", "description": "Language in which various salutations and name-related outputs are returned (e.g. vocative forms such as \"pane inženýre\").", "enum": [ "en", "cs", "sk", "pl" ], "default": "cs", "example": "cs" } } }, "client": { "$ref": "#/paths/~1company~1get/post/requestBody/content/application~1json/schema/properties/request/allOf/0/properties/client" } } } ], "required": [ "query" ] } }, "required": [ "request" ] }, "examples": { "Request Example": { "value": { "request": { "query": { "name": "test", "surname": "Ing. Petr Novák ml." }, "options": { "dataScope": "full", "acceptDegrees": true, "acceptContext": false }, "client": { "country": "CZ", "location": { "lat": 50.0628, "lon": 13.9271 } } } } } } } } }, "responses": { "200": { "description": "Successful response", "headers": { "foxentry-api-version": { "$ref": "#/paths/~1company~1get/post/responses/200/headers/foxentry-api-version" }, "foxentry-daily-credits-left": { "$ref": "#/paths/~1company~1get/post/responses/200/headers/foxentry-daily-credits-left" }, "foxentry-daily-credits-limit": { "$ref": "#/paths/~1company~1get/post/responses/200/headers/foxentry-daily-credits-limit" }, "foxentry-rate-limit": { "$ref": "#/paths/~1company~1get/post/responses/200/headers/foxentry-rate-limit" }, "foxentry-rate-limit-period": { "$ref": "#/paths/~1company~1get/post/responses/200/headers/foxentry-rate-limit-period" }, "foxentry-rate-limit-remaining": { "$ref": "#/paths/~1company~1get/post/responses/200/headers/foxentry-rate-limit-remaining" } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status of API response.", "example": 200 }, "request": { "allOf": [ { "type": "object", "properties": { "endpoint": { "example": "name/validate" } } }, { "$ref": "#/paths/~1company~1get/post/responses/200/content/application~1json/schema/properties/request/allOf/1" }, { "$ref": "#/paths/~1name~1validate/post/requestBody/content/application~1json/schema/properties/request/allOf/0" } ] }, "response": { "type": "object", "properties": { "result": { "type": "object", "description": "Evaluation of the sent query.", "properties": { "isValid": { "type": "boolean", "description": "Determines the validity of the response. True = valid response / False = invalid response. Can be also null, which indicates a non-specific error.", "example": false }, "proposal": { "type": "string", "examples": [ "valid", "validWithSuggestion", "invalid", "invalidWithSuggestion", "invalidWithCorrection", "invalidWithCorrectionWithSuggestion", "invalidWithPartialCorrection", "invalidWithPartialCorrectionWithSuggestion" ], "description": "Proposed solution by Foxentry how you should process the response in\nyour form or application.\n\nThe value is composed of three parts: the validity of `result`, the\nvalidity of `resultCorrected` (appending `WithCorrection` or\n`WithPartialCorrection`), and the presence of `suggestions`\n(appending `WithSuggestion`). It is always a string and is never null.\n\nComplete list of possible values:\n\n- `valid`\n- `validWithSuggestion`\n- `invalid`\n- `invalidWithSuggestion`\n- `invalidWithCorrection`\n- `invalidWithCorrectionWithSuggestion`\n- `invalidWithPartialCorrection`\n- `invalidWithPartialCorrectionWithSuggestion`" } }, "allOf": [ { "title": "Name validation result", "type": "object", "properties": { "isValid": { "type": "boolean", "description": "Determines the validity of the response. True = valid response / False = invalid response. Can be also null, which indicates a non-specific error.", "example": true }, "proposal": { "enum": [ "valid", "validWithSuggestion", "invalid", "invalidWithCorrection", "invalidWithPartialCorrection", "invalidWithSuggestion", "invalidWithCorrectionWithSuggestion" ], "description": "Proposed solution by Foxentry how you should process the response in your form or application.", "example": "validWithSuggestion" }, "dataTypes": { "description": "List of data types that were evaluated as valid and invalid. Provides information about which query fields were deemed valid and invalid.", "type": "object", "properties": { "valid": { "type": "array", "items": { "enum": [ "name", "surname", "nameSurname", "context", "degreesBefore", "degreesAfter" ] } }, "invalid": { "type": "array", "items": { "enum": [ "name", "surname", "nameSurname", "context", "degreesBefore", "degreesAfter" ] } } } }, "data": { "type": "object", "properties": { "nameSurname": { "type": [ "string", "null" ], "description": "Name and surname together.", "example": "Petr Novák" }, "name": { "type": [ "string", "null" ], "description": "First name.", "example": "Petr" }, "surname": { "type": [ "string", "null" ], "description": "Last name / family name.", "example": "Novák" }, "context": { "type": "array", "items": { "type": "string", "description": "Context for name and Surname.", "example": "ml." } }, "degreesBefore": { "type": [ "array", "null" ], "items": { "type": "string", "description": "Degrees before name.", "example": "Ing." } }, "degreesAfter": { "type": [ "array", "null" ], "items": { "type": "string", "description": "Degrees after name.", "example": "Ph.D." } }, "vocativeName": { "type": [ "string", "null" ], "description": "Vocative form of first name.", "example": "Petře" }, "vocativeSurname": { "type": [ "string", "null" ], "description": "Vocative form of surname.", "example": "Nováku" }, "vocativeNameSurname": { "type": [ "string", "null" ], "description": "Vocative form of name and surname together.", "example": "Petře Nováku" }, "details": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "name", "surname", "nameSurname" ], "description": "Type of detail.", "example": "name" }, "value": { "type": "string", "description": "Value of detail.", "example": "Petr" }, "gender": { "enum": [ 0, 1, 2 ], "description": "Gender of name. 0 for unspecified, 1 for men, 2 for women", "example": 1 }, "vocative": { "type": "string", "description": "Vocative form of value.", "example": "Petře" }, "nameDays": { "type": [ "array", "null" ], "description": "Date of the name day. Currently works only for czech and slovak names.", "items": { "type": "object", "properties": { "country": { "type": "string", "description": "Country code in format [ISO-3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).", "example": "CZ" }, "month": { "type": "number", "description": "Month number for name day.", "example": 6 }, "day": { "type": "number", "description": "Day number for name day.", "example": 29 } }, "required": [ "country", "month", "day" ] } } }, "required": [ "type", "value" ] } } }, "required": [ "nameSurname", "name", "surname", "context", "degreesBefore", "degreesAfter" ] }, "errors": { "description": "List of errors related to the query. Provides information about which query fields were deemed invalid and why.", "type": "array", "items": { "anyOf": [ { "title": "Generic syntax error", "type": "object", "properties": { "group": { "enum": [ "SYNTAX" ], "description": "Group of error.", "example": "SYNTAX" }, "type": { "enum": [ "CHARACTERS", "INVALID", "UNABLE_TO_PROCESS", "VALUE_LENGTH", "VALUE_PART_EXTRA", "VALUE_PART_MISSING" ], "description": "Type of error.", "example": "CHARACTERS" }, "subtype": { "enum": [ "NOT_ALLOWED", "WHITESPACES", "TOO_LONG", "TOO_SHORT", "CONTEXT" ], "description": "Subtype of error.", "example": "NOT_ALLOWED" }, "severity": { "enum": [ "info", "warning", "critical" ], "description": "Severity of error. Info = cosmetic changes that don't change the overall meaning. Warning = typos and other errors that could affect the meaning. Critical = critical errors.", "example": "critical" }, "relatedTo": { "description": "List of the affected inputs.", "type": "array", "items": { "type": "string", "description": "Error related to.", "example": "numberWithPrefix" } }, "description": { "type": [ "string", "null" ], "description": "Description of error.", "example": "Disallowed characters were used in the value." } } }, { "title": "Name specific syntax error", "type": "object", "properties": { "group": { "enum": [ "SYNTAX" ], "description": "Group of error.", "example": "SYNTAX" }, "type": { "enum": [ "VALUE_PART_MISSING", "VALUE_PART_POSITION" ], "description": "Type of error.", "example": "VALUE_PART_MISSING" }, "subtype": { "enum": [ "NAME", "SURNAME", "DEGREE" ], "description": "Subtype of error.", "example": "NAME" }, "severity": { "enum": [ "info", "warning", "critical" ], "description": "Severity of error. Info = cosmetic changes that don't change the overall meaning. Warning = typos and other errors that could affect the meaning. Critical = critical errors.", "example": "critical" }, "relatedTo": { "description": "List of the affected inputs.", "type": "array", "items": { "type": "string", "description": "Error related to.", "example": "name" } }, "description": { "type": [ "string", "null" ], "description": "Description of error.", "example": "Value is missing the name part." } } }, { "title": "Generic format error", "type": "object", "properties": { "group": { "enum": [ "FORMAT" ], "description": "Group of error.", "example": "FORMAT" }, "type": { "enum": [ "CHARACTERS", "INVALID" ], "description": "Type of error.", "example": "CHARACTERS" }, "subtype": { "enum": [ "CASE_SENSITIVITY", "DIACRITICS", "SPECIAL", "WHITESPACES", null ], "description": "Subtype of error.", "example": "CASE_SENSITIVITY" }, "severity": { "enum": [ "info", "warning", "critical" ], "description": "Severity of error. Info = cosmetic changes that don't change the overall meaning. Warning = typos and other errors that could affect the meaning. Critical = critical errors.", "example": "critical" }, "relatedTo": { "description": "List of the affected inputs.", "type": "array", "items": { "type": "string", "description": "Error related to.", "example": "numberWithPrefix" } }, "description": { "type": [ "string", "null" ], "description": "Description of error.", "example": "Invalid case sensitivity. Specific rules are applied to the use of upper and lower case letters." } } }, { "title": "Generic value error", "type": "object", "properties": { "group": { "enum": [ "VALUE" ], "description": "Group of error.", "example": "VALUE" }, "type": { "enum": [ "EMPTY", "INCORRECT_ORDER", "INVALID", "INVALID_COMBINATION", "NOT_ALLOWED" ], "description": "Type of error.", "example": "EMPTY" }, "subtype": { "enum": [ null ], "description": "Subtype of error." }, "severity": { "enum": [ "info", "warning", "critical" ], "description": "Severity of error. Info = cosmetic changes that don't change the overall meaning. Warning = typos and other errors that could affect the meaning. Critical = critical errors.", "example": "critical" }, "relatedTo": { "description": "List of the affected inputs.", "type": "array", "items": { "type": "string", "description": "Error related to.", "example": "numberWithPrefix" } }, "description": { "type": [ "string", "null" ], "description": "Description of error.", "example": "Value is empty." } } }, { "title": "Name specific value error", "type": "object", "properties": { "group": { "enum": [ "VALUE" ], "description": "Group of error.", "example": "VALUE" }, "type": { "enum": [ "INVALID", "NOT_ALLOWED" ], "description": "Type of error.", "example": "INVALID" }, "subtype": { "enum": [ "DEGREE", "NAME", "NAMESURNAME", "SURNAME", "CONTEXT" ], "description": "Subtype of error.", "example": "DEGREE" }, "severity": { "enum": [ "info", "warning", "critical" ], "description": "Severity of error. Info = cosmetic changes that don't change the overall meaning. Warning = typos and other errors that could affect the meaning. Critical = critical errors.", "example": "critical" }, "relatedTo": { "description": "List of the affected inputs.", "type": "array", "items": { "type": "string", "description": "Error related to.", "example": "name" } }, "description": { "type": [ "string", "null" ], "description": "Description of error.", "example": "Degree value is invalid." } } } ] } } }, "required": [ "isValid", "data" ] } ], "required": [ "isValid", "proposal", "data" ] }, "resultCorrected": { "oneOf": [ { "$ref": "#/paths/~1name~1validate/post/responses/200/content/application~1json/schema/properties/response/properties/suggestions/items" }, { "type": "null", "title": "No data" } ] }, "suggestions": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/paths/~1name~1validate/post/responses/200/content/application~1json/schema/properties/response/properties/result/allOf/0" }, { "type": "object", "properties": { "fixes": { "type": "array", "description": "List of all changes applied to the query data in order to get the suggested result.", "items": { "anyOf": [ { "title": "Generic format fix", "type": "object", "properties": { "group": { "enum": [ "FORMAT", "VALUE" ], "description": "Group of fix.", "example": "FORMAT" }, "type": { "enum": [ "CHANGED" ], "description": "Type of fix.", "example": "CHANGED" }, "subtype": { "enum": [ "CASE_SENSITIVITY", "DIACRITICS", "WHITESPACES", "TYPO", null ], "description": "Subtype of fix.", "example": "CASE_SENSITIVITY" }, "data": { "title": "Generic data fix", "type": "object", "description": "Data that has been changed", "properties": { "typeFrom": { "type": "string", "description": "Original type of changed value", "example": "email" }, "type": { "type": "string", "description": "New type of value", "example": "email" }, "valueFrom": { "type": "string", "description": "Original value", "example": "me@gmail.cz" }, "value": { "type": "string", "description": "Changed value", "example": "me@gmail.com" } } } } }, { "title": "Generic syntax fix", "type": "object", "properties": { "group": { "enum": [ "SYNTAX" ], "description": "Group of fix.", "example": "SYNTAX" }, "type": { "enum": [ "VALUE_CHANGED", "VALUE_PART_CHANGED", "VALUE_PART_REMOVED" ], "description": "Type of fix.", "example": "VALUE_CHANGED" }, "subtype": { "enum": [ "CHARACTERS", "WHITESPACES", "CONTEXT", "DUPLICITY", null ], "description": "Subtype of fix.", "example": "CHARACTERS" }, "data": { "$ref": "#/paths/~1name~1validate/post/responses/200/content/application~1json/schema/properties/response/properties/suggestions/items/allOf/1/properties/fixes/items/anyOf/0/properties/data" } } }, { "title": "Generic value fix", "type": "object", "properties": { "group": { "enum": [ "VALUE" ], "description": "Group of fix.", "example": "VALUE" }, "type": { "enum": [ "ADDED", "CHANGED", "PART_CHANGED", "REMOVED" ], "description": "Type of fix.", "example": "ADDED" }, "subtype": { "enum": [ "INTERNAL_RULE", "TYPO", null ], "description": "Subtype of error.", "example": "INTERNAL_RULE" }, "data": { "$ref": "#/paths/~1name~1validate/post/responses/200/content/application~1json/schema/properties/response/properties/suggestions/items/allOf/1/properties/fixes/items/anyOf/0/properties/data" } } } ] } } } } ], "required": [ "isValid", "data", "fixes" ] } } }, "required": [ "result", "suggestions" ] }, "errors": { "description": "List of errors related to the request. Should be empty if the request finished successfully.", "type": "array", "items": {}, "maxItems": 0 } }, "required": [ "status", "request", "response", "errors" ] }, "examples": { "valid": { "value": { "status": 200, "request": { "endpoint": "name/validate", "code": "b644895c-4563-4262-8c4a-3734e6310d02", "query": { "name": "Pavel" }, "options": { "dataSource": [ "CZ", "SK" ], "dataScope": "basic", "acceptDegrees": false, "acceptContext": false, "dataLanguage": "cs", "correctionMode": "full" } }, "response": { "result": { "isValid": true, "proposal": "valid", "dataTypes": { "valid": [ "name" ], "invalid": [] }, "data": { "name": "Pavel", "surname": "", "nameSurname": "Pavel", "context": [], "degreesBefore": [], "degreesAfter": [] }, "errors": [] }, "resultCorrected": null, "suggestions": [] }, "errors": [] } }, "invalid": { "value": { "status": 200, "request": { "endpoint": "name/validate", "code": "77afb165-f2f0-42cb-9b40-28427decf742", "query": { "name": "Paeeewas" }, "options": { "dataSource": [ "CZ", "SK" ], "dataScope": "basic", "acceptDegrees": false, "acceptContext": false, "dataLanguage": "cs", "correctionMode": "full" } }, "response": { "result": { "isValid": false, "proposal": "invalid", "dataTypes": { "valid": [], "invalid": [ "name" ] }, "data": { "name": "Paeeewas", "surname": null, "nameSurname": null, "context": [], "degreesBefore": [], "degreesAfter": [] }, "errors": [ { "group": "VALUE", "type": "INVALID", "subtype": null, "severity": "critical", "relatedTo": [ "name" ], "description": "Value is not valid." } ] }, "resultCorrected": null, "suggestions": [] }, "errors": [] } }, "invalidWithCorrection": { "value": { "status": 200, "request": { "endpoint": "name/validate", "code": "def3350c-6ba9-4c3d-98c3-87cfb9ee3aaa", "query": { "name": "Palve" }, "options": { "dataSource": [ "CZ", "SK" ], "dataScope": "basic", "acceptDegrees": false, "acceptContext": false, "dataLanguage": "cs", "correctionMode": "full" } }, "response": { "result": { "isValid": false, "proposal": "invalid", "dataTypes": { "valid": [], "invalid": [ "name" ] }, "data": { "name": "Palve", "surname": null, "nameSurname": null, "context": [], "degreesBefore": [], "degreesAfter": [] }, "errors": [ { "group": "VALUE", "type": "INVALID", "subtype": null, "severity": "critical", "relatedTo": [ "name" ], "description": "Value is not valid." } ] }, "resultCorrected": null, "suggestions": [] }, "errors": [] } }, "validWithSuggestion": { "value": { "status": 200, "request": { "endpoint": "name/validate", "code": "6f11ee18-9b8c-4a2b-ac7d-2d4b5883bae4", "query": { "name": "Pawel" }, "options": { "dataSource": [ "CZ", "SK" ], "dataScope": "basic", "acceptDegrees": false, "acceptContext": false, "dataLanguage": "cs", "correctionMode": "full" } }, "response": { "result": { "isValid": true, "proposal": "validWithSuggestion", "dataTypes": { "valid": [ "name" ], "invalid": [] }, "data": { "name": "Pawel", "surname": "", "nameSurname": "Pawel", "context": [], "degreesBefore": [], "degreesAfter": [] }, "errors": [] }, "resultCorrected": null, "suggestions": [ { "isValid": true, "dataTypes": { "valid": [ "name" ], "invalid": [] }, "data": { "name": "Pavel", "surname": null, "nameSurname": "Pavel", "context": [], "degreesBefore": [], "degreesAfter": [] }, "errors": [], "fixes": [ { "group": "VALUE", "type": "CHANGED", "subtype": null, "data": { "typeFrom": "name", "type": "name", "valueFrom": "Pawel", "value": "Pavel" } } ] } ] }, "errors": [] } }, "validNameSurnameFullDataScope": { "value": { "status": 200, "request": { "endpoint": "name/validate", "code": "5a0c8d02-0acd-4b06-a461-7c4dba0cd85b", "query": { "nameSurname": "Pavel Novák" }, "options": { "dataSource": [ "CZ", "SK" ], "dataScope": "full", "acceptDegrees": false, "acceptContext": false, "dataLanguage": "cs", "correctionMode": "full" } }, "response": { "result": { "isValid": true, "proposal": "valid", "dataTypes": { "valid": [ "name", "surname", "nameSurname" ], "invalid": [] }, "data": { "name": "Pavel", "surname": "Novák", "nameSurname": "Pavel Novák", "context": [], "degreesBefore": [], "degreesAfter": [], "vocativeName": "Pavle", "vocativeSurname": "Nováku", "vocativeNameSurname": "Pavle Nováku", "details": [ { "type": "name", "value": "Pavel", "gender": 1, "vocative": "Pavle", "nameDays": [ { "country": "CZ", "day": 29, "month": 6 } ] }, { "type": "surname", "value": "Novák", "gender": 1, "vocative": "Nováku" }, { "type": "nameSurname", "value": "Pavel Novák", "gender": 1, "vocative": "Pavle Nováku" } ] }, "errors": [] }, "resultCorrected": null, "suggestions": [] }, "errors": [] } }, "fullDataScope": { "value": { "status": 200, "request": { "endpoint": "name/validate", "code": "3fd9055f-5267-4bf1-a132-343b8b0a8838", "query": { "name": "Pavel" }, "options": { "dataSource": [ "CZ", "SK" ], "dataScope": "full", "acceptDegrees": false, "acceptContext": false, "dataLanguage": "cs", "correctionMode": "full" } }, "response": { "result": { "isValid": true, "proposal": "valid", "dataTypes": { "valid": [ "name" ], "invalid": [] }, "data": { "name": "Pavel", "surname": "", "nameSurname": "Pavel", "context": [], "degreesBefore": [], "degreesAfter": [], "vocativeName": "Pavle", "vocativeSurname": null, "vocativeNameSurname": "Pavle", "details": [ { "type": "name", "value": "Pavel", "gender": 1, "vocative": "Pavle", "nameDays": [ { "country": "CZ", "day": 29, "month": 6 } ] }, { "type": "nameSurname", "value": "Pavel", "gender": 1, "vocative": "Pavle" } ] }, "errors": [] }, "resultCorrected": null, "suggestions": [] }, "errors": [] } } } } } }, "400": { "$ref": "#/paths/~1company~1get/post/responses/400" }, "401": { "$ref": "#/paths/~1company~1get/post/responses/401" }, "402": { "$ref": "#/paths/~1company~1get/post/responses/402" }, "403": { "$ref": "#/paths/~1company~1get/post/responses/403" }, "404": { "$ref": "#/paths/~1company~1get/post/responses/404" }, "405": { "$ref": "#/paths/~1company~1get/post/responses/405" }, "429": { "$ref": "#/paths/~1company~1get/post/responses/429" }, "500": { "$ref": "#/paths/~1company~1get/post/responses/500" }, "503": { "$ref": "#/paths/~1company~1get/post/responses/503" } }, "security": [ { "BearerAuth": [] } ] } }, "/phone/validate": { "post": { "tags": [ "Phone" ], "summary": "Validate phone number", "description": "Foxentry allows you to check validity and the existence of phone numbers. It can also give you additional information about the validated phone number based on the validationType option.

Please pay attention to the formatNumber option. This option defines the format of number that should be considered as valid.

Foxentry validator is able not only to evaluate the validity of the entered 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.", "operationId": "PhoneValidation", "parameters": [ { "$ref": "#/paths/~1company~1get/post/parameters/0" }, { "$ref": "#/paths/~1company~1get/post/parameters/1" } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "request": { "type": "object", "allOf": [ { "type": "object", "properties": { "customId": { "type": [ "string", "null" ], "description": "Custom ID assigned by you if you need so.", "example": "customer567914" }, "query": { "oneOf": [ { "type": "object", "required": [ "prefix", "number" ], "title": "Separate fields for number and prefix", "properties": { "prefix": { "type": "string", "description": "Phone number prefix.", "example": "+420" }, "number": { "type": "string", "description": "Phone number.", "example": "607123456" } } }, { "type": "object", "required": [ "numberFull" ], "title": "One field for number with prefix.", "properties": { "numberFull": { "type": "string", "description": "Phone number with prefix.", "example": "+420775111222" } } } ] }, "options": { "type": "object", "description": "Query options.", "properties": { "validationType": { "enum": [ "basic", "extended" ], "description": "Type of validation.", "default": "basic", "example": "extended" }, "allowedPrefixes": { "type": "array", "description": "List of allowed prefixes.", "items": { "type": "string", "example": "+420" } }, "preferredPrefixes": { "type": "array", "description": "Ordered list of preferred prefixes. If phone number is valid with multiple prefixes, the resultCorrected will use the first valid prefix from this list. If not set, the resultCorrected will be null and there will be all valid combinations in the suggestions.", "items": { "type": "string", "example": "+420" }, "default": [], "example": [ "+420", "+421" ] }, "numberFormat": { "type": "string", "description": "Determines the format of the phone number output. raw = number as entered, national = national format without prefix (607 123 456), e123 = international format with spaces (+420 607 123 456), e164 = international format without spaces (+420607123456).", "enum": [ "raw", "national", "e123", "e164" ], "default": "e164", "example": "e164" }, "correctionMode": { "description": "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.", "type": "string", "enum": [ "full", "format", "suggestion", "none" ], "default": "full", "example": "full" } } }, "client": { "$ref": "#/paths/~1company~1get/post/requestBody/content/application~1json/schema/properties/request/allOf/0/properties/client" } } } ], "required": [ "query" ] } }, "required": [ "request" ] }, "examples": { "Request Example": { "value": { "request": { "query": { "numberFull": "+420775111222" }, "options": { "validationType": "extended", "allowedPrefixes": [ "+420", "+421" ], "numberFormat": "e164" }, "client": { "country": "CZ", "location": { "lat": 50.0628, "lon": 13.9271 } } } } } } } } }, "responses": { "200": { "description": "Successful response", "headers": { "foxentry-api-version": { "$ref": "#/paths/~1company~1get/post/responses/200/headers/foxentry-api-version" }, "foxentry-daily-credits-left": { "$ref": "#/paths/~1company~1get/post/responses/200/headers/foxentry-daily-credits-left" }, "foxentry-daily-credits-limit": { "$ref": "#/paths/~1company~1get/post/responses/200/headers/foxentry-daily-credits-limit" }, "foxentry-rate-limit": { "$ref": "#/paths/~1company~1get/post/responses/200/headers/foxentry-rate-limit" }, "foxentry-rate-limit-period": { "$ref": "#/paths/~1company~1get/post/responses/200/headers/foxentry-rate-limit-period" }, "foxentry-rate-limit-remaining": { "$ref": "#/paths/~1company~1get/post/responses/200/headers/foxentry-rate-limit-remaining" } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status of API response.", "example": 200 }, "request": { "allOf": [ { "type": "object", "properties": { "endpoint": { "example": "phone/validate" } } }, { "$ref": "#/paths/~1company~1get/post/responses/200/content/application~1json/schema/properties/request/allOf/1" }, { "$ref": "#/paths/~1phone~1validate/post/requestBody/content/application~1json/schema/properties/request/allOf/0" } ] }, "response": { "type": "object", "properties": { "result": { "type": "object", "description": "Evaluation of the sent query.", "properties": { "isValid": { "type": "boolean", "description": "Determines the validity of the response. True = valid response / False = invalid response. Can be also null, which indicates a non-specific error.", "example": false }, "proposal": { "type": "string", "examples": [ "valid", "validWithSuggestion", "invalid", "invalidWithSuggestion", "invalidWithCorrection", "invalidWithCorrectionWithSuggestion", "invalidWithPartialCorrection", "invalidWithPartialCorrectionWithSuggestion" ], "description": "Proposed solution by Foxentry how you should process the response in\nyour form or application.\n\nThe value is composed of three parts: the validity of `result`, the\nvalidity of `resultCorrected` (appending `WithCorrection` or\n`WithPartialCorrection`), and the presence of `suggestions`\n(appending `WithSuggestion`). It is always a string and is never null.\n\nComplete list of possible values:\n\n- `valid`\n- `validWithSuggestion`\n- `invalid`\n- `invalidWithSuggestion`\n- `invalidWithCorrection`\n- `invalidWithCorrectionWithSuggestion`\n- `invalidWithPartialCorrection`\n- `invalidWithPartialCorrectionWithSuggestion`" } }, "allOf": [ { "title": "Phone validation result", "type": "object", "properties": { "isValid": { "type": "boolean", "description": "Determines the validity of the response. True = valid response / False = invalid response. Can be also null, which indicates a non-specific error.", "example": true }, "data": { "type": "object", "properties": { "country": { "type": "object", "properties": { "code": { "type": [ "string", "null" ], "description": "Country code in format [ISO-3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).", "example": "CZ" }, "prefix": { "type": [ "string", "null" ], "description": "Country phone prefix.", "example": "+420" } } }, "prefix": { "type": [ "string", "null" ], "description": "Country phone prefix.", "example": "+420" }, "number": { "type": [ "string", "null" ], "description": "Validated phone number.", "example": "775111222" }, "numberFull": { "type": [ "string", "null" ], "description": "Validated phone number with prefix.", "example": "+420775111222" }, "carrier": { "type": "object", "description": "Phone carrier information.", "properties": { "name": { "type": [ "string", "null" ], "description": "Name of carrier.", "example": "Vodafone" }, "type": { "type": [ "string", "null" ], "description": "Type of carrier.", "example": "landline", "enum": [ "landline", "mobile", "voip", null ] } } }, "format": { "type": "object", "description": "Standardized international and local format.", "properties": { "raw": { "type": [ "string", "null" ], "description": "National phone number format.", "example": "775111222" }, "national": { "type": [ "string", "null" ], "description": "Formated national phone number.", "example": "775 111 222" }, "e164": { "type": [ "string", "null" ], "description": "International phone number format.", "example": "+420775111222" }, "e123": { "type": [ "string", "null" ], "description": "Formated international phone number.", "example": "+420 775 111 222" } } } }, "required": [ "country", "number", "numberFull", "carrier", "format" ] }, "errors": { "type": "array", "description": "List of errors related to the query. Provides information about which query fields were deemed invalid and why.", "items": { "anyOf": [ { "$ref": "#/paths/~1name~1validate/post/responses/200/content/application~1json/schema/properties/response/properties/result/allOf/0/properties/errors/items/anyOf/0" }, { "title": "Phone specific syntax error", "type": "object", "properties": { "group": { "enum": [ "SYNTAX" ], "description": "Group of error.", "example": "SYNTAX" }, "type": { "enum": [ "VALUE_PART_EXTRA", "VALUE_PART_MISSING" ], "description": "Type of error.", "example": "VALUE_PART_EXTRA" }, "subtype": { "enum": [ "PLUS_SIGN", "NUMBER", "PREFIX" ], "description": "Subtype of error.", "example": "PLUS_SIGN" }, "severity": { "enum": [ "info", "warning", "critical" ], "description": "Severity of error. Info = cosmetic changes that don't change the overall meaning. Warning = typos and other errors that could affect the meaning. Critical = critical errors.", "example": "critical" }, "relatedTo": { "description": "List of the affected inputs.", "type": "array", "items": { "type": "string", "description": "Error related to.", "example": "numberWithPrefix" } }, "description": { "type": [ "string", "null" ], "description": "Description of error.", "example": "Value contains duplicated '+' sign." } } }, { "$ref": "#/paths/~1name~1validate/post/responses/200/content/application~1json/schema/properties/response/properties/result/allOf/0/properties/errors/items/anyOf/2" }, { "$ref": "#/paths/~1name~1validate/post/responses/200/content/application~1json/schema/properties/response/properties/result/allOf/0/properties/errors/items/anyOf/3" }, { "title": "Phone specific value error", "type": "object", "properties": { "group": { "enum": [ "VALUE" ], "description": "Group of error.", "example": "VALUE" }, "type": { "enum": [ "INVALID", "NOT_ALLOWED" ], "description": "Type of error.", "example": "INVALID" }, "subtype": { "enum": [ "PREFIX" ], "description": "Subtype of error.", "example": "PREFIX" }, "severity": { "enum": [ "info", "warning", "critical" ], "description": "Severity of error. Info = cosmetic changes that don't change the overall meaning. Warning = typos and other errors that could affect the meaning. Critical = critical errors.", "example": "critical" }, "relatedTo": { "description": "List of the affected inputs.", "type": "array", "items": { "type": "string", "description": "Error related to.", "example": "numberWithPrefix" } }, "description": { "type": [ "string", "null" ], "description": "Description of error.", "example": "Prefix is invalid." } } } ] } } } } ], "required": [ "isValid", "proposal", "data", "errors" ] }, "resultCorrected": { "oneOf": [ { "$ref": "#/paths/~1phone~1validate/post/responses/200/content/application~1json/schema/properties/response/properties/suggestions/items" }, { "type": "null", "title": "No data" } ] }, "suggestions": { "type": "array", "description": "Alternatives suggested for the sent query.", "items": { "type": "object", "allOf": [ { "$ref": "#/paths/~1phone~1validate/post/responses/200/content/application~1json/schema/properties/response/properties/result/allOf/0" }, { "type": "object", "properties": { "fixes": { "type": "array", "description": "List of all changes applied to the query data in order to get the suggested result.", "items": { "anyOf": [ { "$ref": "#/paths/~1name~1validate/post/responses/200/content/application~1json/schema/properties/response/properties/suggestions/items/allOf/1/properties/fixes/items/anyOf/0" }, { "$ref": "#/paths/~1name~1validate/post/responses/200/content/application~1json/schema/properties/response/properties/suggestions/items/allOf/1/properties/fixes/items/anyOf/1" }, { "title": "Phone specific syntax fix", "type": "object", "properties": { "group": { "enum": [ "SYNTAX" ], "description": "Group of fix.", "example": "SYNTAX" }, "type": { "enum": [ "VALUE_PART_ADDED", "VALUE_PART_CHANGED", "VALUE_PART_REMOVED" ], "description": "Type of fix.", "example": "VALUE_PART_ADDED" }, "subtype": { "enum": [ "PLUS_SIGN", "PREFIX" ], "description": "Subtype of error.", "example": "PLUS_SIGN" }, "data": { "$ref": "#/paths/~1name~1validate/post/responses/200/content/application~1json/schema/properties/response/properties/suggestions/items/allOf/1/properties/fixes/items/anyOf/0/properties/data" } } }, { "$ref": "#/paths/~1name~1validate/post/responses/200/content/application~1json/schema/properties/response/properties/suggestions/items/allOf/1/properties/fixes/items/anyOf/2" } ] } } } } ] } } }, "required": [ "result", "suggestions" ] }, "errors": { "description": "List of errors related to the request. Should be empty if the request finished successfully.", "type": "array", "items": {}, "maxItems": 0 } }, "required": [ "status", "request", "response" ] }, "examples": { "valid": { "value": { "status": 200, "request": { "endpoint": "phone/validate", "code": "4bf1d035-06fb-4d8c-aea3-13406c4f71a8", "query": { "numberFull": "+420607123456" }, "options": { "validationType": "basic", "allowedPrefixes": [], "preferredPrefixes": [], "numberFormat": "e164", "correctionMode": "full" } }, "response": { "result": { "isValid": true, "proposal": "valid", "data": { "country": { "code": "CZ", "prefix": "+420" }, "prefix": "+420", "number": "607123456", "numberFull": "+420607123456", "carrier": {}, "format": { "raw": "607123456", "national": "607 123 456", "e164": "+420607123456", "e123": "+420 607 123 456" } }, "errors": [] }, "resultCorrected": null, "suggestions": [] }, "errors": [] } }, "invalid": { "value": { "status": 200, "request": { "endpoint": "phone/validate", "code": "096375c2-fdbe-4500-84db-ddb492c98e84", "query": { "numberFull": "+42060712345" }, "options": { "validationType": "basic", "allowedPrefixes": [], "preferredPrefixes": [], "numberFormat": "e164", "correctionMode": "full" } }, "response": { "result": { "isValid": false, "proposal": "invalid", "data": { "country": { "code": null, "prefix": null }, "prefix": null, "number": null, "numberFull": "+42060712345", "carrier": {}, "format": { "raw": null, "national": null, "e164": null, "e123": null } }, "errors": [ { "group": "VALUE", "type": "INVALID", "subtype": null, "severity": "critical", "relatedTo": [ "numberFull" ], "description": "Value is not valid." } ] }, "resultCorrected": null, "suggestions": [] }, "errors": [] } }, "invalidWithCorrection": { "value": { "status": 200, "request": { "endpoint": "phone/validate", "code": "1c2d30b8-2b52-4241-a86f-8a3608683cb6", "query": { "numberFull": "+421607123456" }, "options": { "validationType": "basic", "allowedPrefixes": [], "preferredPrefixes": [], "numberFormat": "e164", "correctionMode": "full" } }, "response": { "result": { "isValid": false, "proposal": "invalid", "data": { "country": { "code": null, "prefix": null }, "prefix": null, "number": null, "numberFull": "+421607123456", "carrier": {}, "format": { "raw": null, "national": null, "e164": null, "e123": null } }, "errors": [ { "group": "VALUE", "type": "INVALID", "subtype": null, "severity": "critical", "relatedTo": [ "numberFull" ], "description": "Value is not valid." } ] }, "resultCorrected": null, "suggestions": [] }, "errors": [] } }, "validWithSuggestion": { "value": { "status": 200, "request": { "endpoint": "phone/validate", "code": "367f0c00-ec92-442a-9692-720b34b4ff18", "query": { "numberFull": "+48728984101" }, "options": { "validationType": "basic", "allowedPrefixes": [], "preferredPrefixes": [], "numberFormat": "e164", "correctionMode": "full" } }, "response": { "result": { "isValid": true, "proposal": "valid", "data": { "country": { "code": "PL", "prefix": "+48" }, "prefix": "+48", "number": "728984101", "numberFull": "+48728984101", "carrier": {}, "format": { "raw": "728984101", "national": "728 984 101", "e164": "+48728984101", "e123": "+48 728 984 101" } }, "errors": [] }, "resultCorrected": null, "suggestions": [] }, "errors": [] } } } } } }, "400": { "$ref": "#/paths/~1company~1get/post/responses/400" }, "401": { "$ref": "#/paths/~1company~1get/post/responses/401" }, "402": { "$ref": "#/paths/~1company~1get/post/responses/402" }, "403": { "$ref": "#/paths/~1company~1get/post/responses/403" }, "404": { "$ref": "#/paths/~1company~1get/post/responses/404" }, "405": { "$ref": "#/paths/~1company~1get/post/responses/405" }, "429": { "$ref": "#/paths/~1company~1get/post/responses/429" }, "500": { "$ref": "#/paths/~1company~1get/post/responses/500" }, "503": { "$ref": "#/paths/~1company~1get/post/responses/503" } }, "security": [ { "BearerAuth": [] } ] } }, "/phone/search": { "post": { "tags": [ "Phone" ], "summary": "Search phone prefix", "description": "Foxentry will list all phone prefixes matching your query. This can be used to implement a simple autocomplete.

Pay attention to the client section in the request body. You can specify the user's location in order to receive more relevant suggestions.", "operationId": "PhoneSearch", "parameters": [ { "$ref": "#/paths/~1company~1get/post/parameters/0" }, { "$ref": "#/paths/~1company~1get/post/parameters/1" } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "request": { "type": "object", "allOf": [ { "type": "object", "properties": { "customId": { "type": [ "string", "null" ], "description": "Custom ID assigned by you if you need so.", "example": "customer567914" }, "query": { "type": "object", "properties": { "value": { "type": "string", "example": "+42" } }, "required": [ "value" ] }, "options": { "type": "object", "description": "Query options.", "properties": { "resultsLimit": { "type": "number", "description": "Limits number of results returned by the endpoint.", "minimum": 1, "maximum": 100, "example": 5 }, "allowedPrefixes": { "type": "array", "description": "List of allowed prefixes. If not provided, all prefixes are allowed.", "items": { "type": "string", "example": "+420" } } } }, "client": { "$ref": "#/paths/~1company~1get/post/requestBody/content/application~1json/schema/properties/request/allOf/0/properties/client" } } } ], "required": [ "query" ] } }, "required": [ "request" ] }, "examples": { "Request Example": { "value": { "request": { "query": { "value": "+42" }, "options": { "resultsLimit": 5 }, "client": { "country": "CZ", "location": { "lat": 50.0628, "lon": 13.9271 } } } } } } } } }, "responses": { "200": { "description": "Successful response", "headers": { "foxentry-api-version": { "$ref": "#/paths/~1company~1get/post/responses/200/headers/foxentry-api-version" }, "foxentry-daily-credits-left": { "$ref": "#/paths/~1company~1get/post/responses/200/headers/foxentry-daily-credits-left" }, "foxentry-daily-credits-limit": { "$ref": "#/paths/~1company~1get/post/responses/200/headers/foxentry-daily-credits-limit" }, "foxentry-rate-limit": { "$ref": "#/paths/~1company~1get/post/responses/200/headers/foxentry-rate-limit" }, "foxentry-rate-limit-period": { "$ref": "#/paths/~1company~1get/post/responses/200/headers/foxentry-rate-limit-period" }, "foxentry-rate-limit-remaining": { "$ref": "#/paths/~1company~1get/post/responses/200/headers/foxentry-rate-limit-remaining" } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status of API response.", "example": 200 }, "request": { "allOf": [ { "type": "object", "properties": { "endpoint": { "example": "phone/search" } } }, { "$ref": "#/paths/~1company~1get/post/responses/200/content/application~1json/schema/properties/request/allOf/1" }, { "$ref": "#/paths/~1phone~1search/post/requestBody/content/application~1json/schema/properties/request/allOf/0" } ] }, "response": { "type": "object", "properties": { "resultsCount": { "type": "number", "description": "Number of results", "minimum": 1, "maximum": 5, "example": 1 }, "results": { "type": "array", "items": { "type": "object", "properties": { "data": { "type": "object", "properties": { "country": { "type": "string", "example": "CZ" }, "prefix": { "type": "string", "example": "+420" }, "icon": { "type": "string", "example": "https://cdn.foxentry.com/svg/flags/cz.svg" } }, "required": [ "country", "prefix", "icon" ] } }, "required": [ "data" ] } } }, "required": [ "resultsCount", "results" ] }, "errors": { "description": "List of errors related to the request. Should be empty if the request finished successfully.", "type": "array", "items": {}, "maxItems": 0 } }, "required": [ "status", "request" ] }, "examples": { "searchResults": { "value": { "status": 200, "request": { "endpoint": "phone/search", "code": "26308e4d-0c47-4278-8185-687f0a110f61", "query": { "value": "+42" }, "options": { "resultsLimit": 100, "allowedPrefixes": [] } }, "response": { "resultsCount": 3, "results": [ { "data": { "country": "CZ", "prefix": "+420", "icon": "https://cdn.foxentry.com/svg/flags/cz.svg" } }, { "data": { "country": "SK", "prefix": "+421", "icon": "https://cdn.foxentry.com/svg/flags/sk.svg" } }, { "data": { "country": "LI", "prefix": "+423", "icon": "https://cdn.foxentry.com/svg/flags/li.svg" } } ] }, "errors": [] } } } } } }, "400": { "$ref": "#/paths/~1company~1get/post/responses/400" }, "401": { "$ref": "#/paths/~1company~1get/post/responses/401" }, "402": { "$ref": "#/paths/~1company~1get/post/responses/402" }, "403": { "$ref": "#/paths/~1company~1get/post/responses/403" }, "404": { "$ref": "#/paths/~1company~1get/post/responses/404" }, "405": { "$ref": "#/paths/~1company~1get/post/responses/405" }, "429": { "$ref": "#/paths/~1company~1get/post/responses/429" }, "500": { "$ref": "#/paths/~1company~1get/post/responses/500" }, "503": { "$ref": "#/paths/~1company~1get/post/responses/503" } }, "security": [ { "BearerAuth": [] } ] } } }, "tags": [ { "name": "Company", "description": "Company operations" }, { "name": "Email", "description": "Email operations" }, { "name": "Location", "description": "Location operations" }, { "name": "Name", "description": "Names operations" }, { "name": "Phone", "description": "Phone operations" } ], "components": { "securitySchemes": { "BearerAuth": { "type": "http", "description": "Bearer token formatted API key. You can obtain the API key after the sign up at app.foxentry.com/registration.", "scheme": "bearer" } } }, "security": [ { "BearerAuth": [] } ] }