Guides

Coverage extension

Ask SESAMm to add new companies to its coverage

This route lets you add an entity to your actual coverage

This feature is currently experimental.

Adding an entity to your your coverage can take up to 24 hours.

Search for companies

As the entity you're looking for may not be covered yet, this route relies on external data sources. Availability and quality of the results may vary.

Using Get External Companies route, pass a company name, or any informations that would help to determine which company you are looking for.

This route will return informations about matches along with an external_id field.

Ask for coverage extension

Using Universe Coverage Extension route, pass one or multiple external_id from the previous step.

This route will return a task_id, which you can use to track the status of your request.

If the company was already known it will be added to the universe, and in addition to that, the companies coverage might be improved.

If the company was not known, the task will extract information from various sources to build the company profile. Data about that company will be retrieved on the next day. (documents, cases..)

Check the result of your request

Using Download Task Result with the task_id you received, you can get a log of the request.

This file will be a .jsonl file, with one line per requested company. Each line will contain a JSON object with the following fields:


Content of the log file

  • external_id*string

    The external ID of the company. Corresponds to the extenal_id used as input.

    Example: "fW6B4Opk4JrvEJUKK_kn0_wosJ4fmsbqSIo9UPhXoaGxD4tZjw"
  • status*string (enum)

    Whether the company was successfully added to the universe or not.

    Values: "success", "error"
  • entity_iduuid

    SESAMm unique ID of the new entity.

    Example: "29ad6e3a-f690-4ab9-a7cd-3e99e4825e80"
Example of a log
{"external_id": "fW6B4Opk4JrvEJUKK_kn0_wosJ4fmsbqSIo9UPhXoaGxD4tZjw", "entity_id": "bed4119b-a6bf-5fe9-8771-a7da3495469f", "status": "success"}
{"external_id": "Omlj2Vow7MvRZny7m90ISHcY-dPqmUYnwacng4Cx1k2GCsIyCQ", "status": "error"}