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.

Remove API Calls

Remove Person

POST /remove/person/{personid}

Purpose

To remove a person from the API.

Inputs

The person ID must not have any property registered to it, otherwise it will not be removed and an error will be returned.

Example Request


curl -H 'Accept: application/json' \
-u 123:XXXXXXXXXXXXXXXXXXXXXX \
https://gapi.checkmend.com/remove/person/42

Output

If successful then there will be no output from this method other than a 200 OK 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 200 OK
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"
        }
    ]
}

Remove Property

POST /remove/property/{propertyid}

Purpose

To remove property records from the API.

Inputs

Example Request


curl -H 'Accept: application/json' \
-u 123:XXXXXXXXXXXXXXXXXXXXXX \
https://gapi.checkmend.com/remove/property/8654

Output

If successful then there will be no output from this method other than a 200 OK 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 200 OK
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"
        }
    ]
}

Remove Address

POST /remove/address/{addressid}

Purpose

To remove a link between an address ID and a person ID API.

Inputs

Example Request


POST /remove/address/423 HTTP/1.1
Accept: application/json
Content-Type: application/json

{
    "personid": 23
}

Output

If successful then there will be no output from this method other than a 200 OK 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 200 OK
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"
        }
    ]
}