IOXIO Dataspace Sandbox

redocly logoAPI docs by Redocly

Product Gateway (1.0.0)

Download OpenAPI specification:Download

Product Gateway to fetch Data Products from registered data sources in the Dataspace.

Data Products

Current air quality in a given location

Current Air Quality Index (AQI) in a given location with attribution of the sources

query Parameters
source
required
string (Source)
header Parameters
authorization
string (User bearer token)

The login token. Value should be "Bearer [token]"

x-authorization-provider
string (Source of the token)

The bare domain of the system that provided the token

x-consent-token
string (Consent token)

Consent token to provide to data sources that require a consent

x-preview-token
string (Preview token)

Optional authentication token for unpublished data sources

signature
string (HTTP Message Signature)

Optional HTTP Message Signature

signature-input
string (HTTP Message Signature Input)

Description of HTTP Message signature if one provided

content-digest
string (Content digest of body)

Optional content digest of request body

Request Body schema: application/json
required
lat
required
number (Latitude) [ -90 .. 90 ]

The latitude coordinate of the desired location

lon
required
number (Longitude) [ -180 .. 180 ]

The longitude coordinate of the desired location

Responses

Request samples

Content type
application/json
{
  • "lat": 60.192059,
  • "lon": 24.945831
}

Response samples

Content type
application/json
{
  • "airQualityIndex": 30,
  • "timestamp": "2020-04-03T13:00:00Z",
  • "attribution": [
    ]
}

Basic information about a company

Legal information about a company such as company registration date

query Parameters
source
required
string (Source)
header Parameters
authorization
string (User bearer token)

The login token. Value should be "Bearer [token]"

x-authorization-provider
string (Source of the token)

The bare domain of the system that provided the token

x-consent-token
string (Consent token)

Consent token to provide to data sources that require a consent

x-preview-token
string (Preview token)

Optional authentication token for unpublished data sources

signature
string (HTTP Message Signature)

Optional HTTP Message Signature

signature-input
string (HTTP Message Signature Input)

Description of HTTP Message signature if one provided

content-digest
string (Content digest of body)

Optional content digest of request body

Request Body schema: application/json
required
companyId
required
string (Company ID)

The ID of the company

Responses

Request samples

Content type
application/json
{
  • "companyId": "2464491-9"
}

Response samples

Content type
application/json
{
  • "name": "Digital Living International Oy",
  • "companyId": "2464491-9",
  • "companyForm": "LLC",
  • "registrationDate": "2012-02-23"
}

Company recommendations based on keywords

Recommendation of companies based on provided keywords. Each result has a score.

query Parameters
source
required
string (Source)
header Parameters
authorization
string (User bearer token)

The login token. Value should be "Bearer [token]"

x-authorization-provider
string (Source of the token)

The bare domain of the system that provided the token

x-consent-token
string (Consent token)

Consent token to provide to data sources that require a consent

x-preview-token
string (Preview token)

Optional authentication token for unpublished data sources

signature
string (HTTP Message Signature)

Optional HTTP Message Signature

signature-input
string (HTTP Message Signature Input)

Description of HTTP Message signature if one provided

content-digest
string (Content digest of body)

Optional content digest of request body

Request Body schema: application/json
required
keywords
required
string (Keywords)

Keyword data to base recommendations on

Responses

Request samples

Content type
application/json
{
  • "keywords": "Looking for data product companies to invest on"
}

Response samples

Content type
application/json
{
  • "results": [
    ]
}

List of the shareholders of a company

Information about the shareholders of a company such as owners and shares quantity.

query Parameters
source
required
string (Source)
header Parameters
authorization
string (User bearer token)

The login token. Value should be "Bearer [token]"

x-authorization-provider
string (Source of the token)

The bare domain of the system that provided the token

x-consent-token
string (Consent token)

Consent token to provide to data sources that require a consent

x-preview-token
string (Preview token)

Optional authentication token for unpublished data sources

signature
string (HTTP Message Signature)

Optional HTTP Message Signature

signature-input
string (HTTP Message Signature Input)

Description of HTTP Message signature if one provided

content-digest
string (Content digest of body)

Optional content digest of request body

Request Body schema: application/json
required
companyId
required
string (Company ID)

The ID of the company, only supports Finnish business ID's

Responses

Request samples

Content type
application/json
{
  • "companyId": "2464491-9"
}

Response samples

Content type
application/json
{
  • "shareSeries": [
    ],
  • "owners": [
    ]
}

Battery product data sheet

Technical details of a battery such as capacity and voltage

query Parameters
source
required
string (Source)
header Parameters
authorization
string (User bearer token)

The login token. Value should be "Bearer [token]"

x-authorization-provider
string (Source of the token)

The bare domain of the system that provided the token

x-consent-token
string (Consent token)

Consent token to provide to data sources that require a consent

x-preview-token
string (Preview token)

Optional authentication token for unpublished data sources

signature
string (HTTP Message Signature)

Optional HTTP Message Signature

signature-input
string (HTTP Message Signature Input)

Description of HTTP Message signature if one provided

content-digest
string (Content digest of body)

Optional content digest of request body

Request Body schema: application/json
required
product
required
string (Product identifier)

Technical product identifier used by the manufacturer

id
required
string (Identifier)

Unique identifier of the product

Responses

Request samples

Content type
application/json
{
  • "product": "battery-100wh-s",
  • "id": "177389-09633"
}

Response samples

Content type
application/json
{
  • "manufacturer": "Valmet Automotive",
  • "product": "battery-100wh-s",
  • "id": "177389-09633",
  • "name": "Modular Power Pack, 48 V",
  • "cellType": "lithium-titanate",
  • "capacity": 2.2,
  • "energy": 46,
  • "voltage": {
    },
  • "peakDischargingPower": 20,
  • "peakChargingPower": 20,
  • "continuousPower": 10,
  • "standbyConsumption": 1,
  • "cycleLife": 20000,
  • "dimensions": {
    },
  • "weight": 41,
  • "operatingTemperature": {
    },
  • "ipRating": "IP6K9K",
  • "maxCoolantPressure": 3.5,
  • "standardsCompliance": [
    ]
}

Charging history of a battery

Charging history of a battery

query Parameters
source
required
string (Source)
header Parameters
authorization
string (User bearer token)

The login token. Value should be "Bearer [token]"

x-authorization-provider
string (Source of the token)

The bare domain of the system that provided the token

x-consent-token
string (Consent token)

Consent token to provide to data sources that require a consent

x-preview-token
string (Preview token)

Optional authentication token for unpublished data sources

signature
string (HTTP Message Signature)

Optional HTTP Message Signature

signature-input
string (HTTP Message Signature Input)

Description of HTTP Message signature if one provided

content-digest
string (Content digest of body)

Optional content digest of request body

Request Body schema: application/json
required
serialNumber
required
string (Serial Number)

The serial number of the battery

start
string <date-time> (Start Time)

Include history entries starting from this time (inclusive)

end
string <date-time> (End Time)

Include history entries until this time (exclusive)

limit
integer (Limit) [ 1 .. 100 ]
Default: 100

Limit number of history entries to return

offset
integer (Offset) >= 0
Default: 0

Offset of history records to return

Responses

Request samples

Content type
application/json
{
  • "serialNumber": "MPP48V-296cde7f",
  • "start": "2022-09-09T00:00:00",
  • "end": "2022-09-10T00:00:00",
  • "limit": 100,
  • "offset": 0
}

Response samples

