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.

Person API Calls

Register Person

POST /person

Purpose

To register an individual on the API.

Inputs

Example Request


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

{
    "familyname": "Bloggs",
    "othernames": "Joseph Anders",
    "dob": "1982-11-25",
    "gender": "Male",
    "ref": "QWERTY12344"
}

Output

A unique person ID. You will need this ID for registering property on the API. In the event of an error the personid 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

{
    "personid": 985
}

Response on Error:

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

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

If you wish to update this information in the future you should use the update method of the API.