Global property history reporting and due-diligence API

Calls to the API must be for genuine use and responses from the API must not be stored for the purpose of creating an offline copy of the information stored. Failure to comply with this requirement will infringe the API License.

Address API Calls

Register Address

POST /address

Purpose

To register an address on the API. This address can then be assigned to a person using the Link method.

Inputs

Example Request


POST /address HTTP/1.1
Accept: application/json
Content-Type: application/json

{
    "address1": "42 London Way",
    "address2": "-",
    "address3": "-",
    "address4": "-",
    "city": "Exeter",
    "county": "Devon",
    "state": "England",
    "zipcode": "EX1 3DS",
    "country": "UK"
}

Output

A unique address ID. You will need this ID to link the address to a Person using the Link method. In the event of an error the addressid will not be returned. Instead, a JSON object containing an errors array will be returned. For details on the errors array please read the Errors page.

Example Responses

Response on Success:

HTTP/1.1 201 Created
Content-Type: application/json

{
    "addressid": 2785
}

Response on Error:

HTTP/1.1 400 Human readable error message
Content-Type: application/json

{
    "errors":
    [
        {
            "id": n,
            "message": "Human readable message"
        }
    ]
}