Content type
application/json
{
  • "batteryChargingHistory": [
    ],
  • "totalCount": 1
}

Battery product data sheet

Technical details of a battery such as capacity and voltage

query Parameters
source
required
string (Source)
header Parameters
authorization
string (User bearer token)

The login token. Value should be "Bearer [token]"

x-authorization-provider
string (Source of the token)

The bare domain of the system that provided the token

x-consent-token
string (Consent token)

Consent token to provide to data sources that require a consent

x-preview-token
string (Preview token)

Optional authentication token for unpublished data sources

signature
string (HTTP Message Signature)

Optional HTTP Message Signature

signature-input
string (HTTP Message Signature Input)

Description of HTTP Message signature if one provided

content-digest
string (Content digest of body)

Optional content digest of request body

Request Body schema: application/json
required
productCode
required
string (Product Code)

The product code used by the manufacturer

Responses

Request samples

Content type
application/json
{
  • "productCode": "MPP48V"
}

Response samples

Content type
application/json
{
  • "manufacturer": "Valmet Automotive",
  • "productCode": "MPP48V",
  • "name": "Modular Power Pack, 48 V",
  • "cellType": "lithium-titanate",
  • "capacity": 2.2,
  • "energy": 46,
  • "voltage": {
    },
  • "peakDischargingPower": 20,
  • "peakChargingPower": 20,
  • "continuousPower": 10,
  • "standbyConsumption": 1,
  • "cycleLife": 20000,
  • "dimensions": {
    },
  • "weight": 41,
  • "operatingTemperature": {
    },
  • "ipRating": "IP6K9K",
  • "maxCoolantPressure": 3.5,
  • "standardsCompliance": [
    ]
}

Persons health diagnoses

Diagnoses of a user with ICD10 codes

query Parameters
source
required
string (Source)
header Parameters
authorization
string (User bearer token)

The login token. Value should be "Bearer [token]"

x-authorization-provider
string (Source of the token)

The bare domain of the system that provided the token

x-consent-token
string (Consent token)

Consent token to provide to data sources that require a consent

x-preview-token
string (Preview token)

Optional authentication token for unpublished data sources

signature
string (HTTP Message Signature)

Optional HTTP Message Signature

signature-input
string (HTTP Message Signature Input)

Description of HTTP Message signature if one provided

content-digest
string (Content digest of body)

Optional content digest of request body

Request Body schema: application/json
required
object (HealthDiagnosesRequest)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "diagnoses": [
    ]
}

Create key assignment

Assign a key to have access to a specific lock

query Parameters
source
required
string (Source)
header Parameters
authorization
string (User bearer token)

The login token. Value should be "Bearer [token]"

x-authorization-provider
string (Source of the token)

The bare domain of the system that provided the token

x-consent-token
string (Consent token)

Consent token to provide to data sources that require a consent

x-preview-token
string (Preview token)

Optional authentication token for unpublished data sources

signature
string (HTTP Message Signature)

Optional HTTP Message Signature

signature-input
string (HTTP Message Signature Input)

Description of HTTP Message signature if one provided

content-digest
string (Content digest of body)

Optional content digest of request body

Request Body schema: application/json
required
keyId
required
string (Key ID) non-empty ^[0-9a-f]+$

UID of a key as a hex encoded string without delimiters

lockId
required
string (Lock ID) non-empty

Vendor specific ID for a lock

sharedSecret
required
string (Shared Secret)

Shared secret between the productizer and the system using it

Responses

Request samples

Content type
application/json
{
  • "keyId": "a1b2c3d4e5f6890",
  • "lockId": "12345678",
  • "sharedSecret": "string"
}

Response samples

Content type
application/json
{
  • "keyId": "a1b2c3d4e5f6890",
  • "lockId": "12345678"
}

Delete key assignment

Remove a key from having access to a specific lock

query Parameters
source
required
string (Source)
header Parameters
authorization
string (User bearer token)

The login token. Value should be "Bearer [token]"

x-authorization-provider
string (Source of the token)

The bare domain of the system that provided the token

x-consent-token
string (Consent token)

Consent token to provide to data sources that require a consent

x-preview-token
string (Preview token)

Optional authentication token for unpublished data sources

signature
string (HTTP Message Signature)

Optional HTTP Message Signature

signature-input
string (HTTP Message Signature Input)

Description of HTTP Message signature if one provided

content-digest
string (Content digest of body)

Optional content digest of request body

Request Body schema: application/json
required
keyId
required
string (Key ID) non-empty ^[0-9a-f]+$

UID of a key as a hex encoded string without delimiters

lockId
required
string (Lock ID) non-empty

Vendor specific ID for a lock

sharedSecret
required
string (Shared Secret)

Shared secret between the productizer and the system using it

Responses

Request samples

Content type
application/json
{
  • "keyId": "a1b2c3d4e5f6890",
  • "lockId": "12345678",
  • "sharedSecret": "string"
}

Response samples

Content type
application/json
{
  • "keyId": "a1b2c3d4e5f6890",
  • "lockId": "12345678"
}

Check if lock assignment exists

Check if a key has access to a specific lock

query Parameters
source
required
string (Source)
header Parameters
authorization
string (User bearer token)

The login token. Value should be "Bearer [token]"

x-authorization-provider
string (Source of the token)

The bare domain of the system that provided the token

x-consent-token
string (Consent token)

Consent token to provide to data sources that require a consent

x-preview-token
string (Preview token)

Optional authentication token for unpublished data sources

signature
string (HTTP Message Signature)

Optional HTTP Message Signature

signature-input
string (HTTP Message Signature Input)

Description of HTTP Message signature if one provided

content-digest
string (Content digest of body)

Optional content digest of request body

Request Body schema: application/json
required
keyId
required
string (Key ID) non-empty ^[0-9a-f]+$

UID of a key as a hex encoded string without delimiters

lockId
required
string (Lock ID) non-empty

Vendor specific ID for a lock

sharedSecret
required
string (Shared Secret)

Shared secret between the productizer and the system using it

Responses

Request samples

Content type
application/json
{
  • "keyId": "a1b2c3d4e5f6890",
  • "lockId": "12345678",
  • "sharedSecret": "string"
}

Response samples

Content type
application/json
{
  • "exists": true
}

NSG Agent information

In the Nordic Smart Government information exchange context the agent represents both registered organizations ("companies") and persons who are doing business without being registered organizations, usually as sole traders (sole proprietors). This data product definition returns basic information content for any agent.

query Parameters
source
required
string (Source)
header Parameters
authorization
string (User bearer token)

The login token. Value should be "Bearer [token]"

x-authorization-provider
string (Source of the token)

The bare domain of the system that provided the token

x-consent-token
string (Consent token)

Consent token to provide to data sources that require a consent

x-preview-token
string (Preview token)

Optional authentication token for unpublished data sources

signature
string (HTTP Message Signature)

Optional HTTP Message Signature

signature-input
string (HTTP Message Signature Input)

Description of HTTP Message signature if one provided

content-digest
string (Content digest of body)

Optional content digest of request body

Request Body schema: application/json
required
nationalIdentifier
required
string (National Identifier)

National identifier for a legal entity

Responses

Request samples

Content type
application/json
{
  • "nationalIdentifier": "2464491-9"
}

Response samples

Content type
application/json
{
  • "name": "Oy Example Ab",
  • "legalForm": "FI_OY",
  • "legalStatus": "NORMAL",
  • "registrationDate": "2019-08-24",
  • "registeredAddress": {
    }
}

