Документація API Infoproff - v3


Початок роботи


Веб-сервіс wsdl та схеми знаходяться тут:

http://wsdfn.infoproff.com/v3/

Web service functions:

  • SimpleSearch - Пошук інформації про компанії в різних країнах.
  • ChkFinance - Шукайте доступні фінансові звіти.
  • Order - Створює order_id і повертає дублікати. Дублікати відбираються за наступними параметрами: country, product, reg_code.
  • OrderCancellation - Якщо Ви надіслали заявку на замовлення та отримали order_id, у Вас є можливість скасувати це замовлення (якщо воно не пішло у виробництво).
  • OrderConfirmation - Після отримання order_id Вам необхідно буде підтвердити замовлення протягом 1 години. Якщо Ви не підтвердите замовлення протягом 1 години, замовлення буде автоматично анульовано.
  • ChkStatus - Перевірте статус замовлення.
  • GetReport - Отримайте готові звіти.

  • GetClassifiersFinancialStatements - Отримати всі фінансові документи з усіма елементами: row_number, row_formed_description, row_lang_key та row_order.
  • GetLegalForms - Отримайте всі юридичні форми для всіх доступних країн.
  • GetActivityClassificators - Отримайте всі коди та описи за класифікатором видів діяльності.
  • GetDictionaryStandardPhrases - Отримайте всі стандартні фрази з ключами та мовою.
  • GetAvailableProducts - Отримайте перелік доступних продуктів.

  • CreditOpinionCalculator - Калькулятор кредитних історій допоможе визначити кредитну історію компанії.

API надає декілька послуг:

  1. Кредитні звіти онлайн для наступних країн: Фінляндська Республіка (FIN), Королівство Швеція (SWE), Королівство Бельгія (BEL), Королівство Нідерландів (NLD), Естонська Республіка (EST)
  2. Офлайн звіти для наступних країн: Всі країни
  3. Калькулятор кредитної історії

Як шукати компанію?


Пошук компанії складається з 2 варіантів:

  1. Пошук за назвою компанії,
  2. Search by company code.
Перелік доступних країн: Ірландія (IRL), Італійська Республіка (ITA), Австрійська Республіка (AUT), Азербайджанська Республіка (AZE), Гренландія (GRL), Грузія (GEO), Естонська Республіка (EST), Киргизька Республіка (KGZ), Китайська Народна Республіка (CHN), Королівство Іспанія (ESP), Королівство Бельгія (BEL), Королівство Данія (DNK), Королівство Норвегія (NOR), Королівство Нідерландів (NLD), Королівство Швеція (SWE), Монголія (MNG), Португальська Республіка (PRT), Республіка Білорусь (BLR), Республіка Казахстан (KAZ), Республіка Кіпр (CYP), Республіка Молдова (MDA), Республіка Польща (POL), Республіка Узбекистан (UZB), Сполучене Королівство Великої Британії та Північної Ірландії (GBR), Федеративна Республіка Німеччина (DEU), Французька Республіка (FRA), Фінляндська Республіка (FIN), Швейцарська Конфедерація (CHE)
Важлива інформація:

search_result_id can be acquired here for orders with delivery_term = "o".

It may take up to 20 seconds to respond to a search request in the following countries: United Kingdom, Ireland, France, Spain, Portugal, Germany, Italy, Austria, Switzerland.

Норвезький реєстр не дозволяє здійснювати пошук видалених компаній за назвами. Тому ми не можемо надати SimpleSearch за іменами в межах видалених компаній в Норвегії.

Field's length:
company_name varchar(512)
company_code varchar(64)

Нижче ви можете ознайомитися з прикладом:


Функція SimpleSearch

Варіант 2: Пошук за реєстраційним кодом

Функція SimpleSearch

Як замовити кредитний звіт?


List of available countries for online credit reports: Естонська Республіка (EST), Киргизька Республіка (KGZ), Королівство Бельгія (BEL), Королівство Нідерландів (NLD), Королівство Швеція (SWE), Республіка Казахстан (KAZ), Республіка Польща (POL), Фінляндська Республіка (FIN)
Field's length:
business_name varchar(512)
reg_code varchar(64)
vat_code varchar(64)
address varchar(512)
phone varchar(256)
email varchar(256)
additional_info varchar(512)
ref_code varchar(64)

