Infoproff API Documentatie - v3

Switch-versie V3

Aan de slag

Web service wsdl en schema's zijn hier te vinden:

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

Web service functions:

  • SimpleSearch - Zoek informatie over bedrijven in verschillende landen.
  • ChkFinance - Zoek naar beschikbare financiële overzichten.
  • Order - Creëert een order_id en retourneert duplicaten. Duplicaten worden geselecteerd door volgende parameters: country, product, reg_code.
  • OrderCancellation - Als u een bestelaanvraag hebt verzonden en de order_id hebt ontvangen, hebt u de mogelijkheid om deze bestelling te annuleren (als ze nog niet in productie is gegaan).
  • OrderConfirmation - Na het ontvangen van order_id moet u uw bestelling binnen 1 uur bevestigen. Indien u uw bestelling niet binnen 1 uur bevestigt, zal deze automatisch geannuleerd worden.
  • ChkStatus - Controleer de status van de bestelling.
  • GetReport - Maak de rapporten af.
  • GetClassifiersFinancialStatements - Verkrijg alle financiële documenten met alle elementen: rij_nummer, rij_opgemaakte_omschrijving, rij_lang_sleutel en rij_volgorde.
  • GetLegalForms - Krijg alle wettelijke formulieren voor alle beschikbare landen.
  • GetActivityClassificators - Krijg alle codes en beschrijvingen voor specifieke activiteitenclassificator.
  • GetDictionaryStandardPhrases - Krijg alle standaardzinnen met sleutels en taal.
  • GetAvailableProducts - Een lijst van beschikbare producten.
  • CreditOpinionCalculator - Credit Opinion Calculator helpt bij het bepalen van de kredietwaardigheid van een bedrijf.

API biedt verschillende diensten:

  1. Online kredietrapporten voor de volgende landen: Republiek Finland (FIN), Koninkrijk Zweden (SWE), Koninkrijk België (BEL), Koninkrijk der Nederlanden (NLD), Republiek Estland (EST)
  2. Offline verslagen voor de volgende landen: Alle landen
  3. Kredietadvies calculator

Hoe zoek ik een bedrijf?

Het zoeken naar bedrijven bestaat uit 2 opties:

  1. Zoeken op bedrijfsnaam,
  2. Search by company code.
Lijst van beschikbare landen: Bondsrepubliek Duitsland (DEU), Franse Republiek (FRA), Georgia (GEO), Groenland (GRL), Ierland (IRL), Italiaanse Republiek (ITA), Kirgizische Republiek (KGZ), Koninkrijk België (BEL), Koninkrijk Denemarken (DNK), Koninkrijk Noorwegen (NOR), Koninkrijk Spanje (ESP), Koninkrijk Zweden (SWE), Koninkrijk der Nederlanden (NLD), Mongolië (MNG), Portugese Republiek (PRT), Republiek Azerbeidzjan (AZE), Republiek Belarus (BLR), Republiek Cyprus (CYP), Republiek Estland (EST), Republiek Finland (FIN), Republiek Kazachstan (KAZ), Republiek Moldavië (MDA), Republiek Oezbekistan (UZB), Republiek Oostenrijk (AUT), Republiek Polen (POL), Verenigd Koninkrijk van Groot-Brittannië en Noord-Ierland (GBR), Volksrepubliek China (CHN), Zwitserse Confederatie (CHE)
Belangrijke informatie:

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.

In het Noorse register is het niet mogelijk om in geschrapte ondernemingen op naam te zoeken. Daarom kunnen wij geen SimpleSearch op naam aanbieden binnen de geschrapte vennootschappen in Noorwegen.

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

Hieronder vindt u het voorbeeld:

Functie SimpleSearch

Optie 2: Zoeken op registratiecode

Functie SimpleSearch

Hoe kan ik een kredietrapport bestellen?

List of available countries for online credit reports: Kirgizische Republiek (KGZ), Koninkrijk België (BEL), Koninkrijk Zweden (SWE), Koninkrijk der Nederlanden (NLD), Republiek Estland (EST), Republiek Finland (FIN), Republiek Kazachstan (KAZ), Republiek Polen (POL)
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))

Functie SimpleSearch

To order an Online/Offline with identification report you need to receive "<search_result_id>".
To do so, please follow the link: Hoe zoek ik een bedrijf?

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

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

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

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

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

