Address

Returns address details for the provided encrypted key.

JavaScript library method

patientportal.addressFinder.address({key: <key>});

HTTP Method

Verb URL
GET /patientportalapi/address-finder/address

URL Parameters

Parameter Type Description
key string An encrypted key value containing partial address information.

Returns

AddressData

Returned JSON

{
    "status": "ok",
    "result": {
        "Address1": "127 Northchurch Rd",
        "Address2": "Borough of Islington",
        "Address3": "",
        "City": "London",
        "County": "",
        "PostCode": "N1 3PA",
        "Country": "United Kingdom"
    }
}