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.

ClaimsCheck API Methods

Validating Crime References

POST /claimscheck/validatecrimeref

Purpose

The purpose of this method is to validate a UK Police crime reference number. The request and response will be in JSON.

Inputs

Both crimerefrence and force have a max length of 50 characters.

Example Request with Serial


{
    "crimereference": "LE/08/1090",
    "storeid": 1,
    "force": "bedfordshire"
}

Output

The API will respond with a JSON body and a HTTP 200 response code. The table below describes the format of the response.

Field Name Value Description
matchesforce Boolean True if the crime reference and the force submitted match. False if they do not match.
validexamples Array of strings An array of valid crime reference examples for the force supplied in the request. If matchedforces is true then this field will not be present in the output.
matchedforces Array of strings An array of force identifiers indicating what forces the supplied crime reference would match. If matchedforces is true then this field will not be present in the output.

Example Response

If the force and crime reference match:


{
    "matchesforce": true
}

If the force does not match the crime reference:


{
    "matchesforce": false,
    "validexamples": ["BF/08/1090"],
    "matchedforces": ["bedfordshire"]
}