{ "opencollection": "1.0.0", "info": { "name": "International Address Autocomplete Lookup Verify API", "version": "0.9" }, "items": [ { "info": { "name": "Verify", "type": "folder" }, "items": [ { "info": { "name": "Submit Address to Verify", "type": "http" }, "http": { "method": "GET", "url": "https://international-autocomplete.api.smarty.com/verify", "headers": [ { "name": "Host", "value": "" } ], "params": [ { "name": "input_id", "value": "", "type": "query", "description": "A unique identifier generated by you for this address for use within your application; this field will be copied into the output. (e.g., 123456) Max Characters: 36" }, { "name": "country", "value": "", "type": "query", "description": "This must be entered with every address. Country Name or ISO classification (ISO-3, ISO-2 or ISO-N). Address validation will fail if this is missing. (e.g., Brazil, BRA, BR, or 076)" }, { "name": "geocode", "value": "", "type": "query", "description": "Set to true to enable geocoding (disabled by default). See the examples section for, well, an example." }, { "name": "language", "value": "", "type": "query", "description": "When not set, the output language will match the language of the input values. When set to native, the results will always be in the language of the output country whenever possible. When set to latin, the results will always be provided using a Latin character set basic ASCII, accents and other diacritics removed. The following character sets can be transliterated, into either native or Latin characters, for the specified countries: Russian (Kazakhstan, Azerbaijan) Japanese (Japan) Simplified Chinese (China) Thai (Thailand) Arabic (Algeria, Bahrain, Egypt, Iraq, Jordan, Kuwait, Lebanon, Morocco, Oman, Qatar, Saudi Arabia, United Arab Emirates, Yemen)" }, { "name": "freeform", "value": "", "type": "query", "description": "The entire address in a single field (without the country). If freeform is specified, all other address input fields (except country) will be ignored. (e.g., Via Santa Maria di Costantinopoli, 72 46030-Tabellano MN) Max Characters: 512" }, { "name": "address1", "value": "", "type": "query", "description": "The first address line (e.g., Calle Proc. San Sebastián, 15)" }, { "name": "address2", "value": "", "type": "query", "description": "The second address line (if any)" }, { "name": "address3", "value": "", "type": "query", "description": "The third address line (if any)" }, { "name": "address4", "value": "", "type": "query", "description": "The fourth address line (if any)" }, { "name": "organization", "value": "", "type": "query", "description": "The name of the recipient, firm, or company at this address (e.g., Robert Smith OR The Clean Oil Company)" }, { "name": "locality", "value": "", "type": "query", "description": "The city name (e.g., Paris)" }, { "name": "administrative_area", "value": "", "type": "query", "description": "The state or province name or abbreviation (e.g., Alberta or AB)" }, { "name": "postal_code", "value": "", "type": "query", "description": "The postal code (e.g., 90210-2301)" }, { "name": "license", "value": "", "type": "query", "description": "The license or licenses (comma separated) to use for this lookup. Valid values can be found in the account dashboard under the appropriate subscription. If multiple licenses are specified, they are considered in left to right order. We recommend that each request explicitly specify a license value. For more information see License Selection." }, { "name": "features", "value": "", "type": "query", "description": "A comma-separated list of features. These may require a special plan that allows the feature to be used. Examples:occupant-use: Return the occupant_use metadata field; geocode-classification: Return the geocode_classification metadata field if geocode=true; geocode-precision-enhanced: Enable the PostalCode return value in geocode_precision" } ], "auth": { "type": "apikey", "key": "auth-id", "value": "{{auth-id}}", "placement": "query" } }, "docs": "To send one (and only one) address to our API, simply encode the input field names from the table below along with the corresponding input values as query string parameters in the URL of your request. Here's an example that uses the address1, address2, locality, administrative_area, postal_code, and country fields:\n```\ncurl -v 'https://international-street.api.smarty.com/verify?\n auth-id=YOUR+AUTH-ID+HERE&\n auth-token=YOUR+AUTH-TOKEN+HERE&\n\n address1=Rua+Padre+Antonio+D%27Angelo+121&\n addres" } ] } ], "bundled": true }