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
--------

.. toctree::
   :maxdepth: 2

   api-status
   company
   inquiry
   report
   monitor
   instant
   dmm

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:

.. code-block:: json

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

Changelog
---------

- [2025-03-14] Add more filters to search for companies in NL.
- [2024-12-11] Add **branche_analysis.payment_experiences**.
- [2024-12-11] Add **payments.payment_experiences**.
- [2024-10-18] Add **statutory_seat**.
- [2024-10-07] Add **qualification_details** to management see :ref:`report-schema-manager`.
- [2024-04-29] Add **checked** and **lists** to UBO.
- [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 :ref:`report-schema-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 :ref:`report-schema-activity`.
- [2020-09-22] Add D44CI931, D44CI932, D44CI933 and D44CI934 report.
- [2019-08-22] Add **company_active** to :ref:`report-schema-branch`.
- [2019-05-24] Add **tradename** to :ref:`report-schema-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.

.. _`ISO 8601`: http://en.wikipedia.org/wiki/ISO_8601
.. _`ISO 3166-1 alpha-2`: http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2