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.

Store API Calls

Register Store

POST /organisation/store

Purpose

To register a store as having a relationship with an organisation. The organisation must already be registered on your account.

Inputs

The store's full postal address is required in order that the licensing conditions can be retrieved.

Example Request


POST /organisation/store HTTP/1.1
Accept: application/json
Content-Type: application/json

{
    "legalname": "Amce Traders Inc.",
    "reportname": "Amce Traders",
    "type": "2ndHand",
    "address1": "-",
    "address2": "-",
    "address3": "-",
    "address4": "-",
    "city": "-",
    "county": "-",
    "state": "-",
    "zipcode": "-",
    "country": "-",
    "parentorgid": 123
}

Output

A unique store ID. You will need this ID whenever you submit a transaction or are retrieving compliance requirments for the store. In the event of an error the storeid 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

{
    "storeid": 456
}

Response on Error:

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

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

Get Store Fields

POST /store/{storeid}

Purpose

To return a list of field ids that are compulsory for the given store id. These only make sense if you have previously obtained and stored a list of supported fields from the ComplianceFields method.

You can retrieve the full list of all supported field definitions via the ComplianceFields method. You should store these locally (but not past the expires time).

Inputs

Example Request


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

Output

An array containing a list of required field ID's that transaction submissions from that store should provide. If not provided, the transaction will be accepted but it will then appear on a daily exceptions report as it may mean the store is not compliant with all local trading requirements. We accept it as a convenience to the Partner and Organisation but it is your choice to enforce compliance, not ours. Our role is to inform what is required, collect what you provide and make it accessible to law enforcement.

Example Response


HTTP/1.1 200 OK
Content-Type: application/json
Expires: Tue, 15 Nov 2011 00:00:00 GMT

{
    "fields":
    [
        {
            "id": 15
        },
        {
            "id": 23
        },
        {
            "id": 31
        },
        {
            "id": 33
        }
    ]
}