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.

Link API Calls

Link Address

POST /link/address/{addressid}

Purpose

To link an address ID with a person ID. Multiple address ID's can be registered to a person ID. If an address is no longer linked with a person, it can be removed using the Remove method.

Inputs

Example Request


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

{
    "personid": 42
    "date": "2010-07-12"
}

Output

If successful then there will be no output from this method other than a 201 Created HTTP status code. In the event of an error 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


Response on Error:

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

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