Beneficial owners of a non-listed company

The list of beneficial owners of a non-listed company. The shareholders exceeding 25 % ownership.

query Parameters
source
required
string (Source)
header Parameters
authorization
required
string (User bearer token)

The login token. Value should be "Bearer [token]"

x-authorization-provider
string (Source of the token)

The bare domain of the system that provided the token

x-consent-token
required
string (Consent token)

Consent token to provide to data sources that require a consent

x-preview-token
string (Preview token)

Optional authentication token for unpublished data sources

signature
string (HTTP Message Signature)

Optional HTTP Message Signature

signature-input
string (HTTP Message Signature Input)

Description of HTTP Message signature if one provided

content-digest
string (Content digest of body)

Optional content digest of request body

Request Body schema: application/json
required
nationalIdentifier
required
string (National identifier) <= 40 characters

The national identifier of the non-listed company issued by the trade register in any Nordic country.

Responses

Request samples

Content type
application/json
{
  • "nationalIdentifier": "FIN: 2464491-9 / SWE: 5560125791 / NOR: 923609016"
}

Response samples

Content type
application/json
{
  • "shareSeries": [
    ],
  • "shareholders": [
    ]
}

Signatory rights of a non-listed company

The list of representation rights of a legal entity

query Parameters
source
required
string (Source)
header Parameters
authorization
required
string (User bearer token)

The login token. Value should be "Bearer [token]"

x-authorization-provider
string (Source of the token)

The bare domain of the system that provided the token

x-consent-token
required
string (Consent token)

Consent token to provide to data sources that require a consent

x-preview-token
string (Preview token)

Optional authentication token for unpublished data sources

signature
string (HTTP Message Signature)

Optional HTTP Message Signature

signature-input
string (HTTP Message Signature Input)

Description of HTTP Message signature if one provided

content-digest
string (Content digest of body)

Optional content digest of request body

Request Body schema: application/json
required
nationalIdentifier
required
string (National identifier) <= 40 characters

The national identifier of the non-listed company issued by the trade register

Responses

Request samples

Content type
application/json
{
  • "nationalIdentifier": "FIN: 2464491-9 / SWE: 5560125791 / NOR: 923609016"
}

Response samples

Content type
application/json
{
  • "signatoryRights": [
    ]
}

Establish a non-listed company

Create the initial set of data to establish a non-listed company

query Parameters
source
required
string (Source)
header Parameters
authorization
required
string (User bearer token)

The login token. Value should be "Bearer [token]"

x-authorization-provider
string (Source of the token)

The bare domain of the system that provided the token

x-consent-token
string (Consent token)

Consent token to provide to data sources that require a consent

x-preview-token
string (Preview token)

Optional authentication token for unpublished data sources

signature
string (HTTP Message Signature)

Optional HTTP Message Signature

signature-input
string (HTTP Message Signature Input)

Description of HTTP Message signature if one provided

content-digest
string (Content digest of body)

Optional content digest of request body

Request Body schema: application/json
required
required
object (Registrant)

The personal details of the person registering the company

required
object (Company details)

The details of the company being established

required
Array of objects (Share series)

The details of the share series of the company

required
object (Company address)

The official address of the company

required
Array of objects (Managing directors)
required
Array of objects (Board members)
required
object (Auditor details)

The details of the company and person auditing the company

Responses

Request samples

Content type
application/json
{
  • "registrant": {
    },
  • "companyDetails": {
    },
  • "shareSeries": [
    ],
  • "companyAddress": {
    },
  • "managingDirectors": [
    ],
  • "boardMembers": [
    ],
  • "auditorDetails": {
    }
}

Response samples

Content type
application/json
{
  • "registrant": {
    },
  • "companyDetails": {
    },
  • "shareSeries": [
    ],
  • "companyAddress": {
    },
  • "managingDirectors": [
    ],
  • "boardMembers": [
    ],
  • "auditorDetails": {
    }
}

Person details

Details about a person such as home address

query Parameters
source
required
string (Source)
header Parameters
authorization
required
string (User bearer token)

The login token. Value should be "Bearer [token]"

x-authorization-provider
string (Source of the token)

The bare domain of the system that provided the token

x-consent-token
string (Consent token)

Consent token to provide to data sources that require a consent

x-preview-token
string (Preview token)

Optional authentication token for unpublished data sources

signature
string (HTTP Message Signature)

Optional HTTP Message Signature

signature-input
string (HTTP Message Signature Input)

Description of HTTP Message signature if one provided

content-digest
string (Content digest of body)

Optional content digest of request body

Request Body schema: application/json
required
object (PersonDetailsRequest)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "name": "Joshua Gray",
  • "address": "6 Raymond river\nRileybury\nCR3 6XA"
}

Environmental footprint information for a product

Information about environmental footprint of a product in the manufacturing phase

query Parameters
source
required
string (Source)
header Parameters
authorization
string (User bearer token)

The login token. Value should be "Bearer [token]"

x-authorization-provider
string (Source of the token)

The bare domain of the system that provided the token

x-consent-token
string (Consent token)

Consent token to provide to data sources that require a consent

x-preview-token
string (Preview token)

Optional authentication token for unpublished data sources

signature
string (HTTP Message Signature)

Optional HTTP Message Signature

signature-input
string (HTTP Message Signature Input)

Description of HTTP Message signature if one provided

content-digest
string (Content digest of body)

Optional content digest of request body

Request Body schema: application/json
required
serialNumber
required
string (Serial Number)

The serial number given by the manufacturer

Responses

Request samples

Content type
application/json
{
  • "serialNumber": "MPP48V-296cde7f"
}

Response samples

Content type
application/json
{
  • "carbonEquivalent": 200,
  • "materialWaste": 8
}

Current time in a given country

Get the current time in a given country based on the ISO 3166-1 alpha-2 country code, formatted in RFC 3339 format

query Parameters
source
required
string (Source)
header Parameters
authorization
string (User bearer token)

The login token. Value should be "Bearer [token]"

x-authorization-provider
string (Source of the token)

The bare domain of the system that provided the token

x-consent-token
string (Consent token)

Consent token to provide to data sources that require a consent

x-preview-token
string (Preview token)

Optional authentication token for unpublished data sources

signature
string (HTTP Message Signature)

Optional HTTP Message Signature

signature-input
string (HTTP Message Signature Input)

Description of HTTP Message signature if one provided

content-digest
string (Content digest of body)

Optional content digest of request body

