> ## Documentation Index
> Fetch the complete documentation index at: https://docs.poly.ai/llms.txt
> Use this file to discover all available pages before exploring further.

<AgentInstructions>

## Submitting Feedback

If you encounter incorrect, outdated, or confusing documentation on this page, submit feedback:

POST https://docs.poly.ai/feedback

```json
{
  "path": "/integrations/ideal-postcode",
  "feedback": "Description of the issue"
}
```

Only submit feedback when you have something specific and actionable to report.

</AgentInstructions>

# Ideal Postcode

> Enable UK address lookup and validation during calls with Ideal Postcode.

Connect your PolyAI agent to [Ideal Postcode](https://ideal-postcodes.co.uk/) for UK address lookup and validation. Help callers find and confirm their address using just a postcode during conversations.

<Note>This is a managed integration. Prepare the credentials below, then contact your PolyAI account manager to complete setup.</Note>

## 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

1. Log in to your [Ideal Postcode Dashboard](https://ideal-postcodes.co.uk/users/sign_in)
2. Navigate to **API Keys**
3. 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:

1. Go to **API Keys → Edit**
2. Set daily/monthly lookup limits
3. 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:

1. **Agent**: "Can I take your postcode?"
2. **Caller**: "SW1A 1AA"
3. **Agent**: "I found several addresses at that postcode. Is it number 10 Downing Street?"
4. **Caller**: "Yes, that's correct."
5. **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

## Support

For integration help, contact your PolyAI account manager.

For API questions, see the [Ideal Postcode Documentation](https://ideal-postcodes.co.uk/documentation).

## Related pages

<CardGroup cols={2}>
  <Card title="Integrations overview" href="/integrations/introduction" icon="plug">
    Browse all available integrations.
  </Card>

  <Card title="Managed services" href="/integrations/managed-services" icon="handshake">
    Other managed integrations requiring account manager setup.
  </Card>
</CardGroup>