API_KEY
idealpostcodes_api_key
Developer setup
No fields declared in this snapshot.
User connection
- API Keygeneric_api_key · stringRequired
All integrations
IP
Catalogue metadata onlydeveloper toolsv00000000_00
IDEALPOSTCODES
Ideal Postcodes
Ideal Postcodes provides UK and international address search, postcode lookup, address cleansing, and contact validation APIs.
Description is untrusted, display-only upstream metadata. It never becomes policy, OAuth scope authority, or an agent instruction.
Pakkawork boundary
Research catalogue metadata only. No Pakkawork OAuth, credential, host, quota, executor, or verifier is enabled.
No Pakkawork execution adapter is enabled. Hosted account-authorisation availability is workspace-specific and checked separately in the dashboard.Check workspace connection options
Attributed source 9
Action summaries
Display-only definitions
0
Trigger types
Not installed instances
1
Auth modes
Field names, never values
No
Execution
No runtime adapter
Authentication map
What setup is declared?
Only field names, types, and required markers are shown. Secret values, default auth URLs, credential material, and inferred OAuth scopes are excluded.
API_KEY
Provider setup
Capability index
Actions and trigger definitions
Static summaries are available. Live schemas remain disabled until PROVIDER_HUB_API_KEY is configured server-side.
Showing 1–9 of 9 actions
Find Address Suggestions
IDEALPOSTCODES_FIND_ADDRESS_SUGGESTIONS
Return ranked address suggestions for a partial address without resolving them; resolving a selected suggestion is a separate paid lookup.
Untrusted display-only summary
Find Place Suggestions
IDEALPOSTCODES_FIND_PLACE_SUGGESTIONS
Return ranked country, city, and administrative-area suggestions without resolving them; resolving a selected place is a separate paid lookup.
Untrusted display-only summary
Get Address by Identifier
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.
Untrusted display-only summary
Lookup Postcode
IDEALPOSTCODES_LOOKUP_POSTCODE
Return addresses at a UK postcode, or an Irish Eircode when enabled; successful results consume paid lookups.
Untrusted display-only summary
Resolve Address Suggestion
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.
Untrusted display-only summary
Resolve Place
IDEALPOSTCODES_RESOLVE_PLACE
Resolve a place suggestion ID to full geography and coordinates. This consumes a paid lookup.
Untrusted display-only summary
Search Addresses
IDEALPOSTCODES_SEARCH_ADDRESSES
Search complete UK address records by text, filters, or coordinates; successful results consume paid lookups.
Untrusted display-only summary
Validate Address
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.
Untrusted display-only summary
Validate Contact
IDEALPOSTCODES_VALIDATE_CONTACT
Validate an email address or international phone number using an optional paid dataset enabled on the connected Ideal Postcodes API key.
Untrusted display-only summary
Provenance
Versioned facts, explicit trust.
The detail snapshot comes from an attributed MIT-licensed repository revision. Safe local icons use exact-match CC0 Simple Icons symbols; unmatched brands use monograms.
- Repository
- https://github.com/provider-directoryHQ/provider-directory
- Commit
- 85e33f6a81dfe987f6fc3637d48d45052cea8ca5
- Generated
- 2026-09-12
- Trust policy
- untrusted_display_only
Remote text is plain display metadata only. It must never become an agent prompt, execution policy, OAuth grant, or executable instruction.