Request Body schema: application/json
required
countryCode
required
any (ISO 3166-1 alpha-2 country code)
Enum: "ad" "ae" "af" "ag" "ai" "al" "am" "ao" "aq" "ar" "as" "at" "au" "aw" "ax" "az" "ba" "bb" "bd" "be" "bf" "bg" "bh" "bi" "bj" "bl" "bm" "bn" "bo" "bq" "br" "bs" "bt" "bv" "bw" "by" "bz" "ca" "cc" "cd" "cf" "cg" "ch" "ci" "ck" "cl" "cm" "cn" "co" "cr" "cu" "cv" "cw" "cx" "cy" "cz" "de" "dj" "dk" "dm" "do" "dz" "ec" "ee" "eg" "eh" "er" "es" "et" "fi" "fj" "fk" "fm" "fo" "fr" "ga" "gb" "gd" "ge" "gf" "gg" "gh" "gi" "gl" "gm" "gn" "gp" "gq" "gr" "gs" "gt" "gu" "gw" "gy" "hk" "hm" "hn" "hr" "ht" "hu" "id" "ie" "il" "im" "in" "io" "iq" "ir" "is" "it" "je" "jm" "jo" "jp" "ke" "kg" "kh" "ki" "km" "kn" "kp" "kr" "kw" "ky" "kz" "la" "lb" "lc" "li" "lk" "lr" "ls" "lt" "lu" "lv" "ly" "ma" "mc" "md" "me" "mf" "mg" "mh" "mk" "ml" "mm" "mn" "mo" "mp" "mq" "mr" "ms" "mt" "mu" "mv" "mw" "mx" "my" "mz" "na" "nc" "ne" "nf" "ng" "ni" "nl" "no" "np" "nr" "nu" "nz" "om" "pa" "pe" "pf" "pg" "ph" "pk" "pl" "pm" "pn" "pr" "ps" "pt" "pw" "py" "qa" "re" "ro" "rs" "ru" "rw" "sa" "sb" "sc" "sd" "se" "sg" "sh" "si" "sj" "sk" "sl" "sm" "sn" "so" "sr" "ss" "st" "sv" "sx" "sy" "sz" "tc" "td" "tf" "tg" "th" "tj" "tk" "tl" "tm" "tn" "to" "tr" "tt" "tv" "tw" "tz" "ua" "ug" "um" "us" "uy" "uz" "va" "vc" "ve" "vg" "vi" "vn" "vu" "wf" "ws" "ye" "yt" "za" "zm" "zw"

An enumeration.

Responses

Request samples

Content type
application/json
{
  • "countryCode": "ad"
}

Response samples

Content type
application/json
{
  • "currentTime": "string"
}

Current weather in a given location

Common data points about the current weather with metric units in a given location. Simplified for example use, and not following industry standards.

query Parameters
source
required
string (Source)
header Parameters
authorization
string (User bearer token)

The login token. Value should be "Bearer [token]"

x-authorization-provider
string (Source of the token)

The bare domain of the system that provided the token

x-consent-token
string (Consent token)

Consent token to provide to data sources that require a consent

x-preview-token
string (Preview token)

Optional authentication token for unpublished data sources

signature
string (HTTP Message Signature)

Optional HTTP Message Signature

signature-input
string (HTTP Message Signature Input)

Description of HTTP Message signature if one provided

content-digest
string (Content digest of body)

Optional content digest of request body

Request Body schema: application/json
required
lat
required
number (Latitude) [ -90 .. 90 ]

The latitude coordinate of the desired location

lon
required
number (Longitude) [ -180 .. 180 ]

The longitude coordinate of the desired location

Responses

Request samples

Content type
application/json
{
  • "lat": 60.192059,
  • "lon": 24.945831
}

Response samples

Content type
application/json
{
  • "humidity": 72,
  • "pressure": 1007,
  • "rain": true,
  • "temp": 17.3,
  • "windSpeed": 2.1,
  • "windDirection": 220
}

Current air quality in a given location Deprecated

Current Air Quality Index (AQI) in a given location with attribution of the sources

query Parameters
source
required
string (Source)
header Parameters
authorization
string (User bearer token)

The login token. Value should be "Bearer [token]"

x-authorization-provider
string (Source of the token)

The bare domain of the system that provided the token

x-consent-token
string (Consent token)

Consent token to provide to data sources that require a consent

x-preview-token
string (Preview token)

Optional authentication token for unpublished data sources

signature
string (HTTP Message Signature)

Optional HTTP Message Signature

signature-input
string (HTTP Message Signature Input)

Description of HTTP Message signature if one provided

content-digest
string (Content digest of body)

Optional content digest of request body

Request Body schema: application/json
required
lat
required
number (Latitude) [ -90 .. 90 ]

The latitude coordinate of the desired location

lon
required
number (Longitude) [ -180 .. 180 ]

The longitude coordinate of the desired location

Responses

Request samples

Content type
application/json
{
  • "lat": 60.192059,
  • "lon": 24.945831
}

Response samples

Content type
application/json
{
  • "airQualityIndex": 30,
  • "timestamp": "2020-04-03T13:00:00Z",
  • "attribution": [
    ]
}

Basic information about a company Deprecated

Legal information about a company such as company registration date

query Parameters
source
required
string (Source)
header Parameters
authorization
string (User bearer token)

The login token. Value should be "Bearer [token]"

x-authorization-provider
string (Source of the token)

The bare domain of the system that provided the token

x-consent-token
string (Consent token)

Consent token to provide to data sources that require a consent

x-preview-token
string (Preview token)

Optional authentication token for unpublished data sources

signature
string (HTTP Message Signature)

Optional HTTP Message Signature

signature-input
string (HTTP Message Signature Input)

Description of HTTP Message signature if one provided

content-digest
string (Content digest of body)

Optional content digest of request body

Request Body schema: application/json
required
companyId
required
string (Company ID)

The ID of the company

Responses

Request samples

Content type
application/json
{
  • "companyId": "2464491-9"
}

Response samples

Content type
application/json
{
  • "name": "Digital Living International Oy",
  • "companyId": "2464491-9",
  • "companyForm": "LLC",
  • "registrationDate": "2012-02-23"
}

Company recommendations based on keywords Deprecated

Recommendation of companies based on provided keywords. Each result has a score.

query Parameters
source
required
string (Source)
header Parameters
authorization
string (User bearer token)

The login token. Value should be "Bearer [token]"

x-authorization-provider
string (Source of the token)

The bare domain of the system that provided the token

x-consent-token
string (Consent token)

Consent token to provide to data sources that require a consent

x-preview-token
string (Preview token)

Optional authentication token for unpublished data sources

signature
string (HTTP Message Signature)

Optional HTTP Message Signature

signature-input
string (HTTP Message Signature Input)

Description of HTTP Message signature if one provided

content-digest
string (Content digest of body)

Optional content digest of request body

Request Body schema: application/json
required
keywords
required
string (Keywords)

Keyword data to base recommendations on

Responses

Request samples

Content type
application/json
{
  • "keywords": "Looking for data product companies to invest on"
}

Response samples

Content type
application/json
{
  • "results": [
    ]
}

List of the shareholders of a company Deprecated

Information about the shareholders of a company such as owners and shares quantity.

query Parameters
source
required
string (Source)
header Parameters
authorization
string (User bearer token)

The login token. Value should be "Bearer [token]"

x-authorization-provider
string (Source of the token)

The bare domain of the system that provided the token

x-consent-token
string (Consent token)

Consent token to provide to data sources that require a consent

x-preview-token
string (Preview token)

Optional authentication token for unpublished data sources

signature
string (HTTP Message Signature)

Optional HTTP Message Signature

signature-input
string (HTTP Message Signature Input)

Description of HTTP Message signature if one provided

content-digest
string (Content digest of body)

Optional content digest of request body

Request Body schema: application/json
required
companyId
required
string (Company ID)

The ID of the company, only supports Finnish business ID's

Responses

Request samples

Content type
application/json
{
  • "companyId": "2464491-9"
}

Response samples

Content type
application/json
{
  • "shareSeries": [
    ],
  • "owners": [
    ]
}

Charging history of a battery Deprecated

Charging history of a battery

query Parameters
source
required
string (Source)
header Parameters
authorization
string (User bearer token)

The login token. Value should be "Bearer [token]"

x-authorization-provider
string (Source of the token)

The bare domain of the system that provided the token

x-consent-token
string (Consent token)

Consent token to provide to data sources that require a consent

x-preview-token
string (Preview token)

