TrafficLight

Traffic-Light.co Developer Hub

Welcome to the TrafficLight developer hub. Comprehensive guides and documentation to help you get started with the Traffic-Light.co API as quickly as possible. If you get stuck, please ask for help in support!

Get Started    

Getting Started

Traffic-light.co, powered by Euler Hermes, provides a simple API you can use to check the financial health and default of payment risk of other companies. TrafficLight gives you access to an extensive database of information about companies in France, Europe, and the rest of the world.

At a Glance

The workflow to check a company through the API is quite simple:

  1. First, search for the company, by name or unique identifier (VAT number, SIREN, etc.).
  2. Once you've found the company, you can request information about its safety.

That's it! For more detail, please read on.

Registering a Demo Account

You can test our API by requesting access to our Demo environment which will not return real company ratings.

First, you will need to register a Developer Portal DEMO account here. After you have created your account and confirmed your email, we will give you access to the Traffic Light package and you will be able to generate an API key that will allow you to start testing.

The root url of our Demo environment is https://api-demo.single-invoice.co/v2/.

Registering a Live Account

First will need to register a Developer Portal LIVE account here. After you have created your account and confirmed your email, we will give you access to the Traffic Light package and you will be able to generate an API key that will allow you to start using the service Live.

The root url of our Live environment is https://api.single-invoice.co/v2/.

Getting information about a company

Let's get information about 35° EAST, a French company, as an example. The first step is to search the Traffic-Light.co database to find its record, its Traffic-Light.co unique identifier.

curl -X GET \
  'https://api-demo.single-invoice.co/v2/transactors?countrycode=FR&name=35%C2%B0%20EAST%0A' \
  -H 'Postman-Token: 51d5b1a9-4354-4b0a-93e6-2053c2d1c89d' \
  -H 'apikey: YOURAPIKEY' \
  -H 'cache-control: no-cache'
import requests

url = "https://api-demo.single-invoice.co/v2/transactors"

querystring = {"countrycode":"FR","name":"35%C2%B0%20EAST%0A"}

payload = ""
headers = {
    'apikey': "YOURAPIKEY",
    'cache-control': "no-cache",
    'Postman-Token': "9f41178a-1f5b-45da-ae52-694884068c0e"
    }

response = requests.request("GET", url, data=payload, headers=headers, params=querystring)

print(response.text)
<?php

$request = new HttpRequest();
$request->setUrl('https://api-demo.single-invoice.co/v2/transactors');
$request->setMethod(HTTP_METH_GET);

$request->setQueryData(array(
  'countrycode' => 'FR',
  'name' => '35%C2%B0%20EAST%0A'
));

$request->setHeaders(array(
  'Postman-Token' => '63974bb7-021d-46c6-be36-182058b53497',
  'cache-control' => 'no-cache',
  'apikey' => 'YOURAPIKEY'
));

try {
  $response = $request->send();

  echo $response->getBody();
} catch (HttpException $ex) {
  echo $ex;
}
GET /v2/transactors?countrycode=FR&amp; name=35%C2%B0%20EAST HTTP/1.1
Host: api-demo.single-invoice.co
apikey: YOURAPIKEY
cache-control: no-cache
Postman-Token: 55744955-c107-4696-8f6a-90bc3705cd2b

Be aware that when searching by name, there might be multiple results. You can also search with a company identifier from some company registry, for example a VAT number, a DUNS number, a SIREN number (in France), etc.

curl -X GET \
  https://api-demo.single-invoice.co/v2/transactor/fr/SIREN/493467609 \
  -H 'Postman-Token: 71573c98-8353-4aad-be58-fe5bd8d2c76e' \
  -H 'apikey: YOURAPIKEY' \
  -H 'cache-control: no-cache'
import requests

url = "https://api-demo.single-invoice.co/v2/transactor/fr/SIREN/493467609"

payload = ""
headers = {
    'apikey': "YOURAPIKEY",
    'cache-control': "no-cache",
    'Postman-Token': "dee05a8e-fed4-40a9-9fe2-c98302b21ed5"
    }

response = requests.request("GET", url, data=payload, headers=headers)

print(response.text)
<?php

$request = new HttpRequest();
$request->setUrl('https://api-demo.single-invoice.co/v2/transactor/fr/SIREN/493467609');
$request->setMethod(HTTP_METH_GET);

$request->setHeaders(array(
  'Postman-Token' => '10d7f476-65d4-4f91-af42-46b84d3d7f10',
  'cache-control' => 'no-cache',
  'apikey' => 'YOURAPIKEY'
));

try {
  $response = $request->send();

  echo $response->getBody();
} catch (HttpException $ex) {
  echo $ex;
}
GET /v2/transactor/fr/SIREN/493467609 HTTP/1.1
Host: api-demo.single-invoice.co
apikey: YOURAPIKEY
cache-control: no-cache
Postman-Token: c2b50649-9301-4373-8d29-57e2b0c449c1
{
    "Id": "9432824c-afc3-4f52-a04c-e4662f6e4766",
    "Name": "35° EAST",
    "Address": {
        "StreetNumber": "1",
        "StreetName": "PL DES SAISONS",
        "PostCode": "92048",
        "City": "COURBEVOIE",
        "StateCode": "92",
        "CountryCode": "FR",
        "Type": "main"
    },
    "PhoneNumber": null,
    "LegalFormCode": "SAS",
    "ExternalIds": [
        {
            "ExternalId": "85889366",
            "ExternalService": "eulerid"
        },
        {
            "ExternalId": "493467609",
            "ExternalService": "SIREN"
        },
        {
            "ExternalId": "FAKE85889366",
            "ExternalService": "FAKE"
        }
    ]
}

Once we have found the company, we can use its ID to query its rating.

curl -X GET \
  https://api-demo.single-invoice.co/v2/trafficlight/9432824c-afc3-4f52-a04c-e4662f6e4766 \
  -H 'Postman-Token: 307ebbab-316e-4a39-853c-8d5705172715' \
  -H 'apikey: YOUAPIKEY' \
  -H 'cache-control: no-cache'
import requests

url = "https://api-demo.single-invoice.co/v2/trafficlight/9432824c-afc3-4f52-a04c-e4662f6e4766"

payload = ""
headers = {
    'apikey': "YOURAPIKEY",
    'cache-control': "no-cache",
    'Postman-Token': "d6de3c22-ddc9-49b7-9d8d-d28f3e8a0da6"
    }

response = requests.request("GET", url, data=payload, headers=headers)

print(response.text)
<?php

$request = new HttpRequest();
$request->setUrl('https://api-demo.single-invoice.co/v2/trafficlight/9432824c-afc3-4f52-a04c-e4662f6e4766');
$request->setMethod(HTTP_METH_GET);

$request->setHeaders(array(
  'Postman-Token' => 'e6798c6d-2b10-4ecd-9ad6-e229ce659b20',
  'cache-control' => 'no-cache',
  'apikey' => 'YOURAPIKEY'
));

try {
  $response = $request->send();

  echo $response->getBody();
} catch (HttpException $ex) {
  echo $ex;
}
GET /v2/trafficlight/9432824c-afc3-4f52-a04c-e4662f6e4766 HTTP/1.1
Host: api-demo.single-invoice.co
apikey: YOURAPIKEY
cache-control: no-cache
Postman-Token: f43bffe1-e719-4b47-82ae-37a3d0adafc9
{
    "Color": "green"
}

The resulting JSON data contains information about the company:

  • color is the rating (green, yellow, red, black in ascending order of risk, or white if the company has no rating in our database)

Getting Started


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.