Capabilities
- Postcode lookup: Retrieve all addresses associated with a UK postcode
- Address selection: Help callers identify their specific address from results
- Address validation: Confirm address details during booking or registration flows
Getting started
Prerequisites
- An Ideal Postcode account with API credits
- Your API key
- PolyAI project access
Step 1: Obtain API key
- Log in to your Ideal Postcode Dashboard
- Navigate to API Keys
- Copy your API key (or create a new one for the PolyAI integration)
Step 2: Configure usage limits (optional)
You can set usage limits and IP restrictions on your API key for additional security:- Go to API Keys → Edit
- Set daily/monthly lookup limits
- Add IP allowlists if required
Step 3: Provide credentials to PolyAI
Share your API key with your PolyAI account manager. It will be stored securely.How it works
Typical conversation flow:- Agent: “Can I take your postcode?”
- Caller: “SW1A 1AA”
- Agent: “I found several addresses at that postcode. Is it number 10 Downing Street?”
- Caller: “Yes, that’s correct.”
- Agent: “Perfect, I’ve confirmed your address as 10 Downing Street, London, SW1A 1AA.”
Use cases
- Booking confirmations: Verify delivery or service addresses
- Account registration: Capture accurate address details for new customers
- Address updates: Help existing customers update their address on file
Limitations
- UK only: Ideal Postcode covers UK addresses only; use alternative providers for international addresses
- Credit-based: Each lookup consumes API credits; monitor usage to avoid service interruption
- Multiple addresses: Some postcodes have many addresses; the agent may need to narrow down results