TIC
Sign in to Lens

Companies

Download the company's risk model input by registration number

Same as GET /companies/{id}/risk/model-input, with the company named by its Swedish organisationsnummer: ten digits with or without the dash (556677-8899 or 5566778899), or twelve with the 16 prefix. Aktiebolag only. The API key needs the risk-model-input scope.

Max+ tier
GEThttps://lens-api.tic.io/companies/by-registration-number/{registrationNumber}/risk/model-input

The same archive as Download the company’s risk model input, with the company named by its Swedish organisationsnummer instead of its internal ID. Run TIC Risk Open on API data describes the files and how to score them.

The number can be written with or without the dash (556677-8899 or 5566778899), or with twelve digits and the 16 prefix. A number that is not a valid organisationsnummer returns 400 with the code invalid_registration_number, and one that no Swedish company has returns 404.

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

Access, the response and the other errors are those of the ID route: a plan with max or enterprise, the risk-model-input scope on the API key, and aktiebolag only.

Authorization

x-api-keystringheaderrequired

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

Path parameters

registrationNumberstringrequired

Swedish organisationsnummer, e.g. `556677-8899` or `5566778899`

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