> ## Documentation Index
> Fetch the complete documentation index at: https://composio-preview.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Ideal Postcodes

> Ideal Postcodes provides UK and international address search, postcode lookup, address cleansing, and contact validation APIs.

![Ideal Postcodes logo](https://mintcdn.com/composio-preview/tIuAovF9-7pXq2wA/images/toolkits/idealpostcodes.svg?fit=max\&auto=format\&n=tIuAovF9-7pXq2wA\&q=85\&s=cf3248be90396d76cefba60c0df2975b)

* **Category:** developer tools
* **Auth:** API\_KEY
* **Composio-managed OAuth available?** N/A
* **Tools:** 9
* **Triggers:** 0
* **Slug:** `IDEALPOSTCODES`
* **Version:** 00000000\_00

## Tools

> [accordion] Find Address Suggestions
>
> **Slug:** `IDEALPOSTCODES_FIND_ADDRESS_SUGGESTIONS`
>
> Return ranked address suggestions for a partial address without resolving them; resolving a selected suggestion is a separate paid lookup.
>
> #### Input Parameters
>
> **box** `string`
>
> Bounding box used to restrict results, in the provider's comma-separated coordinate format.
>
> **limit** `integer`
>
> Maximum suggestions to return (1-100).
>
> **query** `string` *required*
>
> Partial address to search for (maximum 150 characters).
>
> **bias\_ip** `string`
>
> IP address used to geographically bias suggestion ranking.
>
> **context** `string`
>
> Country context used to interpret the query, such as GBR or USA.
>
> **country** `string`
>
> Country name used to restrict suggestions.
>
> **datasets** `array`
>
> Enabled address datasets to search, such as paf or mr; omit to use the key's defaults.
>
> **postcode** `string`
>
> Exact postcode used to restrict suggestions.
>
> **post\_town** `string`
>
> Post town used to restrict suggestions.
>
> **bias\_lonlat** `string`
>
> Longitude and latitude used to rank nearby suggestions, formatted as 'longitude,latitude'.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Find Place Suggestions
>
> **Slug:** `IDEALPOSTCODES_FIND_PLACE_SUGGESTIONS`
>
> Return ranked country, city, and administrative-area suggestions without resolving them; resolving a selected place is a separate paid lookup.
>
> #### Input Parameters
>
> **query** `string` *required*
>
> Place name or partial place name to search for.
>
> **bias\_ip** `string`
>
> IP address used to geographically bias result ranking.
>
> **bias\_lonlat** `string`
>
> Longitude and latitude used to rank nearby places, formatted as 'longitude,latitude'.
>
> **country\_iso** `string`
>
> ISO 3166-1 alpha-3 country code used to restrict results, such as GBR.
>
> **bias\_country\_iso** `string`
>
> ISO 3166-1 alpha-3 country code used to rank matching places.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Address by Identifier
>
> **Slug:** `IDEALPOSTCODES_GET_ADDRESS_BY_IDENTIFIER`
>
> Retrieve a UK address by UDPRN or UMPRN. This consumes a paid lookup, and UMPRN requires the optional Multiple Residence dataset.
>
> #### Input Parameters
>
> **filter** `string`
>
> Comma-separated address fields to include in the result.
>
> **identifier** `string` *required*
>
> UDPRN or UMPRN value identifying the address.
>
> **identifier\_type** `string ("UDPRN" | "UMPRN")` *required*
>
> Identifier kind. UMPRN requires the optional Multiple Residence dataset.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Lookup Postcode
>
> **Slug:** `IDEALPOSTCODES_LOOKUP_POSTCODE`
>
> Return addresses at a UK postcode, or an Irish Eircode when enabled; successful results consume paid lookups.
>
> #### Input Parameters
>
> **tags** `string`
>
> Tags to attach to paid lookups for usage reporting.
>
> **filter** `string`
>
> Comma-separated address fields to include in each result.
>
> **postcode** `string` *required*
>
> UK postcode, or Irish Eircode when enabled, to look up.
>
> **next\_cursor** `string`
>
> Opaque continuation cursor returned by a previous lookup of the same postcode.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Resolve Address Suggestion
>
> **Slug:** `IDEALPOSTCODES_RESOLVE_ADDRESS_SUGGESTION`
>
> Resolve an address suggestion ID to a complete GBR or USA address. This consumes a paid lookup, and USA resolution requires an enabled USA dataset.
>
> #### Input Parameters
>
> **tags** `string`
>
> Tags to attach to the paid lookup for usage reporting.
>
> **country** `string ("GBR" | "USA")` *required*
>
> Dataset route for the suggestion. USA requires the optional USA dataset.
>
> **suggestion\_id** `string` *required*
>
> Address suggestion ID returned by Find Address Suggestions.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Resolve Place
>
> **Slug:** `IDEALPOSTCODES_RESOLVE_PLACE`
>
> Resolve a place suggestion ID to full geography and coordinates. This consumes a paid lookup.
>
> #### Input Parameters
>
> **tags** `string`
>
> Tags to attach to the paid lookup for usage reporting.
>
> **place\_id** `string` *required*
>
> Place suggestion ID returned by Find Place Suggestions.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Search Addresses
>
> **Slug:** `IDEALPOSTCODES_SEARCH_ADDRESSES`
>
> Search complete UK address records by text, filters, or coordinates; successful results consume paid lookups.
>
> #### Input Parameters
>
> **box** `string`
>
> Bounding box used to restrict results, in the provider's comma-separated coordinate format.
>
> **tags** `string`
>
> Tags to attach to paid lookups for usage reporting.
>
> **limit** `integer`
>
> Maximum addresses requested for this page (1-100); valid-postcode searches may force 100.
>
> **query** `string`
>
> Address text to search; omit when using coordinates or filters.
>
> **filter** `string`
>
> Comma-separated address fields to include in each result.
>
> **country** `string`
>
> Country name used to restrict results.
>
> **latitude** `number`
>
> Latitude for reverse geocoding; provide together with longitude.
>
> **postcode** `string`
>
> Exact postcode used to restrict results.
>
> **longitude** `number`
>
> Longitude for reverse geocoding; provide together with latitude.
>
> **post\_town** `string`
>
> Post town used to restrict results.
>
> **next\_cursor** `string`
>
> Continuation cursor returned by a previous call for the same search.
>
> **postcode\_outward** `string`
>
> Outward postcode used to restrict results.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Validate Address
>
> **Slug:** `IDEALPOSTCODES_VALIDATE_ADDRESS`
>
> Match and standardize a GBR or USA address with confidence details. This consumes a paid lookup, and USA verification requires the optional USPS CASS dataset.
>
> #### Input Parameters
>
> **city** `string`
>
> USA city hint; use post\_town for GBR.
>
> **tags** `string`
>
> Tags to attach to the paid validation lookup for usage reporting.
>
> **query** `string` *required*
>
> Free-form address to match and standardize.
>
> **state** `string`
>
> Two-letter USA state code hint.
>
> **county** `string`
>
> GBR county hint.
>
> **country** `string ("GBR" | "USA")` *required*
>
> Validation dataset to use; USA requires the optional USPS CASS dataset.
>
> **postcode** `string`
>
> GBR postcode hint; use zip\_code for USA.
>
> **zip\_code** `string`
>
> USA ZIP Code hint; use postcode for GBR.
>
> **post\_town** `string`
>
> GBR post town hint; use city for USA.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Validate Contact
>
> **Slug:** `IDEALPOSTCODES_VALIDATE_CONTACT`
>
> Validate an email address or international phone number using an optional paid dataset enabled on the connected Ideal Postcodes API key.
>
> #### Input Parameters
>
> **tags** `string`
>
> Tags to attach to the paid validation lookup for usage reporting.
>
> **value** `string` *required*
>
> Email address or international phone number to validate; phone numbers must include a country code.
>
> **contact\_type** `string ("EMAIL" | "PHONE_NUMBER")` *required*
>
> Kind of contact value to validate.
>
> **include\_current\_carrier** `boolean`
>
> For phone validation only, request current carrier data. This may consume an additional lookup.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not
