This guide walks you through everything you need to make your first API call – from creating an account to receiving real company data. The whole process takes about five minutes.
Step 1 – Register
Create an account by sending your email, a password, and a name for your integration. The password is required to log in to the developer panel – API request authentication is entirely token-based.
POST /api/v1/auth/register curl -X POST https://api.entiway.com/api/v1/auth/register \ -H "Content-Type: application/json" \ -d '{ "email": "[email protected]", "name": "my-integration", "password": "YourPassword123", "password_confirmation": "YourPassword123" }'
You'll receive a response with your user_ref and an expires_at timestamp. Check your inbox – a one-time initialization token has been sent to your email. It expires after 24 hours.
Step 2 – Initialize your account
Use the token from your email to generate your Master Token. This is the most important step – the Master Token is shown only once and cannot be retrieved again. Copy it immediately and store it securely.
POST /api/v1/auth/init curl -X POST https://api.entiway.com/api/v1/auth/init \ -H "Content-Type: application/json" \ -d '{ "token": "your-email-token-here" }'
The response contains your master_token – a string starting with sk_live_. Store it now. You will not see it again.
Step 3 – Create an API token
Use your Master Token to create a scoped API token for your integration. API tokens have access to all data endpoints – Company Search, Company Monitor & Events, Wallet – but cannot manage other tokens. This keeps your Master Token safe.
POST /api/v1/tokens curl -X POST https://api.entiway.com/api/v1/tokens \ -H "Authorization: Bearer sk_live_xxxx" \ -H "Content-Type: application/json" \ -d '{ "name": "my-integration" }'
The response contains your plaintext API token – starting with sk_api_. Again, shown only once. Store it immediately. Use this token in all subsequent data requests.
Step 4 – Top up your wallet
All API operations consume credits from your wallet. Before making data requests, top up your balance. See the Pricing page for available packages and credit costs per operation.
POST /api/v1/wallet/topup curl -X POST https://api.entiway.com/api/v1/wallet/topup \ -H "Authorization: Bearer sk_api_xxxx" \ -H "Content-Type: application/json" \ -d '{ "package_slug": "pack_1000" }'
Open the checkout_url from the response in your browser to complete payment via Paddle. Credits are added to your balance automatically after confirmation.
Step 5 – Make your first request
You're ready for your first request. Use your API token to search for companies matching your criteria - industry, location, or activity start date, for example. A single request returns up to 20 companies with a lightweight, structured record for each one – identifiers, name, location, main activity, and status – plus the total count of all matching records in the registry. If the result is larger than 20, narrow your filters before paging through the rest – the request cost is fixed regardless of how many records come back, so more precise criteria mean fewer requests and a lower total cost.
GET /api/v1/companies/search curl "https://api.entiway.com/api/v1/companies/search?voivodeship=mazowieckie" \ -H "Authorization: Bearer sk_api_xxxx"
What's next?
Now that you have your tokens and wallet set up, explore the other guides or jump straight into the API Reference for full parameter documentation.