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.

Due Diligence API Calls

Due Diligence Check

POST /duediligence/{storeid}/{serial}

Purpose

To perform a due diligence check using the supplied serial on behalf of the store referenced by the storeid.

Inputs

Example Request

Basic Example

curl -H 'Accept: application/json' \
-u 123:XXXXXXXXXXXXXXXXXXXXXX \
https://gapi.checkmend.com/duediligence/12345/123456123456123

Example with additional information (single category).

POST /duediligence/1/234234234234242 HTTP/1.1
Accept: application/json
Content-Type: application/json

{
    "category": 12
}

Example with additional information (multiple categories).

POST /duediligence/1/234234234234242 HTTP/1.1
Accept: application/json
Content-Type: application/json

{
    "category":[1,2]
}

Output

A JSON object containing the certificate ID which can be used to obtain a full certificate at no additional charge. The response will also contain the result of the check. The result will be either "passed", "caution" or "failed". In the event of an error the certid 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 Response

Response on Success:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "certid": 1234,
    "result": "passed"
}

Response on Failure:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "certid": 1234,
    "result": "failed"
}

Response on Caution:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "certid": 1234,
    "result": "caution"
}

Response on Request Failure (not check failure):

HTTP/1.1 404 Not Found
Content-Type: application/json

{
    "errors":
    [
        {
            "id": 404,
            "message": "The storeid supplied was invalid."
        }
    ]
}

FMIP Response

This is an example of a response for an FMIP check. If the FMIP check then this will be what is returned to your initial call.

If you are performing an asynchronous FMIP check and you have supplied a URL a HTTP POST will be sent to that URL containing the FMIP result, an updates result for the check and the certificate ID of the check.

Sample FMIP Check Response:

{
    "fmip": "activated",
    "result": "failed",
    "certid": "1234"
}

Possible FMIP Response Values