Below you can find the example of how to order and download reports:

STEP 1: Find a company (Online/Offline Order (with search_result_id))

Функція SimpleSearch

To order an Online/Offline with identification report you need to receive "<search_result_id>".
To do so, please follow the link: Як шукати компанію?

The search allows you to accurately identify the company you wish to place an order for. For example, in some countries, there may be several companies with one registration number, or the same official name may belong to several companies.

STEP 2: Order a report (Online/Offline Order (with search_result_id))

Функція Order
If you won't use the element confirm_order, then you will receive <last_duplicates> in the XML response, so that you can decide if you really need to place an order.

STEP 3: Order cancellation (Optional) (Online/Offline Order (with search_result_id))

Функція OrderCancellation
If you wish to cancel the order, you can use this OrderCancellation function. If the order is already in progress, then you won't be able to cancel it.

STEP 4: Order confirmation (Online/Offline Order (with search_result_id))

Функція OrderConfirmation
If you didn't use the element "confirm_order", then you need to confirm your order.

STEP 5: Check order status (Online/Offline Order (with search_result_id))

Функція ChkStatus
  • - For offline orders checking order status once every 30 minutes is acceptable frequency.
  • - For online orders checking order status once every 5 seconds is acceptable frequency.

Для звітів використовуються наступні статуси:

  • У процесі виконання - Звіт на етапі виробництва
  • Canceled - Скасоване замовлення
  • Finished - Звіт готовий
  • Updated - До готового звіту додано інформацію
  • Rejected - Order is rejected (Insufficient funds, incorrect order details or other reason).
  • Technical Error - У нашій системі сталася технічна помилка. Це означає, що ми проінформовані про цю помилку і будемо виправляти її якнайшвидше. Про те, коли Ви зможете отримати замовлення, Вас буде повідомлено додатково.

Якщо статус виконання Finished або Updated, то Ви можете отримати замовлення.

STEP 6: Get report (Online/Offline Order (with search_result_id))

Функція GetReport
Список доступних мов: bg (Болгарська), cs (Чеська), da (Данська), de (Німецька), el (Грецька), en (Англійська мова), es (іспанська), et (естонська), fi (Фінська), fr (Французька), hu (угорська), id (Індонезійська), it (Італійська), ja (Японський), ko (Корейська), lt (Литовська), lv (латвійська), nb (Норвезький Бокмоль), nl (Голландська), pl (Польська), pt (Португальська), ro (Румунська), ru (російська), sk (Словацька), sl (Словенська), sv (Шведська), tr (Турецька), uk (Українська), zh (Китайська)

STEP 1: Order a report (Offline Order (without search_result_id))

Функція Order
If you won't use the element confirm_order, then you will receive <last_duplicates> in the XML response, so that you can decide if you really need to place an order.

STEP 2: Order cancellation (Optional) (Offline Order (without search_result_id))

Функція OrderCancellation
If you wish to cancel the order, you can use OrderCancellation function. If the order is already in progress, then you won't be able to cancel it.

STEP 3: Order confirmation (Offline Order (without search_result_id))

Функція OrderConfirmation
If you didn't use the element "confirm_order", then you need to confirm your order.

STEP 4: Status Checking (Offline Order (without search_result_id))

Функція ChkStatus
For offline orders checking order status once every 30 minutes is acceptable frequency.

Для звітів використовуються наступні статуси:

  • У процесі виконання - Звіт на етапі виробництва
  • Canceled - Скасоване замовлення
  • Finished - Звіт готовий
  • Updated - До готового звіту додано інформацію
  • Rejected - Order is rejected (Insufficient funds, incorrect order details or other reason).
  • Technical Error - У нашій системі сталася технічна помилка. Це означає, що ми проінформовані про цю помилку і будемо виправляти її якнайшвидше. Про те, коли Ви зможете отримати замовлення, Вас буде повідомлено додатково.