De volgende statussen worden gebruikt voor rapporten:

  • In uitvoering - Verslag in de productiefase
  • Canceled - Geannuleerde bestelling
  • Finished - Het verslag is klaar
  • Updated - Er is informatie toegevoegd aan het eindverslag
  • Rejected - Order is rejected (Insufficient funds, incorrect order details or other reason).
  • Technical Error - Er is een technische fout opgetreden in ons systeem. Dit betekent dat wij op de hoogte zijn van deze fout en deze zo spoedig mogelijk zullen herstellen. U zult op de hoogte worden gebracht wanneer u de bestelling kunt ontvangen.

Als de uitvoeringsstatus Finished of Updated is, dan kunt u een order krijgen.

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

Functie GetReport
Lijst van beschikbare talen: bg (Bulgaars), cs (Tsjechisch), da (Deens), de (Duits), el (Grieks), en (Engels), es (Spaans), et (Estlands), fi (Fins), fr (Frans), hu (Hongaars), id (Indonesisch), it (Italiaans), ja (Japans), ko (Koreaans), lt (Litouws), lv (Lets), nb (Noors Bokmål), nl (Nederlands), pl (Pools), pt (Portugees), ro (Roemeens), ru (Russisch), sk (Slowaaks), sl (Sloveens), sv (Zweeds), tr (Turks), uk (Oekraïens), zh (Chinees)

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

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

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

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

Functie ChkStatus
For offline orders checking order status once every 30 minutes is acceptable frequency.

De volgende statussen worden gebruikt voor rapporten:

  • In uitvoering - Verslag in de productiefase
  • Canceled - Geannuleerde bestelling
  • Finished - Het verslag is klaar
  • Updated - Er is informatie toegevoegd aan het eindverslag
  • Rejected - Order is rejected (Insufficient funds, incorrect order details or other reason).
  • Technical Error - Er is een technische fout opgetreden in ons systeem. Dit betekent dat wij op de hoogte zijn van deze fout en deze zo spoedig mogelijk zullen herstellen. U zult op de hoogte worden gebracht wanneer u de bestelling kunt ontvangen.

Als de uitvoeringsstatus Finished of Updated is, dan kunt u een order krijgen.

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

Functie GetReport
Lijst van beschikbare talen: bg (Bulgaars), cs (Tsjechisch), da (Deens), de (Duits), el (Grieks), en (Engels), es (Spaans), et (Estlands), fi (Fins), fr (Frans), hu (Hongaars), id (Indonesisch), it (Italiaans), ja (Japans), ko (Koreaans), lt (Litouws), lv (Lets), nb (Noors Bokmål), nl (Nederlands), pl (Pools), pt (Portugees), ro (Roemeens), ru (Russisch), sk (Slowaaks), sl (Sloveens), sv (Zweeds), tr (Turks), uk (Oekraïens), zh (Chinees)

Hoe online financiële overzichten bestellen?

STEP 1: Find a company

Functie SimpleSearch

To order an online financial statements, you need to receive "<search_result_id>".
To do so, please follow the link: Hoe zoek ik een bedrijf?

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: Zoeken naar beschikbare jaarrekeningen

Functie ChkFinance

Deze functie is alleen nodig bij het bestellen van een product: finances (Financial statements) met delivery_term = 'o'.

Lijst van beschikbare landen: Republiek Estland (EST), Koninkrijk Zweden (SWE)

STEP 3: Financiële afschriften bestellen

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

Functie 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

Functie 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

Functie ChkStatus
  • - For online orders checking order status once every 5 seconds is acceptable frequency.

De volgende statussen worden gebruikt voor rapporten:

  • In uitvoering - Verslag in de productiefase
  • Canceled - Geannuleerde bestelling
  • Finished - Het verslag is klaar
  • Updated - Er is informatie toegevoegd aan het eindverslag
  • Rejected - Order is rejected (Insufficient funds, incorrect order details or other reason).
  • Technical Error - Er is een technische fout opgetreden in ons systeem. Dit betekent dat wij op de hoogte zijn van deze fout en deze zo spoedig mogelijk zullen herstellen. U zult op de hoogte worden gebracht wanneer u de bestelling kunt ontvangen.

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

Functie GetReport
Lijst van beschikbare talen: bg (Bulgaars), cs (Tsjechisch), da (Deens), de (Duits), el (Grieks), en (Engels), es (Spaans), et (Estlands), fi (Fins), fr (Frans), hu (Hongaars), id (Indonesisch), it (Italiaans), ja (Japans), ko (Koreaans), lt (Litouws), lv (Lets), nb (Noors Bokmål), nl (Nederlands), pl (Pools), pt (Portugees), ro (Roemeens), ru (Russisch), sk (Slowaaks), sl (Sloveens), sv (Zweeds), tr (Turks), uk (Oekraïens), zh (Chinees)
To see the examples of xml request/response, please follow the link: How to get finished order?

