VisionNet API Address To Eircode

All requests must first be Authorized and must use the HTTP GET method over HTTPS. Results are encoded int UTF-8.

This call allows you to get the Eircode from the database for a provided address (list of address lines, between one and nine lines).

Only one call can run per customer at any time. This call may take approximately 5 seconds.

https://services.vision-net.ie/cws/1.5/getEircode/{UNIQUE_ID}/{ORGANISATION}/{ADDRESS_LINE_1}/{ADDRESS_LINE_2}/{ADDRESS_LINE_3}/{ADDRESS_LINE_4}/{ADDRESS_LINE_5}...?lang={RETURN_LANGUAGE}&format={FORMAT}&htmlEnc={HTMLENC}&userRef={USER_REF}
Parameter Type Description
UNIQUE_ID String A Unique ID for your own reference purposes. Cannot be null.
ORGANISATION Vision-Net The Organisation name for the address (can be empty), which will mean there will be two slashes immediately after each other.
ADDRESS_LINE_X 3rd Floor, Adelphi Plaza, George's Street Upper The address line (X must be between 1 and 9).
There can be no slashes in the address, so please remove 'C/O', 'T/A', 'R/O' etc, also changes the slashes in the numbers e.g. '7/9' to '7-9'
lang Irish or English Optional parameter where you can specify return language. Defaults to English.
format XML or JSON Return the results in XML (default) or JSON format.
htmlEnc 0 or 1 If set to one, then String fields will be encoded in HTML format. For XML this parameter is forced to 1. For example, ampersands will be encoded as &
userRef reference Optional parameter to save reference to the usage entry.

Sample response for COMPANY FORMATIONS INTERNATIONAL LTD., 22 NORTHUMBERLAND ROAD, BALLSBRIDGE, DUBLIN 4