Якщо статус виконання Finished або Updated, то Ви можете отримати замовлення.

STEP 5: Get report (Offline Order (without search_result_id))

Функція GetReport
Список доступних мов: bg (Болгарська), cs (Чеська), da (Данська), de (Німецька), el (Грецька), en (Англійська мова), es (іспанська), et (естонська), fi (Фінська), fr (Французька), hu (угорська), id (Індонезійська), it (Італійська), ja (Японський), ko (Корейська), lt (Литовська), lv (латвійська), nb (Норвезький Бокмоль), nl (Голландська), pl (Польська), pt (Португальська), ro (Румунська), ru (російська), sk (Словацька), sl (Словенська), sv (Шведська), tr (Турецька), uk (Українська), zh (Китайська)

Як замовити фінансову звітність онлайн?


STEP 1: Find a company

Функція SimpleSearch

To order an online financial statements, you need to receive "<search_result_id>".
To do so, please follow the link: Як шукати компанію?

The search allows you to accurately identify the company you wish to place an order for. For example, in some countries, there may be several companies with one registration number, or the same official name may belong to several companies.

STEP 2: Пошук доступної фінансової звітності

Функція ChkFinance

Ця функція потрібна тільки при замовленні товару: finances (Financial statements) з delivery_term = 'o'.

Перелік доступних країн: Естонська Республіка (EST), Королівство Швеція (SWE)

STEP 3: Замовити фінансову звітність

Функція Order
If you won't use the element confirm_order, then you will receive <last_duplicates> in the XML response, so that you can decide if you really need to place an order.

STEP 4: Order cancellation (Optional)

Функція OrderCancellation
If you wish to cancel the order, you can use this OrderCancellation function. If the order is already in progress, then you won't be able to cancel it.
To see the examples of xml request/response, please follow the link: How to cancel the order?

STEP 5: Order confirmation

Функція OrderConfirmation
If you didn't use the element "confirm_order", then you need to confirm your order.
To see the examples of xml request/response, please follow the link: How to confirm the order?

STEP 6: Check order status

Функція ChkStatus
  • - For online orders checking order status once every 5 seconds is acceptable frequency.

Для звітів використовуються наступні статуси:

  • У процесі виконання - Звіт на етапі виробництва
  • Canceled - Скасоване замовлення
  • Finished - Звіт готовий
  • Updated - До готового звіту додано інформацію
  • Rejected - Order is rejected (Insufficient funds, incorrect order details or other reason).
  • Technical Error - У нашій системі сталася технічна помилка. Це означає, що ми проінформовані про цю помилку і будемо виправляти її якнайшвидше. Про те, коли Ви зможете отримати замовлення, Вас буде повідомлено додатково.

If the execution status is Finished or Updated, then you can get an order.

To see the examples of xml request/response, please follow the link: How to check order status?

STEP 7: Get report

Функція GetReport
Список доступних мов: bg (Болгарська), cs (Чеська), da (Данська), de (Німецька), el (Грецька), en (Англійська мова), es (іспанська), et (естонська), fi (Фінська), fr (Французька), hu (угорська), id (Індонезійська), it (Італійська), ja (Японський), ko (Корейська), lt (Литовська), lv (латвійська), nb (Норвезький Бокмоль), nl (Голландська), pl (Польська), pt (Португальська), ro (Румунська), ru (російська), sk (Словацька), sl (Словенська), sv (Шведська), tr (Турецька), uk (Українська), zh (Китайська)
To see the examples of xml request/response, please follow the link: How to get finished order?

Як завантажити стандартні звіти (у форматах, відмінних від XML)?


Types of standard product: Basic Report, Mini Report, Linkages, Registration Data Report, Full report (private person), Short report (private person), Full report (with research), Financials (bank), Short Report, Real estate ownership search, Extended report, Full Report, KYC Report, Linked persons, Credit Opinion, Financial statements.

Запит складається з 3 частин:

  1. Фіксована частина https://www.infoproff.com/en/orders/files/
  2. Ваш унікальний хеш, який ми надаємо у відповідь
  3. And fixed part at the end /report?&lang=en&doc_type=pdf&currency_position=left&preferred_currency=EUR
