canonical: https://jentic.com/apis/whapi.com/locations

# Whapi Locations

The Locations API is a collection of methods that support geographical information. The first method is an address lookup service for UK addresses. This service can be used to provide a new customer with a list of possible addresses from which they can populate a registration form. The API exposes 5 endpoints secured with apiKey authentication.

## For AI agents

Programmatically addresslookup, getcountries. Covers 5 operations with apiKey authentication.

## Scope

Does not handle payments, communications, or developer tools - use for crm only.

## Capabilities

- addressLookup
- getCountries
- getCountry
- getCurrencies
- getCurrency

## Use cases

### CRM Operations

Use the Locations to perform crm operations programmatically. The API provides 5 endpoints covering core functionality including addresslookup, getcountries, getcountry.

Example prompt: Call GET /address/lookup/ to addresslookup

### Automated Address Management

Automate address operations by combining multiple Locations endpoints. Agents can getcountries and then getcountry in a single workflow.

Example prompt: Call GET /countries/ to getcountries, then verify the result

### AI Agent Integration via Jentic

AI agents discover and call Locations endpoints through Jentic without managing credentials directly. An agent searches for the required operation by intent, receives the matching endpoint schema, and executes the call with Jentic-managed authentication. This eliminates the need to read API documentation or handle apiKey tokens manually.

Example prompt: Search Jentic for 'addresslookup', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| GET | /address/lookup/ | addressLookup |
| GET | /countries/ | getCountries |
| GET | /countries/{countryCode} | getCountry |
| GET | /currencies/ | getCurrencies |
| GET | /currencies/{currencyCode} | getCurrency |

## Key resources

- **Address** — Operations for address
- **Countries** — Operations for countries
- **Currencies** — Operations for currencies

## Why Jentic

- **Setup:** Wiring this Locations API by hand means placing its apiKey in the header on every request against the sandbox.whapi.com host and handling retries yourself. Through Jentic you install once, import Locations from the API Directory, store the API key once, and your agent calls it.
- **Permission scoping:** This Locations API puts the country or currency code in the URL path (/countries/{countryCode}), so a rule can pin your agent to one country or currency lookup. You choose the operations it may call, so address lookup or listing every country is not included unless you add them.
- **Credential handling:** Your Locations API key is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'look up an address' or 'get details for a country code', and Jentic returns the matching Locations operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Hubspot** — Alternative crm API
- **Salesforce** — Alternative crm API
- **Pipedrive** — Complementary crm API
- **Zoho** — Complementary crm API

## FAQ

### What authentication does the Locations use?

The Locations uses an API key passed in the `apiKey` header. Through Jentic, these credentials are stored encrypted in your Jentic One instance and injected at execution time, so raw secrets never enter the agent context.

### Can I addresslookup with the Locations?

Yes. Use the GET /address/lookup/ endpoint. The API returns structured JSON responses that agents can parse and act on directly.

### What are the rate limits for the Locations?

Rate limits are not specified in the OpenAPI spec. Check the vendor documentation for current limits. Through Jentic, rate limiting is handled automatically with retry logic built into the execution layer.

### How do I addresslookup through Jentic?

Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'addresslookup'. Jentic returns the matching Locations operation with its input schema. Load the schema and execute the call - credentials are injected automatically.

### How many endpoints does the Locations have?

The Locations exposes 5 endpoints covering address, countries, currencies operations.

### Can I limit what my agent is allowed to do with the Locations API?

Yes. Because you run Jentic One yourself, your own rules decide which Locations operations the agent may call, so you can allow only address lookups or only country and currency reads and leave the rest off. Since the country or currency code sits in the URL path, such as GET /countries/{countryCode} or GET /currencies/{currencyCode}, a rule can pin the agent to a single country or currency lookup rather than letting it list every country or currency. The API key is stored once by your instance and injected at execution time, so the agent can call only the endpoints you have permitted.