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.

Upcoming CheckMEND API Changes

We are introducing a new CheckMEND API. It is already available, fully documented and already in live use by several clients who have recently joined us. To assist longstanding API clients to have a smooth migration we are phasing in some urgent changes to the current API which should mean little or no change for your code. In six month's time we will then cease support for the existing API. Here are the key dates for your diary. We hope this guide answers all your questions but if not please contact us on support@checkmend.com

If you do wish to migrate sooner rather than later please start here!

Are you affected?

If your API client code is calling a URL that resembles one of the following, then you should check your code now to ensure that the reduced responses shown below will be accepted without error.

What's actually changing?

We are going to cease sending the binary data for the pdf CheckMEND certificate.

We're also removing the STOLEN, LOST, BLOCKED and CRIMEREFIND rows.

Why?

The majority of recyclers have no real-time need of the information. It also takes a long time to build a pdf that includes many graphical elements. The data lookup takes a few milliseconds, assembling the pdf binary data can take 100 times as long. This affects API response times and server load, our bandwicth usage and yours.

The STOLEN, LOST, BLOCKED and CRIMEREFIND flags were intended to provide more information for recyyclers. They were never intended to be used for decision making. Unfortunately some API clients have misunderstood and erroneously based decisions on this portion of the response. In addition, as the factors that influence our HIT or MISS response may vary over time, it is undesirable to have those factors exposed in the API where they serve no useful purpose and should they change may then require changes at your end.

This enables us to begin using the new API, the current one acting only as a wrapper so that you do not have to make big code changes very quickly. As the new API is a ground-up rewrite operating on new clusters and with in-memory optimized lookups, performance is massively improved. This is good for you, good for your web or factory system&apo;s responsiveness and therefore good for your customers.

What will API responses look like after Phase 1?

If your API request included all available options then your typical response prior to Phase 1 will look like this.

Example Response

        
OK
HIT
STOLEN=yes
LOST=yes
BLOCKED=no
CERTID=29812d2-5247ed
MAKE=Nokia
MODEL=6310i
CRIMEREFIND=yes
PDF=b324587....base64encodedbinarydata...54cbd435
        
        

After Phase 1, the response will ALWAYS contain just the HIT/MISS, MAKE, MODEL and CERTID rows irrespective of how you set the options field in your request.

Example API response after Phase 1

        
OK
HIT
CERTID=29812d2-5247ed
MAKE=Nokia
MODEL=6310i