FAQ
Quick answers for developers integrating the Foxentry REST API. Can’t find what you need? Write to [email protected].
Getting started
Sign in to our app and create a new project from your dashboard. Name it, choose whether it is for you or for a client, and pick the Application project type. That is the one for REST API integrations.
Building a website or e-shop instead of an app? Consider a Web project (script): you drop a snippet into your site (or GTM) and get ready-made autocomplete, validation and the Fix autocomplete feature without writing any frontend code.
In the app open your project, then Settings, API keys, Create API key. A project can have any number of keys, so you can separate production from testing, or give each developer their own.
When creating a key you can set a name, an optional expiration and an IP restriction.
The full key is shown only once, right after it is created. Afterwards you see only part of it. Store it somewhere safe, for example in a password manager. If you lose it, generate a new one.
Yes. Every new API project comes with a 14-day free trial, currently 50 requests for each of our services, so you can test everything end to end.
New here? Sign up. Already a client? Create a new project in the app.
Using the API
Send your key as a Bearer token in the request header and specify the API version:
Headers, examples and a Try it console are on the Authentication and API call pages.
The latest version is 2.1. Without the Api-Version header the API uses the latest version automatically. To pin a version, send for example Api-Version: 2.1.
Upgrading from 2.0? Migrating from 2.0 lists the breaking changes for names and phone numbers.
Yes. The official open-source SDKs handle request and response formatting for you and cut integration time significantly:
| Language | Requirement | Repository |
|---|---|---|
| PHP | 8.1+ | php-sdk |
| JavaScript / TypeScript | Node 18+ | js-sdk |
| C# | .NET 8.0+ | c-sharp-sdk |
| Swift | 5.0+ | swift-sdk |
| Kotlin | Java 17+ | kotlin-sdk |
Five data categories, each with validation, autocomplete and detailed lookups where it makes sense:
- Addresses: validation, autocomplete, localization, detailed info
- Companies: validation, autocomplete, detailed registry info
- E-mails: validation, domain autocomplete
- Phone numbers: validation, prefix suggestions
- Names: validation, correction, vocative and gender, name days
All endpoints are in the API Reference.
Coverage keeps growing. E-mails and phone numbers work worldwide; addresses, companies and names depend on the country. The current list is on the Supported countries page.
Credit & billing
Your project has run out of credit. Authentication is fine, there is just nothing to draw from. Top up in your project administration at app.foxentry.com and the calls go through again.
To avoid this in production, turn on automatic top-up: the system buys your package again when credit drops below a threshold (with card payment).
In the app open Tariff / credit packages, then Choose tariff, and pick a model:
- Monthly tariffs: a set number of requests that resets every period. Best for stable, high-volume projects.
- Credit packages: a bundle of credit valid for 2 years, drawn down as you use it. Best for smaller or seasonal projects.
You set up services per category (addresses, companies, e-mails, phones, names) and pay by card or bank transfer.
You pay only for what you use: each request deducts its value from your credit. The full price list is on foxentry.com.
Security & keys
- Store it in a password manager. It is shown in full only once.
- Set an expiration date, so a leaked key stops working after a while.
- Add an IP restriction, so the key works only from your servers.
- If you suspect a key was exposed, use Regenerate key in the app. The old one stops working immediately.
Only if you want them to. Expiration is optional: set it when creating a key, or later in the key menu under Edit. Leave it empty for a key without a limit. Rotating keys regularly is good practice.
Personal data is sacred to us and we never store it. Every entry is anonymized and encrypted, with no decryption key, so even in the event of an attack your data cannot be stolen.
More in our privacy policy, GDPR information and data code.
Support
If you cannot find the answer in the documentation, write or call us, Monday to Friday, 9:30 to 17:00.
- E-mail: [email protected]
- Helpline: +420 277 278 678