https://www.infoproff.com/en/orders/files/<order_hash>/report?&lang=en&doc_type=pdf&currency_position=left&preferred_currency=EUR
lang: en, et, ru, lv, bg, cs, da, de, el, fi, fr, hu, id, it, ja, ko, lt, nl, nb, pl, pt, ro, sk, sl, es, sv, tr, uk, zh
doc_type: pdf, html, docx, xlsx
currency_position: left, right
preferred_currency: XXX - Оригінал (без обміну), EUR, USD, AUD, BGN, BRL, CAD, CHF, CNY, CZK, DKK, GBP, HKD, HRK, HUF, IDR, ILS, INR, ISK, JPY, KRW, MXN, MYR, NOK, NZD, PHP, PLN, RON, RUB, SEK, SGD, THB, TRY, ZAR

Як завантажити нестандартну продукцію?


Types of non-standard product: Marketing database (special offer), Site visit - non-capital city, Extract from registry, Site visit - capital city, Due Diligence, non-standard, Shareholder document, Memorandum of Association, Certificate of incorporation.

Запит складається з 3 частин:

  1. Fixed part https://www.infoproff.com/en/orders/files/
  2. Ваш унікальний хеш, який ми надаємо у відповідь
  3. І нерухома частина на кінці /download

Як отримати кредитний висновок?


Функція CreditOpinionCalculator

Як отримати додаткову інформацію?


Функція GetClassifiersFinancialStatements
Функція GetActivityClassificators
Функція GetDictionaryStandardPhrases
Функція GetAvailableProducts

delivery_term:

  1. "o" = "Online"
  2. "n" = "Normal"
  3. "f" = "Flash"
  4. "s" = "SuperFlash"

Можливі помилки


Ці помилки можуть виникнути при відправці запиту до нашого веб-сервісу.


Всі функції
  • Incorrect username/password or you have no permissions.
    Ви вводите неправильні облікові дані або ваш доступ до API заблоковано.

Функція SimpleSearch
  1. You don't have permissions to search in this country.
    Перелік доступних країн: Ірландія (IRL), Італійська Республіка (ITA), Австрійська Республіка (AUT), Азербайджанська Республіка (AZE), Гренландія (GRL), Грузія (GEO), Естонська Республіка (EST), Киргизька Республіка (KGZ), Китайська Народна Республіка (CHN), Королівство Іспанія (ESP), Королівство Бельгія (BEL), Королівство Данія (DNK), Королівство Норвегія (NOR), Королівство Нідерландів (NLD), Королівство Швеція (SWE), Монголія (MNG), Португальська Республіка (PRT), Республіка Білорусь (BLR), Республіка Казахстан (KAZ), Республіка Кіпр (CYP), Республіка Молдова (MDA), Республіка Польща (POL), Республіка Узбекистан (UZB), Сполучене Королівство Великої Британії та Північної Ірландії (GBR), Федеративна Республіка Німеччина (DEU), Французька Республіка (FRA), Фінляндська Республіка (FIN), Швейцарська Конфедерація (CHE)
Функція Order
  1. This product is not available.
    Такого продукту не знайти і не замовити.
  2. You can't order report on company with legal form: "legal_form"
    Ця помилка стосується тільки: Королівство Швеція (SWE)
    У Швеції неможливо замовити звіт онлайн (delivery_term = "o") з наступними організаційно-правовими формами:
    • enskild näringsidkare
    • kommanditbolag
    • handelsbolag
  3. When delivery term is Online, please use order_details_by_id with search_result_id.
    This error only appears if you are trying to order online report without search_result_id.
    It is important yo use order_details_by_id in OrderReportRequest
  4. Business Name or Reg Code is required
    При замовленні офлайн звіту (delivery_term = "n", "f" або "s") обов'язковим є заповнення поля "Назва підприємства" або "Код ЄДРПОУ".
  5. Reg Code is required when delivery term is Online
    При замовленні онлайн звіту (delivery_term = "o") обов'язковим є "Reg Code".

