creditDevice B.V. Inquiry API

Welcome to the creditDevice B.V. Inquiry API documentation. We will walk through the process of searching a company, using it to request an inquiry and fetch the corresponding report when ready.

Characteristics

• API tries to adhere to the principles of REST as much as possible (RESTful)

• JSON is the only supported format for input and output data

• All requests require HTTP Basic Authentication

• Dates in ISO 8601 format

• Country codes in ISO 3166-1 alpha-2 format

• Closed access (username and password is provided by creditDevice B.V.)

Contents

• API Status
  • Check the API status
  • Schemas
• Company
  • Searching for companies
  • Schemas
• Inquiry
  • Place an inquiry
  • Fetch an inquiry
  • Browse inquiries
  • Schemas
• Report
  • Report types
  • Fetch a report
  • Fetch a PDF report
  • Fetch a temporary report
  • Schemas
• Monitor
  • Report types
  • Add or update an entry
  • Delete an entry
  • Browse entries
  • Delete an entry
  • Browse alerts
  • Fetch an alert report
  • Schemas
• Instant
  • Purchase an instant
  • Browse instants
  • Fetch instant
  • Fetch a PDF report
  • Content
  • Schemas
• Decision Maker Module
  • Create an order
  • Fetch an order
  • Fetch a report
  • Browse orders
  • Fetch rulesets
  • Content
  • Schemas

Errors

HTTP status code	Meaning
400	Input not valid
401	Not authenticated
403	Not authorized
404	Resource not found
429	Too many requests
500	Unexpected error

Example of an error response:

{
  "message": "Value for `company_id` required"
}

Changelog

• [2023-08-25] Add negative_articles to UBO.

• [2023-08-25] Add rating_month_info.

• [2023-01-26] Add date to employees.

• [2022-09-23] Add marketing_info.

• [2022-05-09] Add an X-Instant-Id header to response of instant report.

• [2022-02-14] Add the ability to specify product for instant reports.

• [2021-10-11] Add amount to management see Manager.

• [2021-07-06] Make D44CI101 available for NL.

• [2021-07-05] Add reference to DMM order.

• [2020-11-13] Add is_main_activity to SBI see Activity.

• [2020-09-22] Add D44CI931, D44CI932, D44CI933 and D44CI934 report.

• [2019-08-22] Add company_active to Branch.

• [2019-05-24] Add tradename to Party.

• [2019-03-22] Add D44CI911 report.

• [2019-02-04] Add previous_score to payments alerts.

• [2019-02-04] Add previous_address_postal to review alerts.

• [2019-02-04] Add previous_address_office to review alerts.

• [2019-02-04] Add previous_name to review alerts.

• [2019-01-17] Add previous_limit_advice to review alerts.

• [2018-12-05] Add fleet_vehicles.

• [2017-10-27] Add company_active to involvement.

• [2017-06-28] Add D44CI706 report.

• [2017-05-12] Add involvements to relations.

• [2017-01-13] Add more alert types to monitoring.

• [2016-12-30] Add gender to manager.

• [2016-12-30] Add lastname_without_infixes to manager.

• [2016-12-30] Add infixes to manager.

• [2016-12-28] Add support for temporary report.

• [2016-12-23] Add first_manager to management.

• [2016-12-06] Add support for PDF reports.

• [2016-11-18] Add D44CI907 report.

• [2016-11-17] Add consolidated to balance sheet.

• [2016-11-17] Add continuations.

• [2016-11-17] Add risk to tree relation.

• [2016-11-17] Add financial_analysis to branche analysis.

• [2016-11-17] Add country_info (International only).

• [2016-11-04] Add address_score to manager (D44CI906 only).

• [2016-11-04] Add neighborhood_score to manager (D44CI906 only).

• [2016-11-01] Add personal_score to manager (D44CI906 only).

• [2016-11-01] Add overall_score to manager (D44CI906 only).

• [2016-08-16] Add D44CI906 report.