Icon by Coface

Coface ICON Business Information API

+

V2 - Data API

Back to main page Introduction Products Access & Security Process Global Company search Ordering report Ordering monitoring Technical documentation How To / FAQ

Products

This API allows you to order and monitor the following products:

Publication Available format Product type Samples Schemas Notification Schemas
Full Reports JSON, HTML, PDF, XML Report Full Report JSON JSON schema, XSD Schema Report Notification JSON schema, Report Notification XSD Schema
Snapshot Reports JSON, HTML, PDF, XML Report Snapshot JSON JSON schema, XSD Schema Report Notification JSON schema, Report Notification XSD Schema
Credit opinion Reports JSON, HTML, PDF, XML Report CO Report JSON JSON schema, XSD Schema CO Report Notification JSON schema, CO Report Notification XSD Schema
Advanced opinion Reports JSON, HTML, PDF, XML Report AO Report JSON JSON schema, XSD Schema AO Report Notification JSON schema, AO Report Notification XSD Schema
Score Report JSON, HTML, PDF, XML Report DRA Report JSON JSON schema, XSD Schema DRA Report Notification JSON schema, DRA Report Notification XSD Schema
Country Risk Assessment JSON Assessment CRA JSON JSON schema CRA Notification JSON schema, CRA Notification XSD Schema
Sector Risk Assessment JSON Assessment SRA JSON JSON schema SRA Notification JSON schema, SRA Notification XSD Schema
DRA Assessment (with and without history) JSON Assessment DRA package JSON DRA JSON schema, DRA package JSON Schema DRA Notification JSON schema, DRA package Notification JSON Schema, DRA Notification XSD Schema, DRA package Notification XSD Schema
Credit Opinion & Advanced Opinion Assessments JSON Assessment CO JSON, AO JSON CO Notification JSON schema, AO Notification JSON Schema CO Notification JSON schema, AO Notification JSON Schema, CO Notification XSD Schema, AO Notification XSD Schema
Late Payment Index JSON Assessment LPI JSON JSON schema LPI Notification JSON schema, LPI Notification XSD schema
Icon Global Financials JSON Financial IGF JSON Financial JSON schema Financial Notification JSON schema, Financial Notification XSD schema
Icon Local Financials JSON Financial Local Financial JSON Financial JSON schema Financial Notification JSON schema, Financial Notification XSD schema
URBA360 package JSON URBA URBA360 JSON

Notes:

You can find the list of standard products (assessments, reports or financials) together with their internal IDs in ICON application.

Also, in order to test your flow in the begining, recomendation is to use a Demo company. Please check the Demo companies list.

Business blocks which are part of Full Report can be checked on Business Blocks document.

Access & Security

Follow the process described in Coface Developer Portal Guide

Process

Global process

To order publication with ou without monitoring, you need to follow 5 steps :

  1. Find the company
  2. Check if the publication is available
  3. Order the publication with or without monitoring
  4. Verify that the order is finished
  5. Retrieve the publication

In case you have ordered a monitoring, during the next year, you can receive notifications. Once you get one, you can retrieve its content.

To order monitoring or report, you need to find on which company you want the data.

You always need to check if the company is still available because

  • companies are a living entity, it can disappear following a bankruptcy for example
  • Coface relies on partners to get the information for some countries. It happens that we decide to change partner if we find one with better information. In this case the company id can change.

Retrieving a company depends on the accuracy of your input :

  • if you know an unique identifier for this company (like icon number or use an unique id from a national referential, like VAT number), you will retrieve all identification data on this company (address, phone number, nace codes, legal forms, email, external id...)
  • if you don't then search a company with its name and address. You will receive a summary of matching companies. When you find the one you want, you can retrieve the full details about this company by calling the GET /companies with the external id provided in the summary.

Search company process
Company search process

  • Coface will try its best to answer you quickly. But in some countries, it can't be possible and Coface will need time to make an investigation. When you order your report, you will have the possibility to specify if you want immediate result or not.
  • Order for an Unknown company: You have the possibility to request a report even if you don't find the company in our database. A Coface agent will do an investigation and create a report if he finds the company or your orde will be finished with a so called Negative report. In this case, you will not be charged.
  • The time to process an order varies by country and provider. Please get in contact with your contact related to API usage for more details.
  • Callback mechanism: in case the order was not finished immediately, we offer you the possibility to be announced when the order is completed. We are doing this via Callback mechanism. You provide us inside the POST command, an URL that we will call when the order is finshed. we do not provide anything to you via that call, it is just a ping to your URL and we will retry several times if your URL is not available. We are not having any authentication method when calling your URL.
  • More details about all these flows and visual steps how to do it via Postman you can find under How to use Data API
Order a publication
Ordering a report

  • Sames indications as Ordering a publication
  • A monitoring is placed for 1 year
Order a monitoring
Ordering a report

Notification

Once your monitoring is placed, you will receive notifications when changes are made. If you have set a callback url in your monitoring order, we will ping you as soon as something changed, if not it's up to you to check any change.

Notification management
Notification management

URBA data via API

You can order URBA360 data in one call using a corresponding urba360 endpoint.

The result will be one big JSON file with all corresponding data inside. For details how to order, please check following link: How to order URBA360 via API

Monitoring and Notifications

If you want to order URBA360 package with monitoring, you can do it only after you have ordered a simple URBA360 order for the wanted company

You can place one monitoring order, via corresponding monitoring urba360 endpoint. When changes occur for the company, you can find all corresponding notifications via notifications endpoint or you can use the callback mechanism to be announced when something is changed. Even if you use the callback mechanism, after you are announced about changes, you would need to still go to notifications endpoint to retrieve them.

Depending on which part URBA is changed, the corresponding notification is created. Example: if the DRA value is changed, you will receive a DRA notification. To see how each notification looks like, please check the notifications samples in the table above.

Technical documentation

Swagger

Public available here

Also available on our dev portal , section DOCS.

Postman collection

You can test our API without any developpment using Postman.

You have to

  1. Download Postman
  2. Download our
  3. Modify the credentials in the environment settings

How To / FAQ

Set postman
  1. Import the files
  2. Click on "Environments" tab
  3. Select the environment you want to modify
  4. Change the initial value of credentials
  5. Click on "Persist All" to copy Initial value to Current value
  6. Save