Функція GetReport
  1. This language is not supported.
    Список доступних мов для онлайн-звітів: bg (Болгарська), cs (Чеська), da (Данська), de (Німецька), el (Грецька), en (Англійська мова), es (іспанська), et (естонська), fi (Фінська), fr (Французька), hu (угорська), id (Індонезійська), it (Італійська), ja (Японський), ko (Корейська), lt (Литовська), lv (латвійська), nb (Норвезький Бокмоль), nl (Голландська), pl (Польська), pt (Португальська), ro (Румунська), ru (російська), sk (Словацька), sl (Словенська), sv (Шведська), tr (Турецька), uk (Українська), zh (Китайська)

Функції GetReport ChkStatus
  1. Incorrect order_id.
    Не вдається знайти ідентифікатор замовлення. Ви можете отримати ідентифікатор замовлення, скориставшись функцією Order.

Функція OrderCancellation
  1. Your order is already canceled.
    Ви більше не маєте права скасувати замовлення.

Функція OrderConfirmation
  1. You don't have permission to confirm the order anymore. Confirmation can be done within one hour after you recieved 'order_id'.

Зміни SOAP (версія 3) у порівнянні з SOAP (версія 2)


Зміни SOAP (версія 3) у порівнянні з SOAP (версія 2) [Overview]

1) New function: ChkFinance

Allows you to search for available financial statements.
Currently available only in EST (Estonia), SWE (Sweden)

2) Function: SimpleSearch

- Changes in list of available countries: Ірландія (IRL), Італійська Республіка (ITA), Австрійська Республіка (AUT), Азербайджанська Республіка (AZE), Гренландія (GRL), Грузія (GEO), Естонська Республіка (EST), Киргизька Республіка (KGZ), Китайська Народна Республіка (CHN), Королівство Іспанія (ESP), Королівство Бельгія (BEL), Королівство Данія (DNK), Королівство Норвегія (NOR), Королівство Нідерландів (NLD), Королівство Швеція (SWE), Монголія (MNG), Португальська Республіка (PRT), Республіка Білорусь (BLR), Республіка Казахстан (KAZ), Республіка Кіпр (CYP), Республіка Молдова (MDA), Республіка Польща (POL), Республіка Узбекистан (UZB), Сполучене Королівство Великої Британії та Північної Ірландії (GBR), Федеративна Республіка Німеччина (DEU), Французька Республіка (FRA), Фінляндська Республіка (FIN), Швейцарська Конфедерація (CHE)

- Each time you place an request we asaign a new 'search_result_id' for each company. You need to use this 'search_result_id' to place online orders.

Also you can place offline (delivery_term = 'n', 'f' or 's') orders with 'search_result_id', if you desire.

3) Function: Order
Identification is required!

To place an online order, you need to recieve 'search_result_id' from function 'SimpleSearch', and only after that you can place an online (delivery_term = 'o') order.

- Changes in list of available countries for online credit reports: Естонська Республіка (EST), Киргизька Республіка (KGZ), Королівство Бельгія (BEL), Королівство Нідерландів (NLD), Королівство Швеція (SWE), Республіка Казахстан (KAZ), Республіка Польща (POL), Фінляндська Республіка (FIN)

- Available to download financial statements (using product: finances) in online mode: Estonia (EST), Sweden (SWE)

3) Function: GetReport

- Changes in of available languages: bg (Болгарська), cs (Чеська), da (Данська), de (Німецька), el (Грецька), en (Англійська мова), es (іспанська), et (естонська), fi (Фінська), fr (Французька), hu (угорська), id (Індонезійська), it (Італійська), ja (Японський), ko (Корейська), lt (Литовська), lv (латвійська), nb (Норвезький Бокмоль), nl (Голландська), pl (Польська), pt (Португальська), ro (Румунська), ru (російська), sk (Словацька), sl (Словенська), sv (Шведська), tr (Турецька), uk (Українська), zh (Китайська)


Зміни SOAP (версія 3) у порівнянні з SOAP (версія 2) [WSDL and XSD]

File: report.xsd

New elements:

- report/negative_information/debts/item/remainder_range

- report/negative_information/debts/item/remainder_non_standard_range

File: report.wsdl

New function:

- ChkFinance

Function that allows you to search for available financial statements.

NB: This function is only needed when ordering a product: finances (Financial statements) with delivery_term = 'o'.
File: order.xsd

1) OrderReportRequest has a choice:

- order_details:

Using general information: business_name, reg_code, vat_code, address, phone, email, additional_info

NB:
* Business Name or Registration Code is required
* Only for orders with delivery_term: 'n', 'f' and 's' (credit reports in offline mode)

- order_details_by_id:

Using 'search_result_id'

NB:
* 'search_result_id' can be obtained with function: 'SimpleSearch'
* each new search generates new 'search_result_id'

2) order_details

New element:

- preferable_finances

NB: This element is required only ordering a product: finances (Financial statements) with delivery_term = 'o'.

3) SimpleSearchRequest

Removed element:

search_block.reg_code

New element:

search_block->company_code

NB: in some countries we allow to search companies by vat_code.

4) SimpleSearchResponse

Removed elements

- code

Нові елементи:

  • - search_result_id (is required for order with delivery_term = 'o')
  • - name_transliteration
  • - reg_code
  • - vat_code
  • - unified_legal_form

Webhooks Settings


Огляд

Веб-хук - це спосіб, за допомогою якого програма може надавати іншим програмам інформацію в режимі реального часу. Наша функція веб-хук реалізує HTTP-відгуки, налаштовані за допомогою URL-адреси. На цю URL-адресу надсилається HTTP POST-вантаж у форматі JSON щоразу, коли відбувається певна подія. У контексті нашого проекту ми розробили функцію webhook, щоб запускати певні події.

Налаштування веб-хука

Щоб налаштувати веб-хук для вашого додатку, перейдіть на сторінку налаштувань додатку і знайдіть розділ "Налаштування веб-хуків". І надайте наступну інформацію:

  1. "URL-адреса веб- хука" - це URL-адреса, на яку ваш сервер буде отримувати POST-запити веб-хука.
  2. " Максимальна кількість спроб доставки " - це параметр, який визначає максимальну кількість повторних спроб доставки події вебхука, якщо перша спроба доставки виявилася невдалою.
  3. "Тайм-аут повторної спроби доставки " - це налаштування, яке дозволяє вказати інтервал часу між повторними спробами, коли спроба доставки вебхука закінчується невдачею.

Після введення цих даних натисніть "Зберегти".

Типи подій веб-хука

  1. Новий статус замовлення

Корисне навантаження Webhook

Коли відбувається подія, ми надсилаємо HTTP POST-запит на URL-адресу корисного навантаження з тілом JSON, що містить інформацію про подію.

Ось приклад корисного навантаження:
Приклад корисного навантаження нового статусу замовлення
Можливі значення поля "new_status":
  • "Finished" - замовлення сформовано. Замовлення можна забрати;
  • "Updated" - оновлено замовлення, додано дані до завершеного замовлення;
  • "Canceled" - замовлення скасовується на прохання (або за згодою) клієнта;
  • "Rejected" - замовлення відхиляється. Зазвичай через те, що неможливо ідентифікувати компанію.

Захист ваших веб-хуків

Важливо переконатися, що POST-запити, надіслані на URL-адресу корисного навантаження, походять від нашого додатка. Щоб допомогти вам у цьому, кожен запит веб-хука містить заголовок X-Signature.

Підпис Опис

Для підпису ми використовуємо HMAC з алгоритмом SHA512.

Секрет - це конкатенація ідентифікатора додатку та секретного ключа з налаштувань веб-хуків.

Ви можете додати власні параметри get до кінцевої точки, щоб ідентифікувати відправника, якщо це необхідно.

Усунення несправностей

Сервер повинен відповісти протягом 10 секунд і повернути 2XX HTTP-код; в іншому випадку доставка вебхука вважається невдалою. У разі невдачі функція спробує повторно відправити запит відповідно до політики доставки.