Hoe kan ik standaardrapporten downloaden (in andere formaten dan 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.

Het verzoek bestaat uit 3 delen:

  1. Vast onderdeel https://www.infoproff.com/en/orders/files/
  2. Uw unieke hash, die wij als antwoord geven
  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 - Origineel (geen ruil), 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

Hoe kan ik niet-standaard producten downloaden?

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.

Het verzoek bestaat uit 3 delen:

  1. Fixed part https://www.infoproff.com/en/orders/files/
  2. Uw unieke hash, die wij als antwoord geven
  3. En het vaste gedeelte aan het eind /download

Hoe kan ik een kredietadvies krijgen?

Functie CreditOpinionCalculator

Hoe kan ik aanvullende informatie krijgen?

Functie GetClassifiersFinancialStatements
Functie GetActivityClassificators
Functie GetDictionaryStandardPhrases
Functie GetAvailableProducts

delivery_term:

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

Mogelijke fouten

Deze fouten kunnen zich voordoen bij het aanvragen van onze webdienst.

Alle functies
  • Incorrect username/password or you have no permissions.
    U voert de verkeerde inloggegevens in of uw API-toegang is geblokkeerd.
Functie SimpleSearch
  1. You don't have permissions to search in this country.
    Lijst van beschikbare landen: Bondsrepubliek Duitsland (DEU), Franse Republiek (FRA), Georgia (GEO), Groenland (GRL), Ierland (IRL), Italiaanse Republiek (ITA), Kirgizische Republiek (KGZ), Koninkrijk België (BEL), Koninkrijk Denemarken (DNK), Koninkrijk Noorwegen (NOR), Koninkrijk Spanje (ESP), Koninkrijk Zweden (SWE), Koninkrijk der Nederlanden (NLD), Mongolië (MNG), Portugese Republiek (PRT), Republiek Azerbeidzjan (AZE), Republiek Belarus (BLR), Republiek Cyprus (CYP), Republiek Estland (EST), Republiek Finland (FIN), Republiek Kazachstan (KAZ), Republiek Moldavië (MDA), Republiek Oezbekistan (UZB), Republiek Oostenrijk (AUT), Republiek Polen (POL), Verenigd Koninkrijk van Groot-Brittannië en Noord-Ierland (GBR), Volksrepubliek China (CHN), Zwitserse Confederatie (CHE)
Functie Order
  1. This product is not available.
    Dit product kan niet gevonden worden en het is niet mogelijk om het te bestellen.
  2. You can't order report on company with legal form: "legal_form"
    Deze fout geldt alleen voor: Koninkrijk Zweden (SWE)
    In Zweden is het niet mogelijk om online verslag (delivery_term = "o") te bestellen met de volgende rechtsvormen:
    • 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
    Bij bestelling van een offline rapport (leveringstermijn = "n", "f" of "s") is "Bedrijfsnaam" of "Reg Code" vereist.
  5. Reg Code is required when delivery term is Online
    Bij bestelling van een online rapport (leveringstermijn = "o") is "Reg Code" vereist.
Functie GetReport
  1. This language is not supported.
    Lijst van beschikbare talen voor onlinerapporten: bg (Bulgaars), cs (Tsjechisch), da (Deens), de (Duits), el (Grieks), en (Engels), es (Spaans), et (Estlands), fi (Fins), fr (Frans), hu (Hongaars), id (Indonesisch), it (Italiaans), ja (Japans), ko (Koreaans), lt (Litouws), lv (Lets), nb (Noors Bokmål), nl (Nederlands), pl (Pools), pt (Portugees), ro (Roemeens), ru (Russisch), sk (Slowaaks), sl (Sloveens), sv (Zweeds), tr (Turks), uk (Oekraïens), zh (Chinees)
Functies GetReport ChkStatus
  1. Incorrect order_id.
    Order ID kan niet worden gevonden. U krijgt de order ID wanneer u de Order functie gebruikt.
Functie OrderCancellation
  1. Your order is already canceled.
    Je hebt geen toestemming meer om de bestelling te annuleren.
Functie 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 (versie 3) wijzigingen ten opzichte van SOAP (versie 2)

SOAP (versie 3) wijzigingen ten opzichte van SOAP (versie 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: Bondsrepubliek Duitsland (DEU), Franse Republiek (FRA), Georgia (GEO), Groenland (GRL), Ierland (IRL), Italiaanse Republiek (ITA), Kirgizische Republiek (KGZ), Koninkrijk België (BEL), Koninkrijk Denemarken (DNK), Koninkrijk Noorwegen (NOR), Koninkrijk Spanje (ESP), Koninkrijk Zweden (SWE), Koninkrijk der Nederlanden (NLD), Mongolië (MNG), Portugese Republiek (PRT), Republiek Azerbeidzjan (AZE), Republiek Belarus (BLR), Republiek Cyprus (CYP), Republiek Estland (EST), Republiek Finland (FIN), Republiek Kazachstan (KAZ), Republiek Moldavië (MDA), Republiek Oezbekistan (UZB), Republiek Oostenrijk (AUT), Republiek Polen (POL), Verenigd Koninkrijk van Groot-Brittannië en Noord-Ierland (GBR), Volksrepubliek China (CHN), Zwitserse Confederatie (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: Kirgizische Republiek (KGZ), Koninkrijk België (BEL), Koninkrijk Zweden (SWE), Koninkrijk der Nederlanden (NLD), Republiek Estland (EST), Republiek Finland (FIN), Republiek Kazachstan (KAZ), Republiek Polen (POL)

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

3) Function: GetReport

- Changes in of available languages: bg (Bulgaars), cs (Tsjechisch), da (Deens), de (Duits), el (Grieks), en (Engels), es (Spaans), et (Estlands), fi (Fins), fr (Frans), hu (Hongaars), id (Indonesisch), it (Italiaans), ja (Japans), ko (Koreaans), lt (Litouws), lv (Lets), nb (Noors Bokmål), nl (Nederlands), pl (Pools), pt (Portugees), ro (Roemeens), ru (Russisch), sk (Slowaaks), sl (Sloveens), sv (Zweeds), tr (Turks), uk (Oekraïens), zh (Chinees)


SOAP (versie 3) wijzigingen ten opzichte van SOAP (versie 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

Nieuwe elementen:

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

Webhooks Settings

Overzicht

Een webhook is een manier voor een applicatie om andere applicaties te voorzien van realtime informatie. Onze webhook functie implementeert HTTP callbacks die zijn geconfigureerd met een URL. Een HTTP POST payload wordt naar deze URL gestuurd in JSON formaat wanneer een gespecificeerde gebeurtenis plaatsvindt. In de context van ons project hebben we de webhookfunctie ontworpen om specifieke gebeurtenissen te triggeren.

Een webhook instellen

Om een webhook voor je applicatie in te stellen, navigeer je naar de pagina met applicatie-instellingen en zoek je naar de sectie 'Webhooks-instellingen'. En geef de volgende informatie op:

  1. "Webhook URL" is de URL waar je server webhook POST-verzoeken zal ontvangen.
  2. "Aflevering max. pogingen" is de instelling die het maximum aantal nieuwe pogingen definieert dat moet worden gedaan voor het afleveren van een webhook-gebeurtenis als de eerste afleverpoging mislukt.
  3. "Time-out voor opnieuw proberen levering" is een instelling waarmee je het tijdsinterval tussen nieuwe pogingen kunt opgeven wanneer een leveringspoging van een webhook mislukt.

Klik na het invoeren van deze gegevens op 'Opslaan'.

Webhook gebeurtenistypen

  1. Nieuwe status van bestelling

Webhook laadvermogen

Wanneer een gebeurtenis plaatsvindt, sturen we een HTTP POST verzoek naar de payload URL met een JSON body die informatie bevat over de gebeurtenis.

Hier is een voorbeeld payload:
Payload voorbeeld van nieuwe status van bestelling
Possible values of "new_status" field:
  • "Finished" - an order is complete. An order can be picked up;
  • "Updated" - an order updated, data added to a completed order;
  • "Canceled" - an order is canceled at a customer's request (or consent);
  • "Rejected" - an order is rejected. Usually because it is impossible to identify a company.

Uw webhooks beveiligen

Het is belangrijk om te verifiëren dat POST verzoeken die naar de payload URL worden gestuurd, afkomstig zijn van onze applicatie. Om hierbij te helpen, bevat elk webhook verzoek een X-handtekening header.

Handtekening Beschrijving

Voor het ondertekenen gebruiken we HMAC met SHA512-algoritme.

Secret is een aaneenschakeling van App ID en Secret Key uit de webhooks instellingen.

Het is mogelijk om je eigen get params toe te voegen aan het eindpunt om de afzender te identificeren indien nodig.

Problemen oplossen

Een server moet binnen 10 seconden reageren en een HTTP-code 2XX terugsturen, anders wordt de levering van de webhook als mislukt beschouwd. In geval van mislukking zal de functie proberen het verzoek opnieuw te verzenden volgens het leveringsbeleid.