Optional authentication token for unpublished data sources

signature
string (HTTP Message Signature)

Optional HTTP Message Signature

signature-input
string (HTTP Message Signature Input)

Description of HTTP Message signature if one provided

content-digest
string (Content digest of body)

Optional content digest of request body

Request Body schema: application/json
required
serialNumber
required
string (Serial Number)

The serial number of the battery

start
string <date-time> (Start Time)

Include history entries starting from this time (inclusive)

end
string <date-time> (End Time)

Include history entries until this time (exclusive)

limit
integer (Limit) [ 1 .. 100 ]
Default: 100

Limit number of history entries to return

offset
integer (Offset) >= 0
Default: 0

Offset of history records to return

Responses

Request samples

Content type
application/json
{
  • "serialNumber": "MPP48V-296cde7f",
  • "start": "2022-09-09T00:00:00",
  • "end": "2022-09-10T00:00:00",
  • "limit": 100,
  • "offset": 0
}

Response samples

Content type
application/json
{
  • "batteryChargingHistory": [
    ],
  • "totalCount": 1
}

Battery product data sheet Deprecated

Technical details of a battery such as capacity and voltage

query Parameters
source
required
string (Source)
header Parameters
authorization
string (User bearer token)

The login token. Value should be "Bearer [token]"

x-authorization-provider
string (Source of the token)

The bare domain of the system that provided the token

x-consent-token
string (Consent token)

Consent token to provide to data sources that require a consent

x-preview-token
string (Preview token)

Optional authentication token for unpublished data sources

signature
string (HTTP Message Signature)

Optional HTTP Message Signature

signature-input
string (HTTP Message Signature Input)

Description of HTTP Message signature if one provided

content-digest
string (Content digest of body)

Optional content digest of request body

Request Body schema: application/json
required
productCode
required
string (Product Code)

The product code used by the manufacturer

Responses

Request samples

Content type
application/json
{
  • "productCode": "MPP48V"
}

Response samples

Content type
application/json
{
  • "manufacturer": "Valmet Automotive",
  • "productCode": "MPP48V",
  • "name": "Modular Power Pack, 48 V",
  • "cellType": "lithium-titanate",
  • "capacity": 2.2,
  • "energy": 46,
  • "voltage": {
    },
  • "peakDischargingPower": 20,
  • "peakChargingPower": 20,
  • "continuousPower": 10,
  • "standbyConsumption": 1,
  • "cycleLife": 20000,
  • "dimensions": {
    },
  • "weight": 41,
  • "operatingTemperature": {
    },
  • "ipRating": "IP6K9K",
  • "maxCoolantPressure": 3.5,
  • "standardsCompliance": [
    ]
}

Persons health diagnoses Deprecated

Diagnoses of a user with ICD10 codes

query Parameters
source
required
string (Source)
header Parameters
authorization
string (User bearer token)

The login token. Value should be "Bearer [token]"

x-authorization-provider
string (Source of the token)

The bare domain of the system that provided the token

x-consent-token
string (Consent token)

Consent token to provide to data sources that require a consent

x-preview-token
string (Preview token)

Optional authentication token for unpublished data sources

signature
string (HTTP Message Signature)

Optional HTTP Message Signature

signature-input
string (HTTP Message Signature Input)

Description of HTTP Message signature if one provided

content-digest
string (Content digest of body)

Optional content digest of request body

Request Body schema: application/json
required
object (HealthDiagnosesRequest)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "diagnoses": [
    ]
}

Create key assignment Deprecated

Assign a key to have access to a specific lock

query Parameters
source
required
string (Source)
header Parameters
authorization
string (User bearer token)

The login token. Value should be "Bearer [token]"

x-authorization-provider
string (Source of the token)

The bare domain of the system that provided the token

x-consent-token
string (Consent token)

Consent token to provide to data sources that require a consent

x-preview-token
string (Preview token)

Optional authentication token for unpublished data sources

signature
string (HTTP Message Signature)

Optional HTTP Message Signature

signature-input
string (HTTP Message Signature Input)

Description of HTTP Message signature if one provided

content-digest
string (Content digest of body)

Optional content digest of request body

Request Body schema: application/json
required
keyId
required
string (Key ID) non-empty ^[0-9a-f]+$

UID of a key as a hex encoded string without delimiters

lockId
required
string (Lock ID) non-empty

Vendor specific ID for a lock

sharedSecret
required
string (Shared Secret)

Shared secret between the productizer and the system using it

Responses

Request samples

Content type
application/json
{
  • "keyId": "a1b2c3d4e5f6890",
  • "lockId": "12345678",
  • "sharedSecret": "string"
}

Response samples

Content type
application/json
{
  • "keyId": "a1b2c3d4e5f6890",
  • "lockId": "12345678"
}

Delete key assignment Deprecated

Remove a key from having access to a specific lock

query Parameters
source
required
string (Source)
header Parameters
authorization
string (User bearer token)

The login token. Value should be "Bearer [token]"

x-authorization-provider
string (Source of the token)

The bare domain of the system that provided the token

x-consent-token
string (Consent token)

Consent token to provide to data sources that require a consent

x-preview-token
string (Preview token)

Optional authentication token for unpublished data sources

signature
string (HTTP Message Signature)

Optional HTTP Message Signature

signature-input
string (HTTP Message Signature Input)

Description of HTTP Message signature if one provided

content-digest
string (Content digest of body)

Optional content digest of request body

Request Body schema: application/json
required
keyId
required
string (Key ID) non-empty ^[0-9a-f]+$

UID of a key as a hex encoded string without delimiters

lockId
required
string (Lock ID) non-empty

Vendor specific ID for a lock

sharedSecret
required
string (Shared Secret)

Shared secret between the productizer and the system using it

Responses

Request samples

Content type
application/json
{
  • "keyId": "a1b2c3d4e5f6890",
  • "lockId": "12345678",
  • "sharedSecret": "string"
}

Response samples

Content type
application/json
{
  • "keyId": "a1b2c3d4e5f6890",
  • "lockId": "12345678"
}

Check if lock assignment exists Deprecated

Check if a key has access to a specific lock

query Parameters
source
required
string (Source)
header Parameters
authorization
string (User bearer token)

The login token. Value should be "Bearer [token]"

x-authorization-provider
string (Source of the token)

The bare domain of the system that provided the token

x-consent-token
string (Consent token)

Consent token to provide to data sources that require a consent

x-preview-token
string (Preview token)

Optional authentication token for unpublished data sources

signature
string (HTTP Message Signature)

Optional HTTP Message Signature

signature-input
string (HTTP Message Signature Input)

Description of HTTP Message signature if one provided

content-digest
string (Content digest of body)

Optional content digest of request body

Request Body schema: application/json
required
keyId
required
string (Key ID) non-empty ^[0-9a-f]+$

UID of a key as a hex encoded string without delimiters

lockId
required
string (Lock ID) non-empty

Vendor specific ID for a lock

sharedSecret
required
string (Shared Secret)

Shared secret between the productizer and the system using it

Responses

Request samples

Content type
application/json
{
  • "keyId": "a1b2c3d4e5f6890",
  • "lockId": "12345678",
  • "sharedSecret": "string"
}

Response samples

Content type
application/json
{
  • "exists": true
}

NSG Agent information Deprecated

In the Nordic Smart Government information exchange context the agent represents both registered organizations ("companies") and persons who are doing business without being registered organizations, usually as sole traders (sole proprietors). This data product definition returns basic information content for any agent.

query Parameters
source
required
string (Source)
header Parameters
authorization
string (User bearer token)

The login token. Value should be "Bearer [token]"

x-authorization-provider
string (Source of the token)

The bare domain of the system that provided the token

x-consent-token
string (Consent token)

Consent token to provide to data sources that require a consent

x-preview-token
string (Preview token)

Optional authentication token for unpublished data sources

signature
string (HTTP Message Signature)

Optional HTTP Message Signature

signature-input
string (HTTP Message Signature Input)

Description of HTTP Message signature if one provided

content-digest
string (Content digest of body)

Optional content digest of request body

Request Body schema: application/json
required
nationalIdentifier
required
string (National Identifier)

National identifier for a legal entity

Responses

Request samples

Content type
application/json
{
  • "nationalIdentifier": "2464491-9"
}

Response samples

Content type
application/json
{
  • "name": "Oy Example Ab",
  • "legalForm": "FI_OY",
  • "legalStatus": "NORMAL",
  • "registrationDate": "2019-08-24",
  • "registeredAddress": {
    }
}

Beneficial owners of a non-listed company Deprecated

The list of beneficial owners of a non-listed company. The shareholders exceeding 25 % ownership.

query Parameters
source
required
string (Source)
header Parameters
authorization
required
string (User bearer token)

The login token. Value should be "Bearer [token]"

x-authorization-provider
string (Source of the token)

The bare domain of the system that provided the token

x-consent-token
required
string (Consent token)

Consent token to provide to data sources that require a consent

x-preview-token
string (Preview token)

Optional authentication token for unpublished data sources

signature
string (HTTP Message Signature)

Optional HTTP Message Signature

signature-input
string (HTTP Message Signature Input)

Description of HTTP Message signature if one provided

content-digest
string (Content digest of body)

Optional content digest of request body

Request Body schema: application/json
required
nationalIdentifier
required
string (National identifier) <= 40 characters

The national identifier of the non-listed company issued by the trade register in any Nordic country.

Responses

Request samples

Content type
application/json
{
  • "nationalIdentifier": "FIN: 2464491-9 / SWE: 5560125791 / NOR: 923609016"
}

Response samples

Content type
application/json
{
  • "shareSeries": [
    ],
  • "shareholders": [
    ]
}

Signatory rights of a non-listed company Deprecated

The list of representation rights of a legal entity

query Parameters
source
required
string (Source)
header Parameters
authorization
required
string (User bearer token)

The login token. Value should be "Bearer [token]"

x-authorization-provider
string (Source of the token)

The bare domain of the system that provided the token

x-consent-token
required
string (Consent token)

Consent token to provide to data sources that require a consent

x-preview-token
string (Preview token)

Optional authentication token for unpublished data sources

signature
string (HTTP Message Signature)

Optional HTTP Message Signature

signature-input
string (HTTP Message Signature Input)

Description of HTTP Message signature if one provided

content-digest
string (Content digest of body)

Optional content digest of request body

Request Body schema: application/json
required
nationalIdentifier
required
string (National identifier) <= 40 characters

The national identifier of the non-listed company issued by the trade register

Responses

Request samples

Content type
application/json
{
  • "nationalIdentifier": "FIN: 2464491-9 / SWE: 5560125791 / NOR: 923609016"
}

Response samples

Content type
application/json
{
  • "signatoryRights": [
    ]
}

Establish a non-listed company Deprecated

Create the initial set of data to establish a non-listed company

query Parameters
source
required
string (Source)
header Parameters
authorization
required
string (User bearer token)

The login token. Value should be "Bearer [token]"

x-authorization-provider
string (Source of the token)

The bare domain of the system that provided the token

x-consent-token
string (Consent token)

Consent token to provide to data sources that require a consent

x-preview-token
string (Preview token)

Optional authentication token for unpublished data sources

signature
string (HTTP Message Signature)

Optional HTTP Message Signature

signature-input
string (HTTP Message Signature Input)

Description of HTTP Message signature if one provided

content-digest
string (Content digest of body)

Optional content digest of request body

Request Body schema: application/json
required
required
object (Registrant)

The personal details of the person registering the company

required
object (Company details)

The details of the company being established

required
Array of objects (Share series)

The details of the share series of the company

required
object (Company address)

The official address of the company

required
Array of objects (Managing directors)
required
Array of objects (Board members)
required
object (Auditor details)

The details of the company and person auditing the company

Responses

Request samples

Content type
application/json
{
  • "registrant": {
    },
  • "companyDetails": {
    },
  • "shareSeries": [
    ],
  • "companyAddress": {
    },
  • "managingDirectors": [
    ],
  • "boardMembers": [
    ],
  • "auditorDetails": {
    }
}

Response samples

Content type
application/json
{
  • "registrant": {
    },
  • "companyDetails": {
    },
  • "shareSeries": [
    ],
  • "companyAddress": {
    },
  • "managingDirectors": [
    ],
  • "boardMembers": [
    ],
  • "auditorDetails": {
    }
}

Person details Deprecated

Details about a person such as home address

query Parameters
source
required
string (Source)
header Parameters
authorization
required
string (User bearer token)

The login token. Value should be "Bearer [token]"

x-authorization-provider
string (Source of the token)

The bare domain of the system that provided the token

x-consent-token
string (Consent token)

Consent token to provide to data sources that require a consent

x-preview-token
string (Preview token)

Optional authentication token for unpublished data sources

signature
string (HTTP Message Signature)

Optional HTTP Message Signature

signature-input
string (HTTP Message Signature Input)

Description of HTTP Message signature if one provided

content-digest
string (Content digest of body)

Optional content digest of request body

Request Body schema: application/json
required
object (PersonDetailsRequest)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "name": "Joshua Gray",
  • "address": "6 Raymond river\nRileybury\nCR3 6XA"
}

Environmental footprint information for a product Deprecated

Information about environmental footprint of a product in the manufacturing phase

query Parameters
source
required
string (Source)
header Parameters
authorization
string (User bearer token)

The login token. Value should be "Bearer [token]"

x-authorization-provider
string (Source of the token)

The bare domain of the system that provided the token

x-consent-token
string (Consent token)

Consent token to provide to data sources that require a consent

x-preview-token
string (Preview token)

Optional authentication token for unpublished data sources

signature
string (HTTP Message Signature)

Optional HTTP Message Signature

signature-input
string (HTTP Message Signature Input)

Description of HTTP Message signature if one provided

content-digest
string (Content digest of body)

Optional content digest of request body

Request Body schema: application/json
required
serialNumber
required
string (Serial Number)

The serial number given by the manufacturer

Responses

Request samples

Content type
application/json
{
  • "serialNumber": "MPP48V-296cde7f"
}

Response samples

Content type
application/json
{
  • "carbonEquivalent": 200,
  • "materialWaste": 8
}

Current time in a given country Deprecated

Get the current time in a given country based on the ISO 3166-1 alpha-2 country code, formatted in RFC 3339 format

query Parameters
source
required
string (Source)
header Parameters
authorization
string (User bearer token)

The login token. Value should be "Bearer [token]"

x-authorization-provider
string (Source of the token)

The bare domain of the system that provided the token

x-consent-token
string (Consent token)

Consent token to provide to data sources that require a consent

x-preview-token
string (Preview token)

Optional authentication token for unpublished data sources

signature
string (HTTP Message Signature)

Optional HTTP Message Signature

signature-input
string (HTTP Message Signature Input)

Description of HTTP Message signature if one provided

content-digest
string (Content digest of body)

Optional content digest of request body

Request Body schema: application/json
required
countryCode
required
any (ISO 3166-1 alpha-2 country code)
Enum: "ad" "ae" "af" "ag" "ai" "al" "am" "ao" "aq" "ar" "as" "at" "au" "aw" "ax" "az" "ba" "bb" "bd" "be" "bf" "bg" "bh" "bi" "bj" "bl" "bm" "bn" "bo" "bq" "br" "bs" "bt" "bv" "bw" "by" "bz" "ca" "cc" "cd" "cf" "cg" "ch" "ci" "ck" "cl" "cm" "cn" "co" "cr" "cu" "cv" "cw" "cx" "cy" "cz" "de" "dj" "dk" "dm" "do" "dz" "ec" "ee" "eg" "eh" "er" "es" "et" "fi" "fj" "fk" "fm" "fo" "fr" "ga" "gb" "gd" "ge" "gf" "gg" "gh" "gi" "gl" "gm" "gn" "gp" "gq" "gr" "gs" "gt" "gu" "gw" "gy" "hk" "hm" "hn" "hr" "ht" "hu" "id" "ie" "il" "im" "in" "io" "iq" "ir" "is" "it" "je" "jm" "jo" "jp" "ke" "kg" "kh" "ki" "km" "kn" "kp" "kr" "kw" "ky" "kz" "la" "lb" "lc" "li" "lk" "lr" "ls" "lt" "lu" "lv" "ly" "ma" "mc" "md" "me" "mf" "mg" "mh" "mk" "ml" "mm" "mn" "mo" "mp" "mq" "mr" "ms" "mt" "mu" "mv" "mw" "mx" "my" "mz" "na" "nc" "ne" "nf" "ng" "ni" "nl" "no" "np" "nr" "nu" "nz" "om" "pa" "pe" "pf" "pg" "ph" "pk" "pl" "pm" "pn" "pr" "ps" "pt" "pw" "py" "qa" "re" "ro" "rs" "ru" "rw" "sa" "sb" "sc" "sd" "se" "sg" "sh" "si" "sj" "sk" "sl" "sm" "sn" "so" "sr" "ss" "st" "sv" "sx" "sy" "sz" "tc" "td" "tf" "tg" "th" "tj" "tk" "tl" "tm" "tn" "to" "tr" "tt" "tv" "tw" "tz" "ua" "ug" "um" "us" "uy" "uz" "va" "vc" "ve" "vg" "vi" "vn" "vu" "wf" "ws" "ye" "yt" "za" "zm" "zw"

An enumeration.

Responses

Request samples

Content type
application/json
{
  • "countryCode": "ad"
}

Response samples

Content type
application/json
{
  • "currentTime": "string"
}

Current weather in a given location Deprecated

Common data points about the current weather with metric units in a given location. Simplified for example use, and not following industry standards.

query Parameters
source
required
string (Source)
header Parameters
authorization
string (User bearer token)

The login token. Value should be "Bearer [token]"

x-authorization-provider
string (Source of the token)

The bare domain of the system that provided the token

x-consent-token
string (Consent token)

Consent token to provide to data sources that require a consent

x-preview-token
string (Preview token)

Optional authentication token for unpublished data sources

signature
string (HTTP Message Signature)

Optional HTTP Message Signature

signature-input
string (HTTP Message Signature Input)

Description of HTTP Message signature if one provided

content-digest
string (Content digest of body)

Optional content digest of request body

Request Body schema: application/json
required
lat
required
number (Latitude) [ -90 .. 90 ]

The latitude coordinate of the desired location

lon
required
number (Longitude) [ -180 .. 180 ]

The longitude coordinate of the desired location

Responses

Request samples

Content type
application/json
{
  • "lat": 60.192059,
  • "lon": 24.945831
}

Response samples

Content type
application/json
{
  • "humidity": 72,
  • "pressure": 1007,
  • "rain": true,
  • "temp": 17.3,
  • "windSpeed": 2.1,
  • "windDirection": 220
}

Indoor location based on BLE beacons

Determine the indoor location based on BLE beacons a device can hear and the signal strength in dBm.

query Parameters
source
required
string (Source)
header Parameters
authorization
string (User bearer token)

The login token. Value should be "Bearer [token]"

x-authorization-provider
string (Source of the token)

The bare domain of the system that provided the token

x-consent-token
string (Consent token)

Consent token to provide to data sources that require a consent

x-preview-token
string (Preview token)

Optional authentication token for unpublished data sources

signature
string (HTTP Message Signature)

Optional HTTP Message Signature

signature-input
string (HTTP Message Signature Input)

Description of HTTP Message signature if one provided

content-digest
string (Content digest of body)

Optional content digest of request body

Request Body schema: application/json
required
required
Array of objects (Beacons)

Responses

Request samples

Content type
application/json
{
  • "beacons": [
    ]
}

Response samples

Content type
application/json
{
  • "locationId": "849cc493-efb7-483f-b634-7a44849270f9",
  • "locationName": "Deck #3"
}

Export Instructions

Get instructions necessary in the export context, based on a Letter of Credit number.

query Parameters
source
required
string (Source)
header Parameters
authorization
string (User bearer token)

The login token. Value should be "Bearer [token]"

x-authorization-provider
string (Source of the token)

The bare domain of the system that provided the token

x-consent-token
string (Consent token)

Consent token to provide to data sources that require a consent

x-preview-token
string (Preview token)

Optional authentication token for unpublished data sources

signature
string (HTTP Message Signature)

Optional HTTP Message Signature

signature-input
string (HTTP Message Signature Input)

Description of HTTP Message signature if one provided

content-digest
string (Content digest of body)

Optional content digest of request body

Request Body schema: application/json
required
letterOfCreditNumber
required
string (Letter of credit number)

Responses

Request samples

Content type
application/json
{
  • "letterOfCreditNumber": "123"
}

Response samples

Content type
application/json
{
  • "advisingBankBic": "string",
  • "advisingBankName": "string",
  • "advisingBankReference": "string",
  • "applicantAddress": "string",
  • "applicantName": "string",
  • "beneficiaryAddress": "string",
  • "beneficiaryName": "string",
  • "confirmationInstructions": "string",
  • "contractReference": "string",
  • "creditAvailability": "string",
  • "currencyCode": "string",
  • "dateOfExpiry": "2019-08-24T14:15:22Z",
  • "descriptionOfGoods": "string",
  • "incoterm": "string",
  • "incotermPlace": "string",
  • "issueDate": "2019-08-24T14:15:22Z",
  • "issuingBankBic": "string",
  • "issuingBankName": "string",
  • "latestDateOfShipment": "2019-08-24T14:15:22Z",
  • "letterOfCreditValue": 0
}

Dimensions and weights of a product

Get the physical dimensions and weights of a product based on its product code

query Parameters
source
required
string (Source)
header Parameters
authorization
string (User bearer token)

The login token. Value should be "Bearer [token]"

x-authorization-provider
string (Source of the token)

The bare domain of the system that provided the token

x-consent-token
string (Consent token)

Consent token to provide to data sources that require a consent

x-preview-token
string (Preview token)

Optional authentication token for unpublished data sources

signature
string (HTTP Message Signature)

Optional HTTP Message Signature

signature-input
string (HTTP Message Signature Input)

Description of HTTP Message signature if one provided

content-digest
string (Content digest of body)

Optional content digest of request body

Request Body schema: application/json
required
productCode
required
string (Product code)

Responses

Request samples

Content type
application/json
{
  • "productCode": "string"
}

Response samples

Content type
application/json
{
  • "grossWeight": "string",
  • "height": 0,
  • "length": 0,
  • "netWeight": 0,
  • "productDescription": "string",
  • "productName": "string",
  • "volume": 0,
  • "width": 0
}

Cargo receipt for a forwarder

Information necessary for the receipt of cargo for a forwarder

query Parameters
source
required
string (Source)
header Parameters
authorization
string (User bearer token)

The login token. Value should be "Bearer [token]"

x-authorization-provider
string (Source of the token)

The bare domain of the system that provided the token

x-consent-token
string (Consent token)

Consent token to provide to data sources that require a consent

x-preview-token
string (Preview token)

Optional authentication token for unpublished data sources

signature
string (HTTP Message Signature)

Optional HTTP Message Signature

signature-input
string (HTTP Message Signature Input)

Description of HTTP Message signature if one provided

content-digest
string (Content digest of body)

Optional content digest of request body

Request Body schema: application/json
required
shipmentId
required
string (Shipment ID)

Responses

Request samples

Content type
application/json
{
  • "shipmentId": "string"
}

Response samples

Content type
application/json
{
  • "carrierName": "string",
  • "exporterName": "string",
  • "finalDestination": "string",
  • "finalDestinationAddress": "string",
  • "forwarderContactPersonName": "string",
  • "forwarderContactPersonPhone": "string",
  • "forwarderName": "string",
  • "handlingUnits": 0,
  • "importerName": "string",
  • "issueDate": "2019-08-24T14:15:22Z",
  • "lcNumber": "string",
  • "modeOfDelivery": "string",
  • "placeOfDischarge": "string",
  • "placeOfLoading": "string",
  • "placeOfReceipt": "string",
  • "statement": "string",
  • "totalGrossWeight": 0,
  • "totalNetWeight": 0,
  • "totalVolume": 0
}

Insurance certificate for a shipment

Get all the details necessary about the insurance certificate for a specific shipment based on the shipment ID.

query Parameters
source
required
string (Source)
header Parameters
authorization
string (User bearer token)

The login token. Value should be "Bearer [token]"

x-authorization-provider
string (Source of the token)

The bare domain of the system that provided the token

x-consent-token
string (Consent token)

Consent token to provide to data sources that require a consent

x-preview-token
string (Preview token)

Optional authentication token for unpublished data sources

signature
string (HTTP Message Signature)

Optional HTTP Message Signature

signature-input
string (HTTP Message Signature Input)

Description of HTTP Message signature if one provided

content-digest
string (Content digest of body)

Optional content digest of request body

Request Body schema: application/json
required
shipmentId
required
string (Shipment ID)

Responses

Request samples

Content type
application/json
{
  • "shipmentId": "string"
}

Response samples

Content type
application/json
{
  • "currencyCode": "string",
  • "descriptionOfGoods": "string",
  • "finalDestination": "string",
  • "handlingUnits": 0,
  • "instituteClauses": "string",
  • "insuranceValue": 0,
  • "insuranceValuePercentage": 0,
  • "insurerAddress": "string",
  • "insurerName": "string",
  • "modeOfDelivery": "string",
  • "placeOfReceipt": "string",
  • "totalGrossWeight": 0
}

Packing List

Packing List

query Parameters
source
required
string (Source)
header Parameters
authorization
string (User bearer token)

The login token. Value should be "Bearer [token]"

x-authorization-provider
string (Source of the token)

The bare domain of the system that provided the token

x-consent-token
string (Consent token)

Consent token to provide to data sources that require a consent

x-preview-token
string (Preview token)

Optional authentication token for unpublished data sources

signature
string (HTTP Message Signature)

Optional HTTP Message Signature

signature-input
string (HTTP Message Signature Input)

Description of HTTP Message signature if one provided

content-digest
string (Content digest of body)

Optional content digest of request body

Request Body schema: application/json
required
shipmentId
required
string (Shipment ID)

Responses

Request samples

Content type
application/json
{
  • "shipmentId": "string"
}

Response samples

Content type
application/json
{
  • "contractReference": "string",
  • "descriptionOfGoods": "string",
  • "finalDestination": "string",
  • "handlingUnits": 0,
  • "incoterm": "string",
  • "incotermPlace": "string",
  • "lcNumber": "string",
  • "packingDescription": "string",
  • "packingReference": "string",
  • "placeOfReceipt": "string",
  • "productItems": [
    ],
  • "totalGrossWeight": 0,
  • "totalNetWeight": 0,
  • "totalVolume": 0
}

Invoice

Invoice

query Parameters
source
required
string (Source)
header Parameters
authorization
string (User bearer token)

The login token. Value should be "Bearer [token]"

x-authorization-provider
string (Source of the token)

The bare domain of the system that provided the token

x-consent-token
string (Consent token)

Consent token to provide to data sources that require a consent

x-preview-token
string (Preview token)

Optional authentication token for unpublished data sources

signature
string (HTTP Message Signature)

Optional HTTP Message Signature

signature-input
string (HTTP Message Signature Input)

Description of HTTP Message signature if one provided

content-digest
string (Content digest of body)

Optional content digest of request body

Request Body schema: application/json
required
shipmentId
required
string (Shipment ID)

Responses

Request samples

Content type
application/json
{
  • "shipmentId": "string"
}

Response samples

Content type
application/json
{
  • "amountToBePaid": 0,
  • "bankContactBic": "string",
  • "bankContactIban": "string",
  • "bankContactName": "string",
  • "buyerContactPersonName": "string",
  • "buyerName": "string",
  • "buyerVatNumber": "string",
  • "contractReference": "string",
  • "countryOfOrigin": "string",
  • "currencyCode": "string",
  • "descriptionOfGoods": "string",
  • "handlingUnits": 0,
  • "incoterm": "string",
  • "incotermPlace": "string",
  • "invoiceNote": "string",
  • "invoiceReference": "string",
  • "issueDate": "2019-08-24T14:15:22Z",
  • "lcNumber": "string",
  • "letterOfCreditValue": 0,
  • "modeOfDelivery": "string",
  • "orderReference": "string",
  • "projectReference": "string",
  • "sellerContactPersonName": "string",
  • "sellerName": "string",
  • "sellerVatNumber": "string",
  • "taxRate": 0,
  • "totalGrossWeight": 0,
  • "totalNetWeight": 0,
  • "totalVolume": 0,
  • "valueOfShipment": 0
}

Information about a country

Information about a country

query Parameters
source
required
string (Source)
header Parameters
authorization
string (User bearer token)

The login token. Value should be "Bearer [token]"

x-authorization-provider
string (Source of the token)

The bare domain of the system that provided the token

x-consent-token
string (Consent token)

Consent token to provide to data sources that require a consent

x-preview-token
string (Preview token)

Optional authentication token for unpublished data sources

signature
string (HTTP Message Signature)

Optional HTTP Message Signature

signature-input
string (HTTP Message Signature Input)

Description of HTTP Message signature if one provided

content-digest
string (Content digest of body)

Optional content digest of request body

Request Body schema: application/json
required
code
required
string (Code) = 2 characters

ISO 3166-1 alpha-2 code for the country

Responses

Request samples

Content type
application/json
{
  • "code": "FI"
}

Response samples

Content type
application/json
{
  • "code": "FI",
  • "name": "Finland",
  • "area": 338455,
  • "languages": [
    ],
  • "capital": {
    }
}