TIC
Sign in to Lens

Companies

Download the company's risk model input

The facts TIC's risk model reads about the company, as a zip of the input files of the open model TIC Risk Open, to score with tic-risk score --input <dir>. Read when you ask, from the same data and with the same ids as TIC's own scores. Aktiebolag only. The API key needs the risk-model-input scope.

Max+ tier
GEThttps://lens-api.tic.io/companies/{id}/risk/model-input

The facts TIC’s risk model reads about the company, as a zip of the input files of the open model TIC Risk Open. Unzip it into a directory and score it with tic-risk score --input <dir> to get the same answer as TIC’s own scores. Run TIC Risk Open on API data describes the files, how to score them and how to add your own data.

The files are read when you ask, from the same data and with the same IDs as TIC’s own scores. Aktiebolag only. The API key needs the risk-model-input scope, which TIC adds on request. To name the company by its organisationsnummer instead, use the registration-number route.

Parameters

Parameter Default Description
asOf today The date the input is prepared for, YYYY-MM-DD
monthsBack 36 Also prepare it for the same day of each of this many months before asOf, 0 to 60, so the risk history the command draws reads every related company it needs

Response

200 with Content-Type: application/zip and a file name such as tic-risk-input-5566778899.zip. The files are at the root of the archive: meta.json, lives.csv, events.jsonl, relations.jsonl, economy.jsonl, sector.jsonl and calendar.jsonl. A company’s archive is typically 300-400 KB.

Header Description
X-Tic-Risk-Release The model release TIC scores with
X-Tic-Risk-Vocab-Hash Its vocabulary hash. When it equals vocab_hash in the downloaded model’s checkpoint/manifest.json, the model is the one TIC scores with

403 insufficient_permissions when the key lacks the scope, 422 legal_form_not_scored for a company that is not an aktiebolag, and 503 when the risk model is temporarily unavailable.

Authorization

x-api-keystringheaderrequired

Your API key, sent in the x-api-key header.

Path parameters

idintegerrequired

Internal company ID

format: int32

Query parameters

asOfstring

The as-of date, YYYY-MM-DD. Default today.

monthsBackinteger

Also read the input for the same day of each of this many months before the as-of date, so the risk history the command draws is scored from complete data. 0 to 60. Default 36, the months the command's chart shows.

format: int32 · default: 36

Responses

Zip archive of the model input files · application/zip

string