Documentation for Credithive API

Search

POST /search

This API returns a hit list for the requested search criteria. The desired hit must be selected manually from the hit list in the client application. An automatic utilisation (e.g. hit selection) for automatic identification or data extraction without cost-incurring product retrieval or product ordering is not permitted.

Example:

curl -X POST -H "Content-Type: application/json" -d '{"apikey":"[YOUR API KEY]", "searchtype":"SETY-1", "companyname": "Test", "country":"DE"}' https://api.creditreform.co.uk/search

    {
        "apikey": "[YOUR API KEY]",
        "searchtype": "SETY-1",
        "companyname": "Test",
        "country": "DE"
    }

Search Response

Example:

    {
        "hit": [
            {
                "identificationnumber": "03453452013714",
                "companyname": "Kundentestsystem GEWO mit Negativmerkmalen - BITTE NICHT ÄNDERN",
                "tradename": "KTO GEWO",
                "street": "Johann-Sebastian-Bach-Str.",
                "housenumber": "1",
                "housenumberaffix": "a",
                "postcode": "99423",
                "city": "Weimar",
                "country": {
                    "key": "DE",
                    "designation": "Germany"},
                "legalform": {
                    "key": "LEFO-DE-12",
                    "designation": "Registered cooperative society",
                    "shortdesignation": "eG"},
                "reportavailable": true,
                "reportcompanyname": true,
                "reportaddress": true,
                "operationalstatus": {
                    key: "ONST-1",
                    designation: "active"},
                "additionalinformation": true
            }
        ],
        "morehits": true
    }

TKSD Structure

TKD Structure

Product Availability Request

POST /product

This API call returns the availability per product type for the requested ident number in consideration of the rights granted to the requesting user account. on the basis of this information, the client application can decide which product shall be requested or if a research order shall be placed.

An automatic utilisation for automatic identification or data extraction without cost-incurring product retrieval or product ordering is not permitted.

Example:

curl -X POST -H "Content-Type: application/json" -d '{"apikey":"[YOUR API KEY]", "identificationnumber":"03453452013714"}' https://api.creditreform.co.uk/product

    {
        "apikey": "[YOUR API KEY]",
        "identificationnumber": "03453452013714"
    }

Product Availability Response

Example:

    {
        "identificationnumber": "03453452013714",
        "companyname": "Kundentestsystem GEWO mit Negativmerkmalen - BITTE NICHT ÄNDERN",
        "tradename": "KTO GEWO",
        "alias": "GEWO",
        "street": "Johann-Sebastian-Bach-Str.",
        "housenumber": "1",
        "housenumberaffix": "a",
        "postcode": "99423",
        "city": "Weimar",
        "country": {
            "key": "DE",
            "designation": "Germany"},
        "service": {
            "operation": "report",
            "product": [
                {
                    producttype: {
                        "key": "PRTY-2",
                        "designation": "Commercial Report",
                        "shortdesignation": "Commercial Report"},
                    "parameters": {
                        "parameter": [
                            {
                                "name": "legitimateinterest",
                                "use: "required"
                                "key": [
                                    {
                                        "key":  "LEIN-100",
                                        "designation": "Credit decision",
                                        "shortdesignation": "Credit decision"
                                    }
                                ]
                            }
                        ]
                    }
                }
            ]
        }
    }

Report Request

POST /report

curl -X POST -H "Content-Type: application/json" -d '{"apikey":"[YOUR API KEY]", "customerreference": "my own reference","producttype":"PRTY-2","reportlanguage":"en","legitimateinterest": "LEIN-102", "identificationnumber":"03453452013714"}' https://api.creditreform.co.uk/report

This API call returns the Creditreform report products. The retrieval of a product causes costs.

Report Response

Offline order

POST /order

This API allows registration of offline order. Report when ready will be delivered outside of this API.

POST /orders

Results in states of offline orders. Possible states are:

• ‘R’ - Rejected
• ‘D’ - Delivered
• anything else means in progress

POST /orders/download

Downloads available report. If not found status is set to “not available”.

Report is sent as base64 encoded data in the “data” field.

• ‘R’ - Rejected
• ‘D’ - Delivered
• anything else means in progress