{"openapi":"3.1.0","info":{"title":"Vastuu Group APIs","description":"## API Services Overview\nTarjoamme useita erilaisia rajapintaliityntöjä partnereidemme käyttöön. Rajapinnat mahdollistavat saumattoman tiedonsiirron suoraan Vastuu Groupin palveluista itse palveluntarjoajan käyttöön.\n\nLisätietoja löytyy ohjekeskuksen <a href=\"https://support.vastuugroup.fi/hc/fi/categories/115000880085-Partnerit-ja-rajapinnat\" target=\"_blank\">Partnerit ja rajapinnat</a> -osiosta.\n\nTiedotamme rajapintojen muutoksista ja päivityksistä <a href=\"https://www.vastuugroup.fi/partneritiedotteet\" target=\"_blank\">täällä</a>.\n\nWe offer several different API's for use by our partners. The API's enable seamless data transfer directly from Vastuu Group's services to the service provider's own use.\n\nMore information in support center <a href=\"https://support.vastuugroup.fi/hc/fi/categories/115000880085-Partnerit-ja-rajapinnat\" target=\"_blank\">Partnerit ja rajapinnat</a> (only in Finnish for now).\n\nUpdates and changes to APIs will be communicated <a href=\"https://www.vastuugroup.fi/partneritiedotteet\" target=\"_blank\">here</a> (only in Finnish for now).\n\n### Supported APIs\n#### [Competence Input API](#tag/Competence-Input-API-v1.0)\n\nCompetence Input API:n avulla kouluttajaorganisaatio voi tuoda tietoja suoritetuista pätevyyksistä Vastuu Groupin pätevyysrekisteriin ja sitä kautta Valtti+ -palvelua käyttävien työnantajien nähtäviksi.\nRajapinta on tarkoitettu kouluttajille, jotka ovat tehneet kouluttajasopimuksen Vastuu Groupin kanssa ja joille on annettu oikeus määritettyjen pätevyystyyppien tuomiseen.\nPätevyyden tuonti pätevyysrekisteriin ei edellytä, että kyseinen henkilö löytyy Vastuu Groupin rekisteristä. Kaikki pätevyydet ja tunnistetiedot tallennetaan järjestelmään, vaikka tunnistetta vastaavaa työntekijää ei tuontihetkellä löytyisikään. Kun työntekijä myöhemmin lisätään, jonka tunnistetiedot vastaavat pätevyysrekisterissä olevaa pätevyyttä, yhdistetään kyseiselle työntekijälle tämä pätevyys.\nPätevyydellä on pakollisena tietona voimassaoloaika. Normaalisti pätevyyksiä ei erikseen tarvitse poistaa, vaan ne poistuvat rekisteristä automaattisesta tietyn ajan kuluttua voimassaoloajan päättymisestä.\nPätevyyksien yhteydessä näytetään ulospäin kouluttajayrityksen nimenä kouluttajan yritystilillä määritelty yrityksen nimi.\n\nThe Competence Input API allows training organizations to submit information about completed competences to Vastuu Group’s competence register, making them visible to employers using the Valtti service plan.\nThe interface is intended for trainers who have entered into a trainer agreement with Vastuu Group and have been granted the right to submit specific types of competences.\nAdding a competence to the competence register does not require the individual in question to already exist in Vastuu Group’s register. All competences and identification details are stored in the system, even if there is no corresponding employee in the register at the time of submission. If an employee is later added whose identification details match a competence in the register, the competence will be linked to that employee.\nThe validity period is mandatory information for competences. Normally, competences do not need to be removed manually, as they are automatically removed from the register after a certain period following the expiration of their validity.\nThe training organization’s name displayed alongside competences is the company name specified in the trainer’s company account.\n\n#### [Korttivarasto API](#tag/Korttivarasto-API-v1.3)\nKorttivarasto API:ssa on tiedot kaikista aktivoiduista Valttikorteista. Korttivarasto on rajapinta vahvistettujen henkilökorttien todentamiseen.\n\nThe Korttivarasto API contains information on all activated Valtti cards. This interface serves the purpose of authenticating confirmed personnel cards.\n\nUse cases:\n\n- If you want information about a particular Valtti card, use one of the endpoints for fetching a single card\n- If you want to know which cards are closed or expired, use the */cards* endpoint to gather that information about all the cards\n\n#### [Luotettava Kumppani API](#tag/Luotettava-Kumppani-API-v1.1)\n\nLuotettava Kumppani API tarjoaa rajapinnan kahteen erilliseen palveluun: \nperinteiseen Luotettava Kumppani tilaajavastuutiedot -palveluun sekä\nuudistettuun, laajempaan Luotettava Kumppani -palveluun.\n\nPeruspalvelu keskittyy lakisääteisiin tilaajavastuulain mukaisiin tietoihin,\njoita tarvitaan esimerkiksi rakennus- ja hankintaketjuissa. Se kattaa\nolennaiset tiedot, kuten rekisteröinnit, verojen ja eläkevakuutusten\nmaksutilanteen sekä muut velvoitteet.\n\nUudistunut Luotettava Kumppani -palvelu laajentaa tätä kokonaisuutta\ntarjoamalla syvällisemmän näkymän yrityksen kokonaistilanteeseen. Se\nyhdistää tilaajavastuutiedot yrityksen taloudelliseen tilanteeseen,\navainhenkilöihin ja vastuullisuustekijöihin, huomioiden myös mahdolliset\npakotteet yritystä tai sen johtoa kohtaan.\n\nAPI:n kautta raporttitiedot ovat saatavilla JSON-, PDF- sekä HTML-muodossa,\nja ne voidaan integroida osaksi esimerkiksi hankinta- tai\ntoimittajahallintajärjestelmiä, mahdollistaen ajantasaisen ja automatisoidun\ntiedonhyödynnön osana liiketoimintaprosesseja.        \n\nThe Reliable Partner API provides access to two distinct services: the \ntraditional Reliable Partner – Contractor’s Liability Information (RP CL) and the\nrenewed, broader Reliable Partner (RP) service.\n\nThe basic service focuses on statutory contractor’s liability data required in\nprocurement and construction processes. It includes essential legal\nobligations such as registration, tax compliance, and insurance information.\n\nThe renewed RP service builds on this foundation by offering a\ndeeper view into a company’s overall trustworthiness. In addition to RP CL, \nit includes insights into the company’s financial status, key\nindividuals, and responsibility practices—also factoring in any applicable\nsanctions related to the company or its management.\n\nReport data is available in JSON, PDF and HTML formats and can be\nseamlessly integrated into procurement or supplier management systems,\nenabling real-time, automated use of verified company information in\nbusiness-critical workflows.\n\n\n#### [Person API](#tag/Person-API-v1.2)\nJärjestelmäsi käyttötapauksista ja tietotarpeista riippuen voit myös täydentää Valttikortilla olevia työntekijätietoja Person API -henkilötietorajapinnastamme. Person API:n kautta voit esimerkiksi hakea järjestelmääsi työmaan päätoteuttajana toimivaa asiakastasi varten kaikki Verohallinnon työntekijäraportille tarvittavat tiedot.\n\nDepending on the use cases and data requirements of your system, you also have the option to supplement employee information stored on the Valtti card through our Person API, a personal data interface. Through the Person API, you can, for example, retrieve all the necessary information for the Tax Administration employee report for your client acting as the main contractor on a construction site in your system.\n\n#### [Valtti+ Tarkastaja API](#tag/Tarkastaja-API-v1.1)\nValtti+ Tarkastaja API:n kautta voi hakea työntekijöiden perustietoja, työntekijään liittyviä dokumentteja (henkilöllisyyden todistaminen, oleskelulupa ja A1-todistus) liitetiedostoineen sekä pätevyyksiä liitetiedostoineen. Tiedot ovat pääosin työnantajien järjestelmään syöttämiä tietoja.\nTiedot on saatavilla vain niiltä työnantajilta, jotka ovat ottaneet käyttöönsä maksullisen Valtti+ -palvelun, ja jotka ovat luvittaneet yrityksensä työntekijöiden tiedot tietoja hakevalle yritykselle (yleensä työmaan päätoteuttaja).\nRajapinnan ensisijainen käyttötarkoitus on tietojen välittäminen työnantajalta työmaan päätoteuttajille tarkastettavaksi työntekijän perehdytyksen yhteydessä.\nRajapinta on maksullinen tietoja hakevalle yritykselle. Käyttö edellyttää, että tietoja hakevalla yrityksellä (yleensä päätoteuttaja) on voimassaoleva lisenssi.\n\nThrough the Valtti+ Tarkastaja API, you can search for basic employee information, employee-related documents (identity proof, residence permit and A1 certificate) with attachments, and competences with attachments. The information is mainly information entered into the system by employers.\nThe information is available only from those employers who have adopted the paid Valtti service plan, and who have authorized the information of their company’s employees to the company requesting the information (usually the main contractor of the construction site).\nThe primary purpose of use of the interface is to transmit information from the employer to the site’s main contractors for inspection during the work site inductions.\nThe interface is a paid service for the company requesting information. Use requires that the company requesting information (usually the main contractor) has a valid license.\n\n## API Access Requirements\n\n### OAuth2 Authentication\n\n**Only OAuth2 is supported!**\n\n⚠️ Required OAuth2 scopes are not enabled by default. API consumers must request the appropriate scopes for their client from our technical team prior to using the OAuth2 flow.\n\nTo obtain a token using OAuth2 client credentials grant with client id, client secret, and scopes, follow these steps:\n\n**Request Token:**\n  1. Include client id and client secret in the headers, grant_type=client_credentials and desired scopes in the request body. The required scope can be found in the description of the endpoint. Scopes should be separated by a space.\n  2. Make a POST request to the token endpoint.\n\n**Example Request:**\n```bash\ncurl -X POST -u \"CLIENT_ID:CLIENT_SECRET\" -d \"grant_type=client_credentials&scope=DESIRED_SCOPES\" TOKEN_ENDPOINT_URL\n```\n\n**Receive Token:**\n  1. The response will include an access token.\n  2. Use access token to access the specified resources with the granted scopes.\n  3. The access token should be passed to the APIs in the Authorization header with the 'Bearer' prefix.\n  4. **The access token must be used long as it is valid.** The validation period can be determined from the expires_in key, which indicates the token’s validity in seconds.\n\n**Example Response:**\n```json\n{\n  \"access_token\": \"eyJraWQiOiJBa1GOFA4Yz0iLCJhbGciOiJSUzI...hrIQuu8Ff5fsCtD7-3n7HM5G8_E6WsAo06Ds9Ubwmyg\",\n  \"expires_in\": 3600,\n  \"token_type\": \"Bearer\"\n}\n```\n- `access_token` The token itself, use this for other API requests.\n- `expires_in` Token validity in seconds.\n- `token_type` Describes the token type.\n\n**Error Response:**\n\n400 Bad Request:\n- `{ \"error\": \"invalid_scope\" }` The requested scope does not exist.\n- `{ \"error\": \"invalid_grant\" }` The client is not authorized to use the requested scope.\n- `{ \"error\": \"invalid_client\" }` The client id or secret is incorrect.\n- `{ \"error\": \"invalid_request\" }` The request is missing a required parameter, includes an unsupported parameter value, or is otherwise malformed.\n- `{ \"error\": \"unsupported_grant_type\" }` The grant_type provided is invalid.\n\nMore information about OAuth2 can be found <a href=\"https://oauth.net/2/\" target=\"_blank\">here</a>\n\n---\n\n### Customer Identifier\nThe `customer-identifier` plays a crucial role in the header information, allowing Vastuu Group to identify the end customer. This identifier is a mandatory requirement for nearly every API call, and you can refer to the API documentation to understand when it is necessary.\n\nCustomers are required to have an active account. Customers can create their own unique `customer-identifier` through their account in Vastuu Group's <a href=\"https://www.vastuugroup.fi/en/customer-portal\" target=\"_blank\">Customer Portal</a>. Instructions for creating the `customer-identifier` can be found <a href=\"https://support.vastuugroup.fi/hc/fi/articles/18995821923218-Yritystilin-ja-rajapintatunnisteen-luominen\" target=\"_blank\">here</a> (only in Finnish for now). In the Customer Portal, the customer-identifier is known as the API identifier (Rajapintatunniste) from the customer's point of view.\n\nUse the endpoint `/api-consumer-management/v1.0/customer-identifiers/{customer_identifier}` to fetch information about a single customer identifier.\n\n**Information obtained from interfaces that require the end customer's customer-identifier can only be displayed to the end customer whose customer-identifier was used to fetch for data.**\n\n## Guidelines for Developers\n\n### Request Size Limits\nTo ensure platform stability and performance, request size limiting is enforced per request at the Vastuu Group APIs level.\n\nDefault limit per environment:\n- Staging: 100 KiB / 102 400 bytes\n- Production: 100 KiB / 102 400 bytes (enforcing date will be communicated separately)\n\n`The request size limit is configurable and may change in the future.`\n\nThe request size is calculated from the complete HTTP request, including:\n- Path\n- Query parameters\n- Headers\n- Request body\n\nIf the request size exceeds the configured limit, the API returns:\n\n```bash\nHTTP/1.1 413 Content Too Large\n```\n\nTo avoid request size validation errors, we recommend:\n- Keeping requests as small as practical.\n- Splitting large batches into multiple smaller requests.\n- Avoiding unnecessary headers, query parameters, and payload data.\n\n---\n\n### Rate Limiting\nTo ensure platform stability and fair usage, rate limiting is enforced **per Client ID** at the Vastuu Group APIs level.\n\nAPI consumers should dynamically monitor headers related to rate limiting on every response to adjust request pacing in real-time.\n\nDefault limit per environment: \n  - Staging: 50 requests **per minute**\n  - Production: 1000 requests **per minute**\n\n`The rate limit is configurable and may change in the future.`\n\n#### Rate Limiting Headers\nHeader names are case-insensitive; actual responses will use lowercase (e.g. x-ratelimit-limit) depending on the server or framework.\n\n| Header | Example Value | Description |\n|----|----|----|\n|X-RateLimit-Limit|1000|The maximum number of requests allowed in the current rate limit window.|\n|X-RateLimit-Remaining|988|The number of requests remaining in the current rate limit window.|\n|X-RateLimit-Reset|1759911286.0646176|Unix epoch timestamp until the rate limit resets.|\n|Retry-After|43|Number of seconds to wait before retrying a request.<br />**Returned only after HTTP 429 response.**|\n|X-RateLimit-Backend|down|Backend service is not available for rate limit checks.<br />**Returned only when backend service is down.**|\n\n#### Rate limit not exceeded\nIf rate limit is not exceeded, the following headers are returned;\n```bash\nHTTP/1.1 200 OK\nX-RateLimit-Limit: 1000\nX-RateLimit-Remaining: 988\nX-RateLimit-Reset: 1759911286.0646176\n```\n\n#### Rate limit exceeded\nIf rate limit is exceeded, the following headers are returned;\n```bash\nHTTP/1.1 429 Too Many Requests\nX-RateLimit-Limit: 1000\nX-RateLimit-Remaining: 0\nX-RateLimit-Reset: 1759911286.2698917\nRetry-After: 43\n```\n\nNote: You have reached the maximum number of requests. Please wait the number of seconds specified in Retry-After before trying again.\n\n#### Backend Down Response\nIf rate limiting checks are temporarily unavailable, **clients are expected to continue behaving responsibly** and adhere to their normal request patterns. \n\nRequests will still be processed normally and they are not rejected because of rate limit checks being unavailable.\n\nIf our backend for rate limit checks is temporarily unavailable, the following headers are returned;\n```bash\nHTTP/1.1 200 OK\nX-RateLimit-Limit: 1000\nX-RateLimit-Remaining: -1\nX-RateLimit-Reset: -1\nX-RateLimit-Backend: down\n```\n\n---\n\n### What Does \"Deprecated\" Mean?\nWhen API endpoint(s) or parameter(s) is marked as deprecated, it means;\n- It is **no longer recommended** for use.\n- It will be **removed in a future release**.\n- You should **update your code** to ensure compatibility with future versions.\n- You may continue to use the deprecated functionality **until further notice**.\n\n---\n\n### What Does “Billable” Mean?\nWhen an API endpoint(s) is marked as Billable, it means:\n- Requests to this endpoint are calculated toward the end customer’s invoice or license usage.\n- Usage of this endpoint is tracked for billing and licensing purposes.\n- Requests must be made only with the end customer’s consent or under their control.\n- You should ensure this endpoint is requested only when billing impact is intended and expected.\n\n---\n\n### Before Submitting a Support Request\nEnsure you collect and log the following details with each API request. This will help your customer support contact our support with all necessary information if an issue occurs.\n\n- **X-request-id**\n  - Every API response includes an x-request-id header. Always keep this value from each request and include it in your support request. This allows us to easily locate the relevant event and logs.\n- **Request and response details**\n  - **Never include a person's social security number (SSN) in the support request.**\n  - The endpoint and HTTP method used (e.g., GET /api/v1.0/endpoint).\n  - The request sent (body, headers, parameters):\n    - Include relevant identifiers, such as\n      - Valtti card identifier\n      - Person's tax number\n      - Company business id\n  - The response received\n    - Status code\n    - Error message\n- **Timestamp**\n  - Specify the exact time (to the second, including timezone) when the issue occurred.\n- **Environment**\n  - Indicate whether the request was made in production or staging environment.\n\n---\n\n### Test Data\n\nThe [Test Data API](#tag/Test-Data-API-v1.0) provides test data that can be used with other APIs to support integration and functionality testing.\n\n**Test data is only available in test environment and should not be used in production.**\n","version":"v3.17.1-dev.1"},"servers":[{"url":"https://api.staging-vastuugroup.fi"}],"paths":{"/competence-input/v1.0/add_competence":{"post":{"tags":["Competence Input API v1.0"],"summary":"Add competence","operationId":"competence_add_competence_input_v1_0_add_competence_post","security":[{"HTTPBearer":["competence/add"]}],"parameters":[{"name":"id-type","in":"header","required":true,"schema":{"$ref":"#/components/schemas/routers__competence_input__IdTypeEnum","description":"Declares which method is used for identifying the person for this new competence. As of now, tax number or SSN must be finnish. If id-type is one of tax-number, ssn, valtti-barcode or valtti-uid, then id-country is required. If id-type is birthdate-name, then first-name and last-name are required."},"description":"Declares which method is used for identifying the person for this new competence. As of now, tax number or SSN must be finnish. If id-type is one of tax-number, ssn, valtti-barcode or valtti-uid, then id-country is required. If id-type is birthdate-name, then first-name and last-name are required."},{"name":"id-value","in":"header","required":true,"schema":{"type":"string","pattern":"^[ -~]+$","description":"Declares for whom this competence is being added. Specific to the given id type and country. If using birthdate-name, then the value is a date string in YYYY-MM-DD format.","title":"Id-Value"},"description":"Declares for whom this competence is being added. Specific to the given id type and country. If using birthdate-name, then the value is a date string in YYYY-MM-DD format."},{"name":"id-country","in":"header","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/routers__competence_input__CountryEnum"},{"type":"null"}],"description":"ISO 3166-1 alpha-2 country code which declares the country for this person id.","title":"Id-Country"},"description":"ISO 3166-1 alpha-2 country code which declares the country for this person id."},{"name":"customer-identifier","in":"header","required":true,"schema":{"type":"string","format":"uuid","description":"Customer identifier required on every request","title":"Customer-Identifier"},"description":"Customer identifier required on every request"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateBody"}}}},"responses":{"201":{"description":"Success.","content":{"application/json":{"schema":{"type":"object","required":["competence_type_id","created_date","granted_by_org_id","id","type","valid_from_date","valid_until_date"],"properties":{"competence_type_id":{"type":"string","description":"Competence type resource ID","example":"CT-1234"},"created_date":{"type":"string","nullable":true,"description":"UTC timestamp for the competence creation."},"granted_by_org_id":{"type":"string","description":"Id of organisation certifying the competence."},"id":{"type":"string","description":"Competence resource ID","example":"367e-78c7f25c7ba0f994b753c6f7d083738d-c8405388"},"type":{"type":"string","enum":["competence"],"description":"Always \"competence\"."},"valid_from_date":{"nullable":true,"type":"string","description":"Date from which the certification is valid."},"valid_until_date":{"nullable":true,"type":"string","description":"Date until which the certification is valid."}}}}}},"403":{"description":"The client is lacking permissions.","content":{"application/json":{"examples":{"ApiConsumerClosed":{"value":{"detail":"API consumer 00000000-0000-0000-0000-000000000000 is closed and cannot be modified"}},"ErrorDeterminingCustomership":{"value":{"detail":"Error determining customer-identifier customership."}},"NoActiveCustomership":{"value":{"detail":"No active customership for customer-identifier. Customer should contact Vastuu Group support."}},"CustomerIdentifierInvalid":{"value":{"detail":"customer-identifier is invalid or doesn't exist"}},"CustomerIdentifierNotActive":{"value":{"detail":"customer-identifier is not active"}},"ApiConsumerNotRegistered":{"value":{"detail":"API consumer is not registered"}},"LimitedRoleException":{"value":{"detail":"You are not allowed to access requested data for the provided customer-identifier."}},"LimitedCountriesException":{"value":{"detail":"You are not allowed to access the requested data for the provided customer-identifier due to country restrictions."}}},"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"A given reference is missing.","content":{"application/json":{"examples":{"ApiConsumerNotFound":{"value":{"detail":"API consumer not found."}},"CustomerNotFound":{"value":{"detail":"Customer identifier 00000000-0000-0000-0000-000000000000 not found."}}},"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"413":{"description":"Request Entity Too Large","content":{"application/json":{"examples":{"RequestTooLarge":{"value":{"detail":"Request exceeds the maximum allowed size."}}},"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"examples":{"RateLimitExceeded":{"value":{"detail":"Too many requests"}}},"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Invalid request body or headers.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestError"}}}},"401":{"description":"Invalid client permissions.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"409":{"description":"Invalid configuration. Contact support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictError"}}}}},"description":"Add competence to the Vastuu Group competence register.<br/>Save the id from the response message for later use or troubleshooting.<br/>Required scope: **competence/add**"}},"/competence-input/v1.0/delete_competences":{"post":{"tags":["Competence Input API v1.0"],"summary":"Delete competences","operationId":"competence_delete_competence_input_v1_0_delete_competences_post","security":[{"HTTPBearer":["competence/delete"]}],"parameters":[{"name":"customer-identifier","in":"header","required":true,"schema":{"type":"string","format":"uuid","description":"Customer identifier required on every request","title":"Customer-Identifier"},"description":"Customer identifier required on every request"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteBody"}}}},"responses":{"200":{"description":"Successful Response","content":{}},"403":{"description":"The client is lacking permissions.","content":{"application/json":{"examples":{"ApiConsumerClosed":{"value":{"detail":"API consumer 00000000-0000-0000-0000-000000000000 is closed and cannot be modified"}},"ErrorDeterminingCustomership":{"value":{"detail":"Error determining customer-identifier customership."}},"NoActiveCustomership":{"value":{"detail":"No active customership for customer-identifier. Customer should contact Vastuu Group support."}},"CustomerIdentifierInvalid":{"value":{"detail":"customer-identifier is invalid or doesn't exist"}},"CustomerIdentifierNotActive":{"value":{"detail":"customer-identifier is not active"}},"ApiConsumerNotRegistered":{"value":{"detail":"API consumer is not registered"}},"LimitedRoleException":{"value":{"detail":"You are not allowed to access requested data for the provided customer-identifier."}},"LimitedCountriesException":{"value":{"detail":"You are not allowed to access the requested data for the provided customer-identifier due to country restrictions."}}},"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"A given reference is missing.","content":{"application/json":{"examples":{"ApiConsumerNotFound":{"value":{"detail":"API consumer not found."}},"CustomerNotFound":{"value":{"detail":"Customer identifier 00000000-0000-0000-0000-000000000000 not found."}}},"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"413":{"description":"Request Entity Too Large","content":{"application/json":{"examples":{"RequestTooLarge":{"value":{"detail":"Request exceeds the maximum allowed size."}}},"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"examples":{"RateLimitExceeded":{"value":{"detail":"Too many requests"}}},"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"201":{"description":"Success.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeletedCompetences"}}}},"400":{"description":"Invalid request body or headers.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestError"}}}},"401":{"description":"Invalid client permissions.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"409":{"description":"Invalid configuration. Contact support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictError"}}}}},"description":"Delete competences added via your client to the Vastuu Group competence register.<br/>Use the id from the /add_competence endpoint.<br/>Required scope: **competence/delete**"}},"/api-consumer-management/v1.0/customer-identifiers/{customer_identifier}":{"get":{"tags":["Customer Identifiers API v1.0"],"summary":"Get a single customer-identifier","description":"Get details about a single customer-identifier. Used to identify\nto which customer this specific identifier belongs to.\n\n**Required scope:** `api_consumer_management/customer`","operationId":"customer_identifier_get_api_consumer_management_v1_0_customer_identifiers__customer_identifier__get","security":[{"HTTPBearer":["api_consumer_management/customer"]}],"parameters":[{"name":"customer_identifier","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Customer Identifier"}},{"name":"licenses","in":"query","required":false,"schema":{"type":"boolean","description":"Return licenses information if available","enum":[true,false],"default":false,"title":"Licenses"},"description":"Return licenses information if available"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomerIdentifierOut"}}}},"403":{"description":"Forbidden","content":{"application/json":{"examples":{"ApiConsumerClosed":{"value":{"detail":"API consumer 00000000-0000-0000-0000-000000000000 is closed and cannot be modified"}},"ErrorDeterminingCustomership":{"value":{"detail":"Error determining customer-identifier customership."}},"NoActiveCustomership":{"value":{"detail":"No active customership for customer-identifier. Customer should contact Vastuu Group support."}},"CustomerIdentifierInvalid":{"value":{"detail":"customer-identifier is invalid or doesn't exist"}},"CustomerIdentifierNotActive":{"value":{"detail":"customer-identifier is not active"}},"ApiConsumerNotRegistered":{"value":{"detail":"API consumer is not registered"}},"LimitedRoleException":{"value":{"detail":"You are not allowed to access requested data for the provided customer-identifier."}},"LimitedCountriesException":{"value":{"detail":"You are not allowed to access the requested data for the provided customer-identifier due to country restrictions."}}},"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"404":{"description":"Not Found","content":{"application/json":{"examples":{"ApiConsumerNotFound":{"value":{"detail":"API consumer not found."}},"CustomerNotFound":{"value":{"detail":"Customer identifier 00000000-0000-0000-0000-000000000000 not found."}}},"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"413":{"description":"Request Entity Too Large","content":{"application/json":{"examples":{"RequestTooLarge":{"value":{"detail":"Request exceeds the maximum allowed size."}}},"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"examples":{"RateLimitExceeded":{"value":{"detail":"Too many requests"}}},"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api-consumer-management/v1.0/customer-identifiers":{"get":{"tags":["Customer Identifiers API v1.0"],"summary":"Get all customer-identifiers registered to your API consumer","description":"**Required scope:** `api_consumer_management/customer`","operationId":"customer_identifiers_get_api_consumer_management_v1_0_customer_identifiers_get","security":[{"HTTPBearer":["api_consumer_management/customer"]}],"parameters":[{"name":"status","in":"query","required":false,"schema":{"$ref":"#/components/schemas/CustomerStatus"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":100,"title":"Limit"}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","maximum":9223372036854775800,"minimum":0,"default":0,"title":"Offset"}},{"name":"order_by","in":"query","required":false,"schema":{"$ref":"#/components/schemas/OrderBy","default":"created_at_desc"}},{"name":"licenses","in":"query","required":false,"schema":{"type":"boolean","description":"Return licenses information if available","enum":[true,false],"default":false,"title":"Licenses"},"description":"Return licenses information if available"}],"responses":{"200":{"description":"\nFetched customer-identifiers are returned in the property `customer_identifiers`.\nThe caller's own API consumer is returned in `api_consumer`. The property `next_offset`\nwill indicate if there are more results to be fetched with another query - it will be\n`null` if there are no more results, and in the case there are more, it will be an\ninteger of the `offset` value to use in the next query.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomerIdentifiersOut"}}}},"403":{"description":"Forbidden","content":{"application/json":{"examples":{"ApiConsumerClosed":{"value":{"detail":"API consumer 00000000-0000-0000-0000-000000000000 is closed and cannot be modified"}},"ErrorDeterminingCustomership":{"value":{"detail":"Error determining customer-identifier customership."}},"NoActiveCustomership":{"value":{"detail":"No active customership for customer-identifier. Customer should contact Vastuu Group support."}},"CustomerIdentifierInvalid":{"value":{"detail":"customer-identifier is invalid or doesn't exist"}},"CustomerIdentifierNotActive":{"value":{"detail":"customer-identifier is not active"}},"ApiConsumerNotRegistered":{"value":{"detail":"API consumer is not registered"}},"LimitedRoleException":{"value":{"detail":"You are not allowed to access requested data for the provided customer-identifier."}},"LimitedCountriesException":{"value":{"detail":"You are not allowed to access the requested data for the provided customer-identifier due to country restrictions."}}},"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"404":{"description":"Not Found","content":{"application/json":{"examples":{"ApiConsumerNotFound":{"value":{"detail":"API consumer not found."}},"CustomerNotFound":{"value":{"detail":"Customer identifier 00000000-0000-0000-0000-000000000000 not found."}}},"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"413":{"description":"Request Entity Too Large","content":{"application/json":{"examples":{"RequestTooLarge":{"value":{"detail":"Request exceeds the maximum allowed size."}}},"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"examples":{"RateLimitExceeded":{"value":{"detail":"Too many requests"}}},"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/korttivarasto/v1.3/cards":{"get":{"tags":["Korttivarasto API v1.3"],"summary":"Get all Valtti cards by status and date range","operationId":"korttivarasto_status_xml_korttivarasto_v1_3_cards_get","security":[{"HTTPBearer":["korttivarasto/status_get"]}],"parameters":[{"name":"status","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status","enum":["Closed","Expired","Closed,Expired"]}},{"name":"start","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Start date","examples":["2023-01-01"]}},{"name":"end","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"End date","examples":["2023-01-02"]}},{"name":"customer-identifier","in":"header","required":false,"schema":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"description":"Optional customer identifier, if applicable","title":"Customer-Identifier"},"description":"Optional customer identifier, if applicable"}],"responses":{"200":{"description":"Successful operation","content":{"application/xml":{"schema":{"$ref":"#/components/schemas/FindCardResponseOK"},"example":"<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"yes\"?>\n<FindCardResponse result=\"OK\" xmlns=\"http://www.tilaajavastuu.fi/korva.xsd\">\n\t<Cards amount=\"2\">\n\t  <Card uid=\"04B79917030180\">\n\t    <Status status=\"Closed\" modifiedDate=\"2024-12-04T00:00:05.000+02:00\" cardVerificationStatus=\"unverified\"/>\n\t  </Card>\n\t  <Card uid=\"040D326CC26231\">\n\t    <Status status=\"Expired\" modifiedDate=\"2022-11-08T14:15:24.000+02:00\" cardVerificationStatus=\"not_eligible\"/>\n\t  </Card>\n\t</Cards>\n</FindCardResponse>"}}},"403":{"description":"Forbidden","content":{"application/json":{"examples":{"ApiConsumerClosed":{"value":{"detail":"API consumer 00000000-0000-0000-0000-000000000000 is closed and cannot be modified"}},"ErrorDeterminingCustomership":{"value":{"detail":"Error determining customer-identifier customership."}},"NoActiveCustomership":{"value":{"detail":"No active customership for customer-identifier. Customer should contact Vastuu Group support."}},"CustomerIdentifierInvalid":{"value":{"detail":"customer-identifier is invalid or doesn't exist"}},"CustomerIdentifierNotActive":{"value":{"detail":"customer-identifier is not active"}},"ApiConsumerNotRegistered":{"value":{"detail":"API consumer is not registered"}},"LimitedRoleException":{"value":{"detail":"You are not allowed to access requested data for the provided customer-identifier."}},"LimitedCountriesException":{"value":{"detail":"You are not allowed to access the requested data for the provided customer-identifier due to country restrictions."}}},"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"404":{"description":"Not Found","content":{"application/json":{"examples":{"ApiConsumerNotFound":{"value":{"detail":"API consumer not found."}},"CustomerNotFound":{"value":{"detail":"Customer identifier 00000000-0000-0000-0000-000000000000 not found."}}},"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"413":{"description":"Request Entity Too Large","content":{"application/json":{"examples":{"RequestTooLarge":{"value":{"detail":"Request exceeds the maximum allowed size."}}},"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"examples":{"RateLimitExceeded":{"value":{"detail":"Too many requests"}}},"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Invalid request","content":{"application/xml":{"schema":{"$ref":"#/components/schemas/FindCardResponseInvalidRequest"},"example":"<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<FindCardResponse result=\"InvalidRequest\" xmlns=\"http://www.tilaajavastuu.fi/korva.xsd\">\n</FindCardResponse>\n"}}}},"description":"Get list of closed and/or expired Valtti cards. The system returns up to the last 10000 Valtti cards\nfrom the Korttivarasto. The default is to return the Valtti cards in the last month.\n\n**Use this endpoint to check if Valtti cards has closed or expired.**\n\n**Required scope:**\n`korttivarasto/status_get`\n"}},"/korttivarasto/v1.3/cards/{barcode}.{type_extension}":{"get":{"tags":["Korttivarasto API v1.3"],"summary":"Get a single Valtti card by barcode","operationId":"korttivarasto_barcode_korttivarasto_v1_3_cards__barcode___type_extension__get","security":[{"HTTPBearer":["korttivarasto/barcode_get"]}],"parameters":[{"name":"barcode","in":"path","required":true,"schema":{"type":"string","title":"The barcode to get","examples":["733130529643"]}},{"name":"type_extension","in":"path","required":true,"schema":{"type":"string","title":"The type_extension to get","enum":["xml","png","pdf"]}},{"name":"customer-identifier","in":"header","required":true,"schema":{"type":"string","format":"uuid","description":"Customer identifier required on every request","title":"Customer-Identifier"},"description":"Customer identifier required on every request"}],"responses":{"200":{"description":"Successful operation","content":{"application/xml":{"schema":{"$ref":"#/components/schemas/GetCardResponseOK"},"example":"<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<GetCardResponse xmlns=\"http://www.tilaajavastuu.fi/korva.xsd\" result=\"OK\">\n\t<Card barCodeId=\"123456789012\" uid=\"1A245V7DA0FDD\" validUntil=\"2024-12-12T23:00:00.000+02:00\">\n\t\t<Status status=\"status\" modifiedBy=\"modifiedBy\" modifiedDate=\"2019-11-08T14:05:39.000+02:00\" cardVerificationStatus=\"verified\">\n\t\t</Status>\n\t\t<Person firstName=\"Matti\" surname=\"Meikäläinen\" taxNumber=\"100011111111\" birthDay=\"01.03.1988\">\n\t\t</Person>\n\t\t<Employer name=\"Vastuu Group Oy\" businessId=\"2327327-1\" countryCode=\"FI\">\n\t\t</Employer>\n\t</Card>\n</GetCardResponse>\n"},"application/pdf":{"schema":{"type":"string","format":"binary"},"example":"Binary file"},"image/png":{"schema":{"type":"string","format":"binary"},"example":"Binary file"}}},"403":{"description":"Forbidden","content":{"application/json":{"examples":{"ApiConsumerClosed":{"value":{"detail":"API consumer 00000000-0000-0000-0000-000000000000 is closed and cannot be modified"}},"ErrorDeterminingCustomership":{"value":{"detail":"Error determining customer-identifier customership."}},"NoActiveCustomership":{"value":{"detail":"No active customership for customer-identifier. Customer should contact Vastuu Group support."}},"CustomerIdentifierInvalid":{"value":{"detail":"customer-identifier is invalid or doesn't exist"}},"CustomerIdentifierNotActive":{"value":{"detail":"customer-identifier is not active"}},"ApiConsumerNotRegistered":{"value":{"detail":"API consumer is not registered"}},"LimitedRoleException":{"value":{"detail":"You are not allowed to access requested data for the provided customer-identifier."}},"LimitedCountriesException":{"value":{"detail":"You are not allowed to access the requested data for the provided customer-identifier due to country restrictions."}}},"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"404":{"description":"Not found","content":{"application/json":{"examples":{"ApiConsumerNotFound":{"value":{"detail":"API consumer not found."}},"CustomerNotFound":{"value":{"detail":"Customer identifier 00000000-0000-0000-0000-000000000000 not found."}}},"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}},"application/xml":{"schema":{"$ref":"#/components/schemas/GetCardResponseNotFound"},"example":"<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<GetCardResponse errorText=\"Card not found\" result=\"NotFound\" xmlns=\"http://www.tilaajavastuu.fi/korva.xsd\">\n</GetCardResponse>\n"},"text/plain":{"examples":{"PDFNotFound":{"value":"PDF not found"},"PNGNotFound":{"value":"PNG not found"}}}}},"413":{"description":"Request Entity Too Large","content":{"application/json":{"examples":{"RequestTooLarge":{"value":{"detail":"Request exceeds the maximum allowed size."}}},"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"examples":{"RateLimitExceeded":{"value":{"detail":"Too many requests"}}},"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Invalid request / Bad request","content":{"application/xml":{"schema":{"$ref":"#/components/schemas/GetCardResponseInvalidRequest"},"examples":{"InvalidBarCodeId":{"value":"<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<GetCardResponse errorText=\"Invalid BarCodeId\" result=\"InvalidRequest\" xmlns=\"http://www.tilaajavastuu.fi/korva.xsd\">\n</GetCardResponse>\n"},"InvalidRequest":{"value":"<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<GetCardResponse result=\"InvalidRequest\" xmlns=\"http://www.tilaajavastuu.fi/korva.xsd\">\n</GetCardResponse>\n"}}},"text/plain":{"example":"Bad request"}}}},"description":"Get the Valtti card information in XML format, as a PDF document (Valtti card print template) or as a PNG image of the person.\n\n**Required scope:**\n`korttivarasto/barcode_get`\n"}},"/korttivarasto/v1.3/cards/uid/{uid}.{type_extension}":{"get":{"tags":["Korttivarasto API v1.3"],"summary":"Get a single Valtti card by uid","operationId":"korttivarasto_uid_korttivarasto_v1_3_cards_uid__uid___type_extension__get","security":[{"HTTPBearer":["korttivarasto/uid_get"]}],"parameters":[{"name":"uid","in":"path","required":true,"schema":{"type":"string","title":"The uid to get","examples":["040a376ad26280"]}},{"name":"type_extension","in":"path","required":true,"schema":{"type":"string","title":"The type_extension to get","enum":["xml","png","pdf"]}},{"name":"customer-identifier","in":"header","required":true,"schema":{"type":"string","format":"uuid","description":"Customer identifier required on every request","title":"Customer-Identifier"},"description":"Customer identifier required on every request"}],"responses":{"200":{"description":"Successful operation","content":{"application/xml":{"schema":{"$ref":"#/components/schemas/GetCardResponseOK"},"example":"<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<GetCardResponse xmlns=\"http://www.tilaajavastuu.fi/korva.xsd\" result=\"OK\">\n\t<Card barCodeId=\"123456789012\" uid=\"1A245V7DA0FDD\" validUntil=\"2024-12-12T23:00:00.000+02:00\">\n\t\t<Status status=\"status\" modifiedBy=\"modifiedBy\" modifiedDate=\"2019-11-08T14:05:39.000+02:00\" cardVerificationStatus=\"verified\">\n\t\t</Status>\n\t\t<Person firstName=\"Matti\" surname=\"Meikäläinen\" taxNumber=\"100011111111\" birthDay=\"01.03.1988\">\n\t\t</Person>\n\t\t<Employer name=\"Vastuu Group Oy\" businessId=\"2327327-1\" countryCode=\"FI\">\n\t\t</Employer>\n\t</Card>\n</GetCardResponse>\n"},"application/pdf":{"schema":{"type":"string","format":"binary"},"example":"Binary file"},"image/png":{"schema":{"type":"string","format":"binary"},"example":"Binary file"}}},"403":{"description":"Forbidden","content":{"application/json":{"examples":{"ApiConsumerClosed":{"value":{"detail":"API consumer 00000000-0000-0000-0000-000000000000 is closed and cannot be modified"}},"ErrorDeterminingCustomership":{"value":{"detail":"Error determining customer-identifier customership."}},"NoActiveCustomership":{"value":{"detail":"No active customership for customer-identifier. Customer should contact Vastuu Group support."}},"CustomerIdentifierInvalid":{"value":{"detail":"customer-identifier is invalid or doesn't exist"}},"CustomerIdentifierNotActive":{"value":{"detail":"customer-identifier is not active"}},"ApiConsumerNotRegistered":{"value":{"detail":"API consumer is not registered"}},"LimitedRoleException":{"value":{"detail":"You are not allowed to access requested data for the provided customer-identifier."}},"LimitedCountriesException":{"value":{"detail":"You are not allowed to access the requested data for the provided customer-identifier due to country restrictions."}}},"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"404":{"description":"Not found","content":{"application/json":{"examples":{"ApiConsumerNotFound":{"value":{"detail":"API consumer not found."}},"CustomerNotFound":{"value":{"detail":"Customer identifier 00000000-0000-0000-0000-000000000000 not found."}}},"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}},"application/xml":{"schema":{"$ref":"#/components/schemas/GetCardResponseNotFound"},"example":"<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<GetCardResponse errorText=\"Card not found\" result=\"NotFound\" xmlns=\"http://www.tilaajavastuu.fi/korva.xsd\">\n</GetCardResponse>\n"},"text/plain":{"examples":{"PDFNotFound":{"value":"PDF not found"},"PNGNotFound":{"value":"PNG not found"}}}}},"413":{"description":"Request Entity Too Large","content":{"application/json":{"examples":{"RequestTooLarge":{"value":{"detail":"Request exceeds the maximum allowed size."}}},"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"examples":{"RateLimitExceeded":{"value":{"detail":"Too many requests"}}},"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Invalid request / Bad request","content":{"application/xml":{"schema":{"$ref":"#/components/schemas/GetCardResponseInvalidRequest"},"examples":{"InvalidUID":{"value":"<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<GetCardResponse errorText=\"Invalid UID\" result=\"InvalidRequest\" xmlns=\"http://www.tilaajavastuu.fi/korva.xsd\">\n</GetCardResponse>\n"},"InvalidRequest":{"value":"<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<GetCardResponse result=\"InvalidRequest\" xmlns=\"http://www.tilaajavastuu.fi/korva.xsd\">\n</GetCardResponse>\n"}}},"text/plain":{"example":"Bad request"}}}},"description":"Get the Valtti card information in XML format, as a PDF document (Valtti card print template) or as a PNG image of the person.\n\n**Required scope:**\n`korttivarasto/uid_get`\n"}},"/korttivarasto/v1.3/cards/businessId/{business_id}/countryCode/{country_code}/taxNumber/{tax_number}.{type_extension}":{"get":{"tags":["Korttivarasto API v1.3"],"summary":"Get a single Valtti card by business id and tax number","operationId":"korttivarasto_business_id_tax_number_korttivarasto_v1_3_cards_businessId__business_id__countryCode__country_code__taxNumber__tax_number___type_extension__get","security":[{"HTTPBearer":["korttivarasto/business_id_tax_number_get"]}],"parameters":[{"name":"business_id","in":"path","required":true,"schema":{"type":"string","title":"The business_id to get","examples":["2327327-1"]}},{"name":"country_code","in":"path","required":true,"schema":{"type":"string","title":"The country code to get","examples":["FI"]}},{"name":"tax_number","in":"path","required":true,"schema":{"type":"string","title":"The tax_number to get","examples":["100010086037"]}},{"name":"type_extension","in":"path","required":true,"schema":{"type":"string","title":"The type_extension to get","enum":["xml","png","pdf"]}},{"name":"customer-identifier","in":"header","required":true,"schema":{"type":"string","format":"uuid","description":"Customer identifier required on every request","title":"Customer-Identifier"},"description":"Customer identifier required on every request"}],"responses":{"200":{"description":"Successful operation","content":{"application/xml":{"schema":{"$ref":"#/components/schemas/GetCardResponseOK"},"example":"<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<GetCardResponse xmlns=\"http://www.tilaajavastuu.fi/korva.xsd\" result=\"OK\">\n\t<Card barCodeId=\"123456789012\" uid=\"1A245V7DA0FDD\" validUntil=\"2024-12-12T23:00:00.000+02:00\">\n\t\t<Status status=\"status\" modifiedBy=\"modifiedBy\" modifiedDate=\"2019-11-08T14:05:39.000+02:00\" cardVerificationStatus=\"verified\">\n\t\t</Status>\n\t\t<Person firstName=\"Matti\" surname=\"Meikäläinen\" taxNumber=\"100011111111\" birthDay=\"01.03.1988\">\n\t\t</Person>\n\t\t<Employer name=\"Vastuu Group Oy\" businessId=\"2327327-1\" countryCode=\"FI\">\n\t\t</Employer>\n\t</Card>\n</GetCardResponse>\n"},"application/pdf":{"schema":{"type":"string","format":"binary"},"example":"Binary file"},"image/png":{"schema":{"type":"string","format":"binary"},"example":"Binary file"}}},"403":{"description":"Forbidden","content":{"application/json":{"examples":{"ApiConsumerClosed":{"value":{"detail":"API consumer 00000000-0000-0000-0000-000000000000 is closed and cannot be modified"}},"ErrorDeterminingCustomership":{"value":{"detail":"Error determining customer-identifier customership."}},"NoActiveCustomership":{"value":{"detail":"No active customership for customer-identifier. Customer should contact Vastuu Group support."}},"CustomerIdentifierInvalid":{"value":{"detail":"customer-identifier is invalid or doesn't exist"}},"CustomerIdentifierNotActive":{"value":{"detail":"customer-identifier is not active"}},"ApiConsumerNotRegistered":{"value":{"detail":"API consumer is not registered"}},"LimitedRoleException":{"value":{"detail":"You are not allowed to access requested data for the provided customer-identifier."}},"LimitedCountriesException":{"value":{"detail":"You are not allowed to access the requested data for the provided customer-identifier due to country restrictions."}}},"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"404":{"description":"Not found","content":{"application/json":{"examples":{"ApiConsumerNotFound":{"value":{"detail":"API consumer not found."}},"CustomerNotFound":{"value":{"detail":"Customer identifier 00000000-0000-0000-0000-000000000000 not found."}}},"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}},"application/xml":{"schema":{"$ref":"#/components/schemas/GetCardResponseNotFound"},"example":"<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<GetCardResponse errorText=\"Card not found\" result=\"NotFound\" xmlns=\"http://www.tilaajavastuu.fi/korva.xsd\">\n</GetCardResponse>\n"},"text/plain":{"examples":{"PDFNotFound":{"value":"PDF not found"},"PNGNotFound":{"value":"PNG not found"}}}}},"413":{"description":"Request Entity Too Large","content":{"application/json":{"examples":{"RequestTooLarge":{"value":{"detail":"Request exceeds the maximum allowed size."}}},"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"examples":{"RateLimitExceeded":{"value":{"detail":"Too many requests"}}},"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Invalid request / Bad request","content":{"application/xml":{"schema":{"$ref":"#/components/schemas/GetCardResponseInvalidRequest"},"examples":{"InvalidTaxNumber":{"value":"<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<GetCardResponse errorText=\"Invalid TaxNumber\" result=\"InvalidRequest\" xmlns=\"http://www.tilaajavastuu.fi/korva.xsd\">\n</GetCardResponse>\n"},"InvalidRequest":{"value":"<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<GetCardResponse result=\"InvalidRequest\" xmlns=\"http://www.tilaajavastuu.fi/korva.xsd\">\n</GetCardResponse>\n"}}},"text/plain":{"example":"Bad request"}}}},"description":"Get the Valtti card information in XML format, as a PDF document (Valtti card print template) or as a PNG image of the person.\n\n**Required scope:**\n`korttivarasto/business_id_tax_number_get`\n"}},"/luotettavakumppani/v1.1/report_versions":{"post":{"tags":["Luotettava Kumppani API v1.1"],"summary":"Fetch report versions (CL and RP)","operationId":"luotettavakumppani_report_versions_luotettavakumppani_v1_1_report_versions_post","security":[{"HTTPBearer":["luotettavakumppani/rp_full"]}],"parameters":[{"name":"customer-identifier","in":"header","required":false,"schema":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"description":"Optional customer identifier, if applicable","title":"Customer-Identifier"},"description":"Optional customer identifier, if applicable"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"string"},"description":"List of business id's that are included in the query","examples":[["2327327-1","2327327-2"]],"title":"Business Ids List"}}}},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ReportVersions"}},"examples":{"Example#1":{"value":{"cl":["1234567-1"],"rp":["2327327-1"],"no_report":["7654321-1"]}}}}}},"403":{"description":"403 Forbidden","content":{"application/json":{"examples":{"ApiConsumerClosed":{"value":{"detail":"API consumer 00000000-0000-0000-0000-000000000000 is closed and cannot be modified"}},"ErrorDeterminingCustomership":{"value":{"detail":"Error determining customer-identifier customership."}},"NoActiveCustomership":{"value":{"detail":"No active customership for customer-identifier. Customer should contact Vastuu Group support."}},"CustomerIdentifierInvalid":{"value":{"detail":"customer-identifier is invalid or doesn't exist"}},"CustomerIdentifierNotActive":{"value":{"detail":"customer-identifier is not active"}},"ApiConsumerNotRegistered":{"value":{"detail":"API consumer is not registered"}},"LimitedRoleException":{"value":{"detail":"You are not allowed to access requested data for the provided customer-identifier."}},"LimitedCountriesException":{"value":{"detail":"You are not allowed to access the requested data for the provided customer-identifier due to country restrictions."}},"NoActiveValvojaLicense":{"value":{"detail":"No active license.","error":"license_missing","product_plan_id":"","product_family_id":"Valvoja","product_name":"Valvoja"}}},"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"404":{"description":"Not Found","content":{"application/json":{"examples":{"ApiConsumerNotFound":{"value":{"detail":"API consumer not found."}},"CustomerNotFound":{"value":{"detail":"Customer identifier 00000000-0000-0000-0000-000000000000 not found."}}},"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"413":{"description":"Request Entity Too Large","content":{"application/json":{"examples":{"RequestTooLarge":{"value":{"detail":"Request exceeds the maximum allowed size."}}},"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"examples":{"RateLimitExceeded":{"value":{"detail":"Too many requests"}}},"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"500":{"description":"Internal Server Error","content":{"text/plain":{"schema":{"type":"string"},"examples":{"Example#1":{"value":"Unexpected error"}}}}}},"description":"This is the mandatory first step before calling other data retrieval endpoints.\n\nCheck which companies in the request have an active RP CL or RP report version. Only companies with an active report version are returned in `cl` or `rp`; companies without an active report version are returned in `no_report`.\n\nIf the request body is an empty list, all companies with an active RP CL or RP report version are returned.\n\n**Required scope**: `luotettavakumppani/rp_full`\n"}},"/luotettavakumppani/v1.1/cl_interpretations":{"post":{"tags":["Luotettava Kumppani API v1.1"],"summary":"Fetch CL interpretations (CL)","operationId":"luotettavakumppani_cl_interpretations_luotettavakumppani_v1_1_cl_interpretations_post","security":[{"HTTPBearer":["luotettavakumppani/cl_interpretations"]}],"parameters":[{"name":"changed_after","in":"query","required":true,"schema":{"type":"string","description":"string <date-time>","examples":["2024-09-01T00:00:00.000Z"],"title":"Changed After"},"description":"string <date-time>"},{"name":"customer-identifier","in":"header","required":false,"schema":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"description":"Optional customer identifier, if applicable","title":"Customer-Identifier"},"description":"Optional customer identifier, if applicable"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"string"},"description":"List of business id's that are included in the query","examples":[["2327327-1","2327327-2"]],"title":"Business Ids List"}}}},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ClInterpretationInfo"}},"examples":{"Example#1":{"value":[{"business_id":"2327327-1","archive_code":"1745038442073","interpretation":"GREEN","cl_activity":"ACTIVE","updated_at":"2025-02-04T11:29:05.899835Z"}]}}}}},"403":{"description":"Forbidden","content":{"application/json":{"examples":{"ApiConsumerClosed":{"value":{"detail":"API consumer 00000000-0000-0000-0000-000000000000 is closed and cannot be modified"}},"ErrorDeterminingCustomership":{"value":{"detail":"Error determining customer-identifier customership."}},"NoActiveCustomership":{"value":{"detail":"No active customership for customer-identifier. Customer should contact Vastuu Group support."}},"CustomerIdentifierInvalid":{"value":{"detail":"customer-identifier is invalid or doesn't exist"}},"CustomerIdentifierNotActive":{"value":{"detail":"customer-identifier is not active"}},"ApiConsumerNotRegistered":{"value":{"detail":"API consumer is not registered"}},"LimitedRoleException":{"value":{"detail":"You are not allowed to access requested data for the provided customer-identifier."}},"LimitedCountriesException":{"value":{"detail":"You are not allowed to access the requested data for the provided customer-identifier due to country restrictions."}}},"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"404":{"description":"Not Found","content":{"application/json":{"examples":{"ApiConsumerNotFound":{"value":{"detail":"API consumer not found."}},"CustomerNotFound":{"value":{"detail":"Customer identifier 00000000-0000-0000-0000-000000000000 not found."}}},"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"413":{"description":"Request Entity Too Large","content":{"application/json":{"examples":{"RequestTooLarge":{"value":{"detail":"Request exceeds the maximum allowed size."}}},"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"examples":{"RateLimitExceeded":{"value":{"detail":"Too many requests"}}},"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"401":{"description":"Unauthorized","content":{"*/*":{"schema":{"type":"object"}}}},"400":{"description":"Bad Request – invalid or malformed parameters.\nThis error occurs, for example, if the `changed_after` query parameter is not a valid date-time.\n","content":{"application/json":{"schema":{"type":"object"},"examples":{"Example#1":{"value":{"status":-3,"result":null,"reason":"Bad request: Can't transform call to resource"}}}}}}},"description":"Fetch RP CL interpretations for given companies with an active RP CL or RP report version.\n\n**Required scope**: `luotettavakumppani/cl_interpretations`\n"}},"/luotettavakumppani/v1.1/interpretations":{"post":{"tags":["Luotettava Kumppani API v1.1"],"summary":"Fetch interpretations (RP)","operationId":"luotettavakumppani_interpretations_luotettavakumppani_v1_1_interpretations_post","security":[{"HTTPBearer":["luotettavakumppani/rp_interpretations"]}],"parameters":[{"name":"changed_after","in":"query","required":true,"schema":{"type":"string","description":"string <date-time>","examples":["2024-09-01T00:00:00.000Z"],"title":"Changed After"},"description":"string <date-time>"},{"name":"customer-identifier","in":"header","required":true,"schema":{"type":"string","format":"uuid","description":"Customer identifier required on every request","title":"Customer-Identifier"},"description":"Customer identifier required on every request"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"string"},"description":"List of business id's that are included in the query","examples":[["2327327-1","2327327-2"]],"title":"Business Ids List"}}}},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PreCalculatedSubInterpretations"}},"examples":{"Example#1":{"value":[{"business_id":"2327327-1","rp_activity":"ACTIVE","combined_interpretation":"RED","cl_report_sub_interpretation":"BLUE","key_person_sub_interpretation":"GREEN","finance_classification_sub_interpretation":"RED","finance_other_sub_interpretation":"YELLOW","company_sub_interpretation":"GREEN","company_status":"ACTIVE","updated_at":"2024-05-23T05:37:43.987011Z"}]}}}}},"403":{"description":"403 Forbidden","content":{"application/json":{"examples":{"ApiConsumerClosed":{"value":{"detail":"API consumer 00000000-0000-0000-0000-000000000000 is closed and cannot be modified"}},"ErrorDeterminingCustomership":{"value":{"detail":"Error determining customer-identifier customership."}},"NoActiveCustomership":{"value":{"detail":"No active customership for customer-identifier. Customer should contact Vastuu Group support."}},"CustomerIdentifierInvalid":{"value":{"detail":"customer-identifier is invalid or doesn't exist"}},"CustomerIdentifierNotActive":{"value":{"detail":"customer-identifier is not active"}},"ApiConsumerNotRegistered":{"value":{"detail":"API consumer is not registered"}},"LimitedRoleException":{"value":{"detail":"You are not allowed to access requested data for the provided customer-identifier."}},"LimitedCountriesException":{"value":{"detail":"You are not allowed to access the requested data for the provided customer-identifier due to country restrictions."}},"NoActiveValvojaLicense":{"value":{"detail":"No active license.","error":"license_missing","product_plan_id":"","product_family_id":"Valvoja","product_name":"Valvoja"}}},"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"404":{"description":"Not Found","content":{"application/json":{"examples":{"ApiConsumerNotFound":{"value":{"detail":"API consumer not found."}},"CustomerNotFound":{"value":{"detail":"Customer identifier 00000000-0000-0000-0000-000000000000 not found."}}},"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"413":{"description":"Request Entity Too Large","content":{"application/json":{"examples":{"RequestTooLarge":{"value":{"detail":"Request exceeds the maximum allowed size."}}},"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"examples":{"RateLimitExceeded":{"value":{"detail":"Too many requests"}}},"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request – invalid or malformed parameters.\nThis error occurs, for example, if the `changed_after` query parameter is not a valid date-time.\n","content":{"application/json":{"schema":{"type":"object"},"examples":{"Example#1":{"value":{"status":-3,"result":null,"reason":"Bad request: Can't transform call to resource"}}}}}},"500":{"description":"Internal Server Error","content":{"text/plain":{"schema":{"type":"string"},"examples":{"Example#1":{"value":"Unexpected error"}}}}}},"x-billable":true,"description":"Fetch RP interpretations for given companies with an active RP report version.\n\n**Required scope**: `luotettavakumppani/rp_interpretations`\n"}},"/luotettavakumppani/v1.1/combined_interpretations":{"post":{"tags":["Luotettava Kumppani API v1.1"],"summary":"Fetch combined interpretations (CL and RP)","operationId":"luotettavakumppani_combined_interpretations_luotettavakumppani_v1_1_combined_interpretations_post","security":[{"HTTPBearer":["luotettavakumppani/combined_interpretations"]}],"parameters":[{"name":"changed_after","in":"query","required":true,"schema":{"type":"string","description":"string <date-time>","examples":["2024-09-01T00:00:00.000Z"],"title":"Changed After"},"description":"string <date-time>"},{"name":"customer-identifier","in":"header","required":true,"schema":{"type":"string","format":"uuid","description":"Customer identifier required on every request","title":"Customer-Identifier"},"description":"Customer identifier required on every request"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"string"},"description":"List of business id's that are included in the query","examples":[["2327327-1","2327327-2"]],"title":"Business Ids List"}}}},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/RpAndClInterpretations"}},"examples":{"Example#1":{"value":[{"business_id":"2327327-1","cl":{"archive_code":"1745038442073","interpretation":"GREEN","cl_activity":"ACTIVE","updated_at":"2025-02-04T11:29:05.899835Z"},"rp":{"combined_interpretation":"RED","rp_activity":"ACTIVE","updated_at":"2025-02-04T11:49:10.962049Z"}}]}}}}},"403":{"description":"403 Forbidden","content":{"application/json":{"examples":{"ApiConsumerClosed":{"value":{"detail":"API consumer 00000000-0000-0000-0000-000000000000 is closed and cannot be modified"}},"ErrorDeterminingCustomership":{"value":{"detail":"Error determining customer-identifier customership."}},"NoActiveCustomership":{"value":{"detail":"No active customership for customer-identifier. Customer should contact Vastuu Group support."}},"CustomerIdentifierInvalid":{"value":{"detail":"customer-identifier is invalid or doesn't exist"}},"CustomerIdentifierNotActive":{"value":{"detail":"customer-identifier is not active"}},"ApiConsumerNotRegistered":{"value":{"detail":"API consumer is not registered"}},"LimitedRoleException":{"value":{"detail":"You are not allowed to access requested data for the provided customer-identifier."}},"LimitedCountriesException":{"value":{"detail":"You are not allowed to access the requested data for the provided customer-identifier due to country restrictions."}},"NoActiveValvojaLicense":{"value":{"detail":"No active license.","error":"license_missing","product_plan_id":"","product_family_id":"Valvoja","product_name":"Valvoja"}}},"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"404":{"description":"Not Found","content":{"application/json":{"examples":{"ApiConsumerNotFound":{"value":{"detail":"API consumer not found."}},"CustomerNotFound":{"value":{"detail":"Customer identifier 00000000-0000-0000-0000-000000000000 not found."}}},"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"413":{"description":"Request Entity Too Large","content":{"application/json":{"examples":{"RequestTooLarge":{"value":{"detail":"Request exceeds the maximum allowed size."}}},"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"examples":{"RateLimitExceeded":{"value":{"detail":"Too many requests"}}},"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"401":{"description":"Unauthorized","content":{"*/*":{"schema":{"type":"object"}}}},"400":{"description":"Bad Request – invalid or malformed parameters.\nThis error occurs, for example, if the `changed_after` query parameter is not a valid date-time.\n","content":{"application/json":{"schema":{"type":"object"},"examples":{"Example#1":{"value":{"status":-3,"result":null,"reason":"Bad request: Can't transform call to resource"}}}}}}},"description":"Fetch combined RP and RP CL interpretations for given companies with an active RP report version.\n\n**Required scope**: `luotettavakumppani/combined_interpretations`\n"}},"/luotettavakumppani/v1.1/cl_reports":{"post":{"tags":["Luotettava Kumppani API v1.1"],"summary":"Fetch Partner Contractor’s Liability Information reports (CL)","operationId":"luotettavakumppani_cl_reports_luotettavakumppani_v1_1_cl_reports_post","security":[{"HTTPBearer":["luotettavakumppani/cl_reports"]}],"parameters":[{"name":"changed_after","in":"query","required":true,"schema":{"type":"string","description":"string <date-time>","examples":["2024-09-01T00:00:00.000Z"],"title":"Changed After"},"description":"string <date-time>"},{"name":"starting_after","in":"query","required":false,"schema":{"type":"string","description":"Archive code of the last entry","examples":["1731343204059"],"title":"Starting After"},"description":"Archive code of the last entry"},{"name":"customer-identifier","in":"header","required":true,"schema":{"type":"string","format":"uuid","description":"Customer identifier required on every request","title":"Customer-Identifier"},"description":"Customer identifier required on every request"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"string"},"description":"List of business id's that are included in the query","examples":[["2327327-1","2327327-2"]],"title":"Business Ids List"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ClRegisterInformation"}},"examples":{"Example#1":{"value":[{"archive_code":"1731343204059","created":"2024-11-11T18:40:04","version":"3.0","matching_registration_number":"2327327-1","clreports":{"archive_code":"1731343204059","valid_until":"2024-12-03","valid_from":"2024-11-11","created":"2024-11-11T18:40:04","interpretation":"BLUE","description":"Yrityksen ilmoituksen mukaan ei velvollisuutta kuulua rekisteriin.","reports":[{"main_business":"Langattoman verkon hallinta ja palvelut","company_format":"Osakeyhtiö","domicile":"Helsinki","activity":"Voimassa","country":"FI","registration_number":"2327327-1","company_name":"Testiyritys 'Yy' Oy","interpretation":"BLUE","bis":{"source":"Suomen Asiakastieto Oy","updated":"2024-09-03","interpretation":"GREEN","tax_basic_reg":{"interpretation":"GREEN","status":"Rekisterissä","registration_start_date":"2000-01-01"},"vat_reg_info":{"interpretation":"GREEN","status":"Rekisterissä","vat_number":"FI23273271","vat_regs":[{"registration_start_date":"2000-01-01","status":"Rekisterissä","type":"Liiketoiminnasta arvonlisäverovelvollinen"}]},"prepayment_reg":{"interpretation":"GREEN","status":"Rekisterissä","registration_start_date":"2000-01-01"},"trade_reg":{"interpretation":"GREEN","status":"Rekisterissä","registration_start_date":"1900-01-01"},"employer_reg":{"interpretation":"GREEN","status":"Rekisterissä","registration_start_date":"2000-01-01"}},"company_relations":{"interpretation":"GREEN","status":"Ei liiketoimintakieltoja","persons":[{"source":"Suomen Asiakastieto Oy","birthdate":"2001-01-01","role":"Toimitusjohtaja","surname":"Sukunimi","forename":"Etunimi 61"},{"source":"Suomen Asiakastieto Oy","birthdate":"2001-01-01","role":"Hallituksen puheenjohtaja","surname":"Sukunimi","forename":"Etunimi 62"},{"source":"Suomen Asiakastieto Oy","birthdate":"2001-01-01","role":"Varsinainen jäsen","surname":"Sukunimi","forename":"Etunimi 63"},{"source":"Suomen Asiakastieto Oy","birthdate":"2001-01-01","role":"Varsinainen jäsen","surname":"Sukunimi","forename":"Etunimi 64"},{"source":"Suomen Asiakastieto Oy","birthdate":null,"role":"Tilintarkastaja","surname":"Yritys 11","forename":""},{"source":"Suomen Asiakastieto Oy","birthdate":"2008-08-19","role":"Elinkeinonharjoittaja","surname":"Sweden","forename":"Test One"}]},"tax":{"interpretation":"BLUE","status":"Perintäkielto, saneerausmenettely, merkintä verovelkarekisterissä","source":"Verohallinto","remark":"Yritys on merkitty julkiseen verovelkarekisteriin. Yrityksen erääntyneet verovelat ovat perintäkiellossa. Tuomioistuin on päättänyt joko 1. yrityssaneeraushakemukseen liittyvästä väliaikaisesta perintäkiellosta tai 2. tuomioistuin on päättänyt varhaisen tai perusmuotoisen yrityssaneerausmenettelyn aloittamisesta. Saneerausohjelmaa ei ole vielä vahvistettu tuomioistuimessa.","description":"Yritys on merkitty julkiseen verovelkarekisteriin. Tuomioistuin on päättänyt joko 1. yrityssaneeraushakemukseen liittyvästä väliaikaisesta perintäkiellosta tai 2. varhaisen tai perusmuotoisen yrityssaneerausmenettelyn aloittamisesta. Tarkista raportin veromaksutiedot ja pyydä sopimuskumppanilta lisäselvitystä tilanteesta.","updated":"2024-09-03"},"pension_insurances":{"interpretation":"GREEN","status":"Maksettu","remark":null,"insurances":[{"source":"Eläkevakuutusyhtiö","updated":"2024-09-03","status":"Maksettu"}]},"entrepreneur_insurances":{"interpretation":"GREEN","status":"Ei ilmoitettu","description":"Ei enää pakollinen tieto"},"collective_agreements":{"interpretation":"GREEN","status":"Ilmoitettu","agreements":[{"name":"BINGOTYÖNTEKIJÖITÄ KOSKEVA TYÖEHTOSOPIMUS","source":"Yrityksen ilmoittama"},{"name":"AHTAUSALAN TEKNISTEN TOIMIHENKILÖIDEN TYÖEHTOSOPIMUS","source":"Yrityksen ilmoittama"},{"name":"AHTAUSALAN TYÖNJOHTAJIEN TYÖEHTOSOPIMUS","source":"Yrityksen ilmoittama"},{"name":"AHTAUSALAN AMMATTITYÖNTEKIJÄKUNTAA JA TILAPÄISIÄ TYÖNTEKIJÖITÄ KOSKEVA TYÖEHTOSOPIMUS","source":"Yrityksen ilmoittama"}]},"accident_insurances":{"interpretation":"GREEN","status":"Ilmoitettu","remark":"Tapaturmavakuutus on otettu ja voimassa.","insurances":[{"date_of_issue":"2024-09-03","insurer":"IF Vahinkovakuutusyhtiö Oy","source":"Vakuutusyhtiö","status":"Ilmoitettu","type":"Lakisääteinen tapaturmavakuutus"}]},"register_information":{"interpretation":"BLUE","status":"Puuttuu","register_extracts":[]},"liability_insurances":{"created":"2024-11-11T18:40:04","status":"Ilmoitettu","insured_companies":[{"company_name":"Testiyritys 'Yy' Oy","country_code":"FI","registration_number":"2327327-1","liability_insurances":[{"amount_insured":"10000","business_area":"Kaiken kattava korjaaminen","date_of_issue":"2024-09-03","insurer":"IF Vahinkovakuutusyhtiö Oy","source":"TV","status":"Ilmoitettu","valid_from":"2023-05-03","valid_until":"2025-05-31","validity_area":"USA","description":null},{"amount_insured":"Lakisääteinen","business_area":"Potilasvakuutus","date_of_issue":"2024-09-03","insurer":"IF Vahinkovakuutusyhtiö Oy","source":"TV","status":"Ilmoitettu","valid_from":"2023-01-01","valid_until":"2024-12-31","validity_area":"Eurooppa","description":"Potilasvakuutus"},{"amount_insured":"10000","business_area":"Potilaan hoitaminen","date_of_issue":"2024-09-03","insurer":"LähiTapiola","source":"TV","status":"Ilmoitettu","valid_from":"2022-12-22","valid_until":"2025-09-30","validity_area":"Kanada","description":"Potilasvakuutus"}]}]},"health_cares":{"interpretation":"GREEN","status":"Ilmoitettu","remark":null,"created":"2024-11-11T18:40:04","company_health_services":[{"company_name":"Testiyritys 'Yy' Oy","country_code":"FI","registration_number":"2327327-1","health_care_providers":[{"address":null,"occupational_health_center":"A-Terveys","registered":"2024-04-04","source":"TV"},{"address":null,"occupational_health_center":"DD-Terveys","registered":"2024-04-05","source":"TV"},{"address":null,"occupational_health_center":"BB-Terveys","registered":"2024-05-31","source":"TV"}]}]},"rala":{"description":"Yritys ei ole RALA-pätevä.","created":"2024-11-11T18:40:04"},"ratings":[{"source":"Dun & Bradstreet Finland Oy","updated":"2023-10-02T09:54:05","description":"Luottokelpoinen","rated_business_id":"2327327-1","type":"A"},{"source":"Suomen Asiakastieto Oy","updated":"2023-10-02T09:54:05","description":"hyvä luottoluokitus","rated_business_id":"2327327-1","type":"Suomen Vahvimmat Hopea"}],"operating_licenses":null}]}}]}}}}},"403":{"description":"403 Forbidden","content":{"application/json":{"examples":{"ApiConsumerClosed":{"value":{"detail":"API consumer 00000000-0000-0000-0000-000000000000 is closed and cannot be modified"}},"ErrorDeterminingCustomership":{"value":{"detail":"Error determining customer-identifier customership."}},"NoActiveCustomership":{"value":{"detail":"No active customership for customer-identifier. Customer should contact Vastuu Group support."}},"CustomerIdentifierInvalid":{"value":{"detail":"customer-identifier is invalid or doesn't exist"}},"CustomerIdentifierNotActive":{"value":{"detail":"customer-identifier is not active"}},"ApiConsumerNotRegistered":{"value":{"detail":"API consumer is not registered"}},"LimitedRoleException":{"value":{"detail":"You are not allowed to access requested data for the provided customer-identifier."}},"LimitedCountriesException":{"value":{"detail":"You are not allowed to access the requested data for the provided customer-identifier due to country restrictions."}},"NoActiveValvojaLicense":{"value":{"detail":"No active license.","error":"license_missing","product_plan_id":"","product_family_id":"Valvoja","product_name":"Valvoja"}}},"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"404":{"description":"Not Found","content":{"application/json":{"examples":{"ApiConsumerNotFound":{"value":{"detail":"API consumer not found."}},"CustomerNotFound":{"value":{"detail":"Customer identifier 00000000-0000-0000-0000-000000000000 not found."}}},"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"413":{"description":"Request Entity Too Large","content":{"application/json":{"examples":{"RequestTooLarge":{"value":{"detail":"Request exceeds the maximum allowed size."}}},"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"examples":{"RateLimitExceeded":{"value":{"detail":"Too many requests"}}},"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request – invalid or malformed parameters.\nThis error occurs, for example, if the `changed_after` query parameter is not a valid date-time.\n","content":{"application/json":{"schema":{"type":"object"},"examples":{"Example#1":{"value":{"status":-3,"result":null,"reason":"Bad request: Can't transform call to resource"}}}}}},"500":{"description":"Internal Server Error","content":{"text/plain":{"schema":{"type":"string"},"examples":{"Example#1":{"value":"Unexpected error"}}}}}},"x-billable":true,"description":"Fetch RP CL reports in JSON format for companies with an active RP CL or RP report version.\n\nDue to potentially large number of matches, the returned array size is limited to 500 entries.\n\nTo get all the data, the following process should be applied:\n1. Call /luotettavakumppani/v1.1/cl_reports?changed_after=2004-05-15T05:40:25.487Z\n2. Take the archive code from the last entry in the returned list, and call /luotettavakumppani/v1.1/cl_reports?changed_after=2004-05-15T05:40:25.487Z&starting_after=archive_code_of_the_last_entry\n3. Repeat step 2, until you get an empty list\n\nThe essential parts of the response are as follows.\n* Tilaajavastuu raportit (clreports)\n    * Tilaajavastuu raportti (reports)\n        * Yrityksen perustiedot YTJ-palvelussa (bis)\n            * Verohallinnon perustiedot (tax_basic_reg)\n            * Arvonlisäverovelvollisuus (vat_reg_info)\n                * Arvolisäverovelvollisuustieto (vat_regs)\n            * Ennakkoperintärekisteri (prepayment_reg)\n            * Kaupparekisteri (trade_reg)\n            * Työnantajarekisteri (employer_reg)\n        * Yrityksen yhteydet (company_relations)\n            * Henkilön tiedot (person)\n            * Yrityksen tiedot (company)\n        * Veronmaksutiedot (tax)\n        * Työeläketiedot (pension_insurances)\n            * Työeläketietolista (insurances)\n        * Yrittäjäeläketiedot (entrepreneur_insurances)\n        * Työehtosopimukset (collective_agreements)\n            * Työehtosopimuslista (agreements)\n        * Tapaturmavakuutustiedot (accident_insurances)\n            * Tapaturmavakuutustietolista (insurances)\n        * Rekisteriotteet (register_information)\n            * Rekisteriotelista (register_extracts)\n\n**Required scope**: `luotettavakumppani/cl_reports`\n"}},"/luotettavakumppani/v1.1/finance_changed":{"post":{"tags":["Luotettava Kumppani API v1.1"],"summary":"Fetch finance information changed (RP)","operationId":"luotettavakumppani_finance_changed_luotettavakumppani_v1_1_finance_changed_post","security":[{"HTTPBearer":["luotettavakumppani/rp_full"]}],"parameters":[{"name":"changed_after","in":"query","required":true,"schema":{"type":"string","description":"string <date-time>","examples":["2024-09-01T00:00:00.000Z"],"title":"Changed After"},"description":"string <date-time>"},{"name":"customer-identifier","in":"header","required":true,"schema":{"type":"string","format":"uuid","description":"Customer identifier required on every request","title":"Customer-Identifier"},"description":"Customer identifier required on every request"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"string"},"description":"List of business id's that are included in the query","examples":[["2327327-1","2327327-2"]],"title":"Business Ids List"}}}},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"array","items":{"type":"string"}},"examples":{"Example#1":{"value":["2327327-1"]}}}}},"403":{"description":"403 Forbidden","content":{"application/json":{"examples":{"ApiConsumerClosed":{"value":{"detail":"API consumer 00000000-0000-0000-0000-000000000000 is closed and cannot be modified"}},"ErrorDeterminingCustomership":{"value":{"detail":"Error determining customer-identifier customership."}},"NoActiveCustomership":{"value":{"detail":"No active customership for customer-identifier. Customer should contact Vastuu Group support."}},"CustomerIdentifierInvalid":{"value":{"detail":"customer-identifier is invalid or doesn't exist"}},"CustomerIdentifierNotActive":{"value":{"detail":"customer-identifier is not active"}},"ApiConsumerNotRegistered":{"value":{"detail":"API consumer is not registered"}},"LimitedRoleException":{"value":{"detail":"You are not allowed to access requested data for the provided customer-identifier."}},"LimitedCountriesException":{"value":{"detail":"You are not allowed to access the requested data for the provided customer-identifier due to country restrictions."}},"NoActiveValvojaLicense":{"value":{"detail":"No active license.","error":"license_missing","product_plan_id":"","product_family_id":"Valvoja","product_name":"Valvoja"}}},"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"404":{"description":"Not Found","content":{"application/json":{"examples":{"ApiConsumerNotFound":{"value":{"detail":"API consumer not found."}},"CustomerNotFound":{"value":{"detail":"Customer identifier 00000000-0000-0000-0000-000000000000 not found."}}},"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"413":{"description":"Request Entity Too Large","content":{"application/json":{"examples":{"RequestTooLarge":{"value":{"detail":"Request exceeds the maximum allowed size."}}},"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"examples":{"RateLimitExceeded":{"value":{"detail":"Too many requests"}}},"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"500":{"description":"Internal Server Error","content":{"text/plain":{"schema":{"type":"string"},"examples":{"Example#1":{"value":"Unexpected error"}}}}},"400":{"description":"Bad Request – invalid or malformed parameters.\nThis error occurs, for example, if the `changed_after` query parameter is not a valid date-time.\n","content":{"application/json":{"schema":{"type":"object"},"examples":{"Example#1":{"value":{"status":-3,"result":null,"reason":"Bad request: Can't transform call to resource"}}}}}}},"x-billable":true,"description":"Return business IDs of companies with an active RP report version whose finance data has changed after `changed_after`. Fetch the actual data using `/finance`.\n\n**Required scope**: `luotettavakumppani/rp_full`\n"}},"/luotettavakumppani/v1.1/finance":{"get":{"tags":["Luotettava Kumppani API v1.1"],"summary":"Fetch finance information (RP)","operationId":"luotettavakumppani_finance_luotettavakumppani_v1_1_finance_get","security":[{"HTTPBearer":["luotettavakumppani/rp_full"]}],"parameters":[{"name":"business_id","in":"query","required":true,"schema":{"type":"string","description":"The business id of the organization to get","examples":["2327327-1"],"title":"Business Id"},"description":"The business id of the organization to get"},{"name":"customer-identifier","in":"header","required":true,"schema":{"type":"string","format":"uuid","description":"Customer identifier required on every request","title":"Customer-Identifier"},"description":"Customer identifier required on every request"}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Finance"},"examples":{"Example#1":{"value":{"summary":{"classifications":{"credit_rating":{"interpretation":"GREY","source":"Dun & Bradstreet Finland Oy"},"failure_score":{"interpretation":"GREY","failure_class":null,"score":null,"source":"Dun & Bradstreet Finland Oy"},"debt_collection":{"interpretation":"GREY","classification":0,"source":"Intrum Oy"}},"other":{"remarks":{"interpretation":"YELLOW","remarks":[{"code":"FHI","date":"2018-01-16T00:00:00Z","amount":0.0,"creditor_name":"","source":"Oikeusrekisterikeskus","paid_date":null,"expires_date":null,"valid_to_date":null},{"code":"ATR","date":"2018-01-11T00:00:00Z","amount":3177.0,"creditor_name":"Keskinäinen Työeläkevaku","source":"","paid_date":null,"expires_date":"2021-01-11T00:00:00Z","valid_to_date":"2021-01-11T00:00:00Z"},{"code":"AST","date":"2018-03-14T00:00:00Z","amount":725.0,"creditor_name":"Työttömyysvakuutusrahast","source":"","paid_date":"2019-09-18T00:00:00Z","expires_date":"2021-03-14T00:00:00Z","valid_to_date":"2021-03-14T00:00:00Z"},{"code":"AST","date":"2018-02-28T00:00:00Z","amount":1535.11,"creditor_name":"Trust Kapital","source":"","paid_date":null,"expires_date":"2021-02-28T00:00:00Z","valid_to_date":"2021-02-28T00:00:00Z"},{"code":"FSA","date":"2018-03-21T00:00:00Z","amount":0.0,"creditor_name":"","source":"Oikeusrekisterikeskus","paid_date":null,"expires_date":null,"valid_to_date":null},{"code":"ATR","date":"2018-09-03T00:00:00Z","amount":391.0,"creditor_name":"Keskinäinen Työeläkevaku","source":"","paid_date":null,"expires_date":"2021-09-03T00:00:00Z","valid_to_date":"2021-09-03T00:00:00Z"},{"code":"FOV","date":"2018-09-19T00:00:00Z","amount":0.0,"creditor_name":"","source":"Oikeusrekisterikeskus","paid_date":null,"expires_date":null,"valid_to_date":null},{"code":"AST","date":"2018-07-24T00:00:00Z","amount":2480.0,"creditor_name":"Intrum Justitia Oy","source":"","paid_date":null,"expires_date":"2021-07-24T00:00:00Z","valid_to_date":"2021-07-24T00:00:00Z"},{"code":"AST","date":"2018-12-19T00:00:00Z","amount":641.0,"creditor_name":"Työttömyysvakuutusrahast","source":"","paid_date":"2019-09-18T00:00:00Z","expires_date":"2021-12-19T00:00:00Z","valid_to_date":"2021-12-19T00:00:00Z"},{"code":"KHV","date":"2019-07-04T00:00:00Z","amount":0.0,"creditor_name":"Verohallinto","source":"Oikeusrekisterikeskus","paid_date":null,"expires_date":null,"valid_to_date":null},{"code":"KKV","date":"2019-07-22T00:00:00Z","amount":0.0,"creditor_name":"","source":"Oikeusrekisterikeskus","paid_date":null,"expires_date":null,"valid_to_date":null},{"code":"AST","date":"2019-02-08T00:00:00Z","amount":355.26,"creditor_name":"Lindorff Oy","source":"","paid_date":null,"expires_date":"2022-02-08T00:00:00Z","valid_to_date":"2022-02-08T00:00:00Z"},{"code":"AST","date":"2020-01-24T00:00:00Z","amount":1485.49,"creditor_name":"Lindorff Oy","source":"","paid_date":null,"expires_date":"2023-01-24T00:00:00Z","valid_to_date":"2023-01-24T00:00:00Z"},{"code":"AST","date":"2019-03-27T00:00:00Z","amount":721.39,"creditor_name":"Lindorff Oy","source":"","paid_date":null,"expires_date":"2022-03-27T00:00:00Z","valid_to_date":"2022-03-27T00:00:00Z"},{"code":"ATR","date":"2019-07-12T00:00:00Z","amount":728.0,"creditor_name":"Keskinäinen Työeläkevaku","source":"","paid_date":null,"expires_date":"2022-07-12T00:00:00Z","valid_to_date":"2022-07-12T00:00:00Z"},{"code":"UMV","date":"2020-05-18T00:00:00Z","amount":117.49,"creditor_name":"Verohallinto ","source":"Pohjois-Karjalan ulosottovirasto","paid_date":null,"expires_date":"2023-05-18T00:00:00Z","valid_to_date":"2023-05-18T00:00:00Z"},{"code":"UMV","date":"2020-05-18T00:00:00Z","amount":1604.92,"creditor_name":"If Vahinkovakuutus Oyj, Suomen sivuliike ","source":"Pohjois-Karjalan ulosottovirasto","paid_date":null,"expires_date":"2023-05-18T00:00:00Z","valid_to_date":"2023-05-18T00:00:00Z"},{"code":"UM","date":"2019-03-29T00:00:00Z","amount":17381.9,"creditor_name":"","source":"Verohallinto","paid_date":null,"expires_date":"2022-03-29T00:00:00Z","valid_to_date":"2022-03-29T00:00:00Z"},{"code":"FR","date":"2019-07-22T00:00:00Z","amount":0.0,"creditor_name":"","source":"Oikeusrekisterikeskus","paid_date":null,"expires_date":null,"valid_to_date":null},{"code":"KR","date":"2020-03-27T00:00:00Z","amount":0.0,"creditor_name":"","source":"Oikeusrekisterikeskus","paid_date":null,"expires_date":null,"valid_to_date":null},{"code":"UMS","date":"2020-11-27T00:00:00Z","amount":134.59,"creditor_name":"Liikenne- ja viestintävirasto Traficom ","source":"","paid_date":null,"expires_date":"2023-11-27T00:00:00Z","valid_to_date":"2023-11-27T00:00:00Z"},{"code":"UMS","date":"2020-11-27T00:00:00Z","amount":388.94,"creditor_name":"Liikenne- ja viestintävirasto Traficom ","source":"","paid_date":null,"expires_date":"2023-11-27T00:00:00Z","valid_to_date":"2023-11-27T00:00:00Z"}]},"tax_debt":{"interpretation":"GREEN"},"company_sanctions":{"interpretation":"GREEN","sanctions":[]}}},"history":[{"turnover":11067,"change_of_turnover":12.2,"operating_result_pct":14.8,"net_result_pct":15.4,"equity_ratio_pct":45.2,"gearing":0.6,"quick_ratio":2.1,"current_ratio":0.7,"fiscal_period_end_date":"2020-12-31T00:00:00Z","result_before_closing_entries_and_taxes":-663,"fiscal_period_result":-63,"operating_result":-63,"source":"Dun & Bradstreet Finland Oy"},{"turnover":15421,"change_of_turnover":-5,"operating_result_pct":28.2,"net_result_pct":20.4,"equity_ratio_pct":66.4,"gearing":0.6,"quick_ratio":2.1,"current_ratio":2.5,"fiscal_period_end_date":"2021-12-31T00:00:00Z","result_before_closing_entries_and_taxes":141,"fiscal_period_result":152,"operating_result":-63,"source":"Dun & Bradstreet Finland Oy"},{"turnover":17920,"change_of_turnover":13.5,"operating_result_pct":14.8,"net_result_pct":18.4,"equity_ratio_pct":53.4,"gearing":0.6,"quick_ratio":2.1,"current_ratio":2.1,"fiscal_period_end_date":"2022-12-31T00:00:00Z","result_before_closing_entries_and_taxes":257,"fiscal_period_result":135,"operating_result":-63,"source":"Dun & Bradstreet Finland Oy"}]}}}}}},"403":{"description":"403 Forbidden","content":{"application/json":{"examples":{"ApiConsumerClosed":{"value":{"detail":"API consumer 00000000-0000-0000-0000-000000000000 is closed and cannot be modified"}},"ErrorDeterminingCustomership":{"value":{"detail":"Error determining customer-identifier customership."}},"NoActiveCustomership":{"value":{"detail":"No active customership for customer-identifier. Customer should contact Vastuu Group support."}},"CustomerIdentifierInvalid":{"value":{"detail":"customer-identifier is invalid or doesn't exist"}},"CustomerIdentifierNotActive":{"value":{"detail":"customer-identifier is not active"}},"ApiConsumerNotRegistered":{"value":{"detail":"API consumer is not registered"}},"LimitedRoleException":{"value":{"detail":"You are not allowed to access requested data for the provided customer-identifier."}},"LimitedCountriesException":{"value":{"detail":"You are not allowed to access the requested data for the provided customer-identifier due to country restrictions."}},"NoActiveValvojaLicense":{"value":{"detail":"No active license.","error":"license_missing","product_plan_id":"","product_family_id":"Valvoja","product_name":"Valvoja"}}},"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"404":{"description":"Not Found","content":{"application/json":{"examples":{"ApiConsumerNotFound":{"value":{"detail":"API consumer not found."}},"CustomerNotFound":{"value":{"detail":"Customer identifier 00000000-0000-0000-0000-000000000000 not found."}}},"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"413":{"description":"Request Entity Too Large","content":{"application/json":{"examples":{"RequestTooLarge":{"value":{"detail":"Request exceeds the maximum allowed size."}}},"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"examples":{"RateLimitExceeded":{"value":{"detail":"Too many requests"}}},"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"500":{"description":"Internal Server Error","content":{"text/plain":{"schema":{"type":"string"},"examples":{"Example#1":{"value":"Unexpected error"}}}}}},"x-billable":true,"description":"Fetch RP finance information for a single company with an active RP report version. Use after `/finance_changed`.\n\n**Required scope**: `luotettavakumppani/rp_full`\n"}},"/luotettavakumppani/v1.1/remark_codes":{"get":{"tags":["Luotettava Kumppani API v1.1"],"summary":"Fetch finance remark codes and descriptions (RP)","operationId":"luotettavakumppani_remark_codes_luotettavakumppani_v1_1_remark_codes_get","security":[{"HTTPBearer":["luotettavakumppani/rp_full"]}],"parameters":[{"name":"customer-identifier","in":"header","required":false,"schema":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"description":"Optional customer identifier, if applicable","title":"Customer-Identifier"},"description":"Optional customer identifier, if applicable"}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Code"}},"examples":{"Example#1":{"value":[{"code_value":"AST","code_description":"Trattaprotesti","code_description_english":"Protest of a bill","code_description_swedish":"Trattaprotest"},{"code_value":"ATR","code_description":"Trattaprotesti","code_description_english":"Protest of a bill","code_description_swedish":"Trattaprotest"},{"code_value":"FHH","code_description":"Saneeraushakemus hylätty","code_description_english":"Restructuring petition rejected","code_description_swedish":"Saneringsansökan avslagen"}]}}}}},"403":{"description":"Forbidden","content":{"application/json":{"examples":{"ApiConsumerClosed":{"value":{"detail":"API consumer 00000000-0000-0000-0000-000000000000 is closed and cannot be modified"}},"ErrorDeterminingCustomership":{"value":{"detail":"Error determining customer-identifier customership."}},"NoActiveCustomership":{"value":{"detail":"No active customership for customer-identifier. Customer should contact Vastuu Group support."}},"CustomerIdentifierInvalid":{"value":{"detail":"customer-identifier is invalid or doesn't exist"}},"CustomerIdentifierNotActive":{"value":{"detail":"customer-identifier is not active"}},"ApiConsumerNotRegistered":{"value":{"detail":"API consumer is not registered"}},"LimitedRoleException":{"value":{"detail":"You are not allowed to access requested data for the provided customer-identifier."}},"LimitedCountriesException":{"value":{"detail":"You are not allowed to access the requested data for the provided customer-identifier due to country restrictions."}}},"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"404":{"description":"Not Found","content":{"application/json":{"examples":{"ApiConsumerNotFound":{"value":{"detail":"API consumer not found."}},"CustomerNotFound":{"value":{"detail":"Customer identifier 00000000-0000-0000-0000-000000000000 not found."}}},"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"413":{"description":"Request Entity Too Large","content":{"application/json":{"examples":{"RequestTooLarge":{"value":{"detail":"Request exceeds the maximum allowed size."}}},"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"examples":{"RateLimitExceeded":{"value":{"detail":"Too many requests"}}},"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"500":{"description":"Internal Server Error","content":{"text/plain":{"schema":{"type":"string"},"examples":{"Example#1":{"value":"Unexpected error"}}}}}},"description":"Fetch remark code descriptions. This reference data changes rarely and can be cached.\n\n**Required scope**: `luotettavakumppani/rp_full`\n"}},"/luotettavakumppani/v1.1/key_persons_changed":{"post":{"tags":["Luotettava Kumppani API v1.1"],"summary":"Fetch key person changes (RP)","operationId":"luotettavakumppani_key_persons_changed_luotettavakumppani_v1_1_key_persons_changed_post","security":[{"HTTPBearer":["luotettavakumppani/rp_full"]}],"parameters":[{"name":"changed_after","in":"query","required":true,"schema":{"type":"string","description":"string <date-time>","examples":["2024-09-01T00:00:00.000Z"],"title":"Changed After"},"description":"string <date-time>"},{"name":"customer-identifier","in":"header","required":true,"schema":{"type":"string","format":"uuid","description":"Customer identifier required on every request","title":"Customer-Identifier"},"description":"Customer identifier required on every request"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"string"},"description":"List of business id's that are included in the query","examples":[["2327327-1","2327327-2"]],"title":"Business Ids List"}}}},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"array","items":{"type":"string"}},"examples":{"Example#1":{"value":["2327327-1"]}}}}},"403":{"description":"403 Forbidden","content":{"application/json":{"examples":{"ApiConsumerClosed":{"value":{"detail":"API consumer 00000000-0000-0000-0000-000000000000 is closed and cannot be modified"}},"ErrorDeterminingCustomership":{"value":{"detail":"Error determining customer-identifier customership."}},"NoActiveCustomership":{"value":{"detail":"No active customership for customer-identifier. Customer should contact Vastuu Group support."}},"CustomerIdentifierInvalid":{"value":{"detail":"customer-identifier is invalid or doesn't exist"}},"CustomerIdentifierNotActive":{"value":{"detail":"customer-identifier is not active"}},"ApiConsumerNotRegistered":{"value":{"detail":"API consumer is not registered"}},"LimitedRoleException":{"value":{"detail":"You are not allowed to access requested data for the provided customer-identifier."}},"LimitedCountriesException":{"value":{"detail":"You are not allowed to access the requested data for the provided customer-identifier due to country restrictions."}},"NoActiveValvojaLicense":{"value":{"detail":"No active license.","error":"license_missing","product_plan_id":"","product_family_id":"Valvoja","product_name":"Valvoja"}}},"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"404":{"description":"Not Found","content":{"application/json":{"examples":{"ApiConsumerNotFound":{"value":{"detail":"API consumer not found."}},"CustomerNotFound":{"value":{"detail":"Customer identifier 00000000-0000-0000-0000-000000000000 not found."}}},"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"413":{"description":"Request Entity Too Large","content":{"application/json":{"examples":{"RequestTooLarge":{"value":{"detail":"Request exceeds the maximum allowed size."}}},"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"examples":{"RateLimitExceeded":{"value":{"detail":"Too many requests"}}},"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request – invalid or malformed parameters.\nThis error occurs, for example, if the `changed_after` query parameter is not a valid date-time.\n","content":{"application/json":{"schema":{"type":"object"},"examples":{"Example#1":{"value":{"status":-3,"result":null,"reason":"Bad request: Can't transform call to resource"}}}}}},"500":{"description":"Internal Server Error","content":{"text/plain":{"schema":{"type":"string"},"examples":{"Example#1":{"value":"Unexpected error"}}}}}},"x-billable":true,"description":"Return business IDs of companies with an active RP report version whose key person data has changed after `changed_after`. Fetch the actual data using `/key_persons`.\n\n**Required scope**: `luotettavakumppani/rp_full`\n"}},"/luotettavakumppani/v1.1/key_persons":{"get":{"tags":["Luotettava Kumppani API v1.1"],"summary":"Fetch key person information (RP)","operationId":"luotettavakumppani_key_persons_luotettavakumppani_v1_1_key_persons_get","security":[{"HTTPBearer":["luotettavakumppani/rp_full"]}],"parameters":[{"name":"business_id","in":"query","required":true,"schema":{"type":"string","description":"The business id of the organization to get","examples":["2327327-1"],"title":"Business Id"},"description":"The business id of the organization to get"},{"name":"customer-identifier","in":"header","required":true,"schema":{"type":"string","format":"uuid","description":"Customer identifier required on every request","title":"Customer-Identifier"},"description":"Customer identifier required on every request"}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/KeyPersons"},"examples":{"Example#1":{"value":{"key_persons":[{"first_names":"Jean-Baptiste Michel","last_name":"Testi","role_code":"TJ","role_start_date":"2014-05-15T05:40:25.487Z","role_end_date":null,"business_prohibition":false,"partial_business_prohibition":false,"ownership_extent":null,"beneficial_owner":false,"sanctions":[],"connections":[{"business_id":"0109823-0","company_name":"-","status":"NO_STATUS","role_code":"HVJ","role_start_date":"2014-06-09T00:00:00Z","role_end_date":null,"remarks":[],"sanctions":[]}],"source":"Dun & Bradstreet Finland Oy"},{"first_names":"Henri","last_name":"Testi","role_code":"HVJ","role_start_date":"2014-05-15T05:40:25.487Z","role_end_date":null,"business_prohibition":false,"partial_business_prohibition":false,"ownership_extent":null,"beneficial_owner":false,"sanctions":[],"connections":[],"source":"Dun & Bradstreet Finland Oy"},{"first_names":"Jaakko","last_name":"Testi","role_code":"HVJ","role_start_date":"2014-05-15T05:40:25.487Z","role_end_date":null,"business_prohibition":false,"partial_business_prohibition":false,"ownership_extent":null,"beneficial_owner":false,"sanctions":[],"connections":[],"source":"Dun & Bradstreet Finland Oy"},{"first_names":"Katri","last_name":"Testi","role_code":"HVJ","role_start_date":"2014-05-15T05:40:25.487Z","role_end_date":null,"business_prohibition":false,"partial_business_prohibition":false,"ownership_extent":null,"beneficial_owner":false,"sanctions":[],"connections":[],"source":"Dun & Bradstreet Finland Oy"},{"first_names":"Maija","last_name":"Testi","role_code":"HVJ","role_start_date":"2014-05-15T05:40:25.487Z","role_end_date":null,"business_prohibition":false,"partial_business_prohibition":false,"ownership_extent":null,"beneficial_owner":false,"sanctions":[],"connections":[],"source":"Dun & Bradstreet Finland Oy"},{"first_names":"Tiina","last_name":"Testi","role_code":"HVJ","role_start_date":"2014-05-15T05:40:25.487Z","role_end_date":null,"business_prohibition":false,"partial_business_prohibition":false,"ownership_extent":null,"beneficial_owner":false,"sanctions":[],"connections":[],"source":"Dun & Bradstreet Finland Oy"},{"first_names":"Matias","last_name":"Mättönen","role_code":"HVJ","role_start_date":"2014-05-15T05:40:25.487Z","role_end_date":null,"business_prohibition":false,"partial_business_prohibition":false,"ownership_extent":null,"beneficial_owner":false,"sanctions":[],"connections":[],"source":"Dun & Bradstreet Finland Oy"},{"first_names":"Kai","last_name":"Komea","role_code":"HVJ","role_start_date":"2014-05-15T05:40:25.487Z","role_end_date":null,"business_prohibition":false,"partial_business_prohibition":false,"ownership_extent":null,"beneficial_owner":false,"sanctions":[],"connections":[],"source":"Dun & Bradstreet Finland Oy"},{"first_names":"Jaana","last_name":"Jalkanen","role_code":"HVJ","role_start_date":"2014-05-15T05:40:25.487Z","role_end_date":null,"business_prohibition":false,"partial_business_prohibition":false,"ownership_extent":null,"beneficial_owner":false,"sanctions":[],"connections":[],"source":"Dun & Bradstreet Finland Oy"},{"first_names":"Marketta","last_name":"Mehevä","role_code":"HVJ","role_start_date":"2014-05-15T05:40:25.487Z","role_end_date":null,"business_prohibition":false,"partial_business_prohibition":false,"ownership_extent":null,"beneficial_owner":false,"sanctions":[],"connections":[],"source":"Dun & Bradstreet Finland Oy"}],"beneficial_owners":[{"first_names":"Jean-Baptiste Michel","last_name":"Renard","role_code":"ES","role_start_date":"2014-05-15T05:40:25.487Z","role_end_date":null,"business_prohibition":false,"partial_business_prohibition":false,"ownership_extent":10.0,"beneficial_owner":true,"sanctions":[],"connections":[],"source":"Dun & Bradstreet Finland Oy"}],"business_prohibition_interpretation":"GREEN","person_sanction_interpretation":"GREEN"}}}}}},"403":{"description":"403 Forbidden","content":{"application/json":{"examples":{"ApiConsumerClosed":{"value":{"detail":"API consumer 00000000-0000-0000-0000-000000000000 is closed and cannot be modified"}},"ErrorDeterminingCustomership":{"value":{"detail":"Error determining customer-identifier customership."}},"NoActiveCustomership":{"value":{"detail":"No active customership for customer-identifier. Customer should contact Vastuu Group support."}},"CustomerIdentifierInvalid":{"value":{"detail":"customer-identifier is invalid or doesn't exist"}},"CustomerIdentifierNotActive":{"value":{"detail":"customer-identifier is not active"}},"ApiConsumerNotRegistered":{"value":{"detail":"API consumer is not registered"}},"LimitedRoleException":{"value":{"detail":"You are not allowed to access requested data for the provided customer-identifier."}},"LimitedCountriesException":{"value":{"detail":"You are not allowed to access the requested data for the provided customer-identifier due to country restrictions."}},"NoActiveValvojaLicense":{"value":{"detail":"No active license.","error":"license_missing","product_plan_id":"","product_family_id":"Valvoja","product_name":"Valvoja"}}},"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"404":{"description":"Not Found","content":{"application/json":{"examples":{"ApiConsumerNotFound":{"value":{"detail":"API consumer not found."}},"CustomerNotFound":{"value":{"detail":"Customer identifier 00000000-0000-0000-0000-000000000000 not found."}}},"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"413":{"description":"Request Entity Too Large","content":{"application/json":{"examples":{"RequestTooLarge":{"value":{"detail":"Request exceeds the maximum allowed size."}}},"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"examples":{"RateLimitExceeded":{"value":{"detail":"Too many requests"}}},"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"500":{"description":"Internal Server Error","content":{"text/plain":{"schema":{"type":"string"},"examples":{"Example#1":{"value":"Unexpected error"}}}}}},"x-billable":true,"description":"Fetch RP key person information for a single company with an active RP report version. Use after `/key_persons_changed`.\n\n**Required scope**: `luotettavakumppani/rp_full`\n"}},"/luotettavakumppani/v1.1/key_person_role_codes":{"get":{"tags":["Luotettava Kumppani API v1.1"],"summary":"Fetch key person role codes (RP)","operationId":"luotettavakumppani_key_person_role_codes_luotettavakumppani_v1_1_key_person_role_codes_get","security":[{"HTTPBearer":["luotettavakumppani/rp_full"]}],"parameters":[{"name":"customer-identifier","in":"header","required":false,"schema":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"description":"Optional customer identifier, if applicable","title":"Customer-Identifier"},"description":"Optional customer identifier, if applicable"}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Code"}},"examples":{"Example#1":{"value":[{"code_value":"E","code_description":"Edunvalvoja","code_description_english":"Guardian","code_description_swedish":"Intressebevakare"},{"code_value":"EDU","code_description":"Edustaja","code_description_english":"Representative","code_description_swedish":"Representant"},{"code_value":"EH","code_description":"Elinkeinonharjoittaja","code_description_english":"Trader","code_description_swedish":"Näringsidkare"},{"code_value":"ES","code_description":"Tosiasiallinen edunsaaja","code_description_english":"Actual beneficial owner","code_description_swedish":"Verklig förmånstagare"},{"code_value":"EUSL","code_description":"EU-sivuliike","code_description_english":"EU-sivuliike","code_description_swedish":"EU-sivuliike"},{"code_value":"HH","code_description":"Hallinnon hoitaja","code_description_english":"In charge of administration","code_description_swedish":"Förvaltare"},{"code_value":"HPJ","code_description":"Puheenjohtaja","code_description_english":"Chairperson","code_description_swedish":"Ordförande"},{"code_value":"HPJV","code_description":"Varapuheenjohtaja","code_description_english":"Vice-chairperson","code_description_swedish":"Vice ordförande"},{"code_value":"HVJ","code_description":"Varsinainen jäsen","code_description_english":"Ordinary member","code_description_swedish":"Ordinarie medlem"},{"code_value":"HVJV","code_description":"Varajäsen","code_description_english":"Deputy member","code_description_swedish":"Suppleant"},{"code_value":"IS","code_description":"Isännöitsijä","code_description_english":"House Manager","code_description_swedish":"Disponent"},{"code_value":"JO","code_description":"Johtaja","code_description_english":"Director","code_description_swedish":"Chef"}]}}}}},"403":{"description":"Forbidden","content":{"application/json":{"examples":{"ApiConsumerClosed":{"value":{"detail":"API consumer 00000000-0000-0000-0000-000000000000 is closed and cannot be modified"}},"ErrorDeterminingCustomership":{"value":{"detail":"Error determining customer-identifier customership."}},"NoActiveCustomership":{"value":{"detail":"No active customership for customer-identifier. Customer should contact Vastuu Group support."}},"CustomerIdentifierInvalid":{"value":{"detail":"customer-identifier is invalid or doesn't exist"}},"CustomerIdentifierNotActive":{"value":{"detail":"customer-identifier is not active"}},"ApiConsumerNotRegistered":{"value":{"detail":"API consumer is not registered"}},"LimitedRoleException":{"value":{"detail":"You are not allowed to access requested data for the provided customer-identifier."}},"LimitedCountriesException":{"value":{"detail":"You are not allowed to access the requested data for the provided customer-identifier due to country restrictions."}}},"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"404":{"description":"Not Found","content":{"application/json":{"examples":{"ApiConsumerNotFound":{"value":{"detail":"API consumer not found."}},"CustomerNotFound":{"value":{"detail":"Customer identifier 00000000-0000-0000-0000-000000000000 not found."}}},"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"413":{"description":"Request Entity Too Large","content":{"application/json":{"examples":{"RequestTooLarge":{"value":{"detail":"Request exceeds the maximum allowed size."}}},"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"examples":{"RateLimitExceeded":{"value":{"detail":"Too many requests"}}},"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"500":{"description":"Internal Server Error","content":{"text/plain":{"schema":{"type":"string"},"examples":{"Example#1":{"value":"Unexpected error"}}}}}},"description":"Fetch key person role code descriptions. This reference data changes rarely and can be cached.\n\n**Required scope**: `luotettavakumppani/rp_full`\n"}},"/luotettavakumppani/v1.1/responsibility_changed":{"post":{"tags":["Luotettava Kumppani API v1.1"],"summary":"Fetch responsibility changes (RP)","operationId":"luotettavakumppani_responsibility_changed_luotettavakumppani_v1_1_responsibility_changed_post","security":[{"HTTPBearer":["luotettavakumppani/rp_full"]}],"parameters":[{"name":"changed_after","in":"query","required":true,"schema":{"type":"string","description":"string <date-time>","examples":["2024-09-01T00:00:00.000Z"],"title":"Changed After"},"description":"string <date-time>"},{"name":"customer-identifier","in":"header","required":true,"schema":{"type":"string","format":"uuid","description":"Customer identifier required on every request","title":"Customer-Identifier"},"description":"Customer identifier required on every request"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"string"},"description":"List of business id's that are included in the query","examples":[["2327327-1","2327327-2"]],"title":"Business Ids List"}}}},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"array","items":{"type":"string"}},"examples":{"Example#1":{"value":["2327327-1"]}}}}},"403":{"description":"403 Forbidden","content":{"application/json":{"examples":{"ApiConsumerClosed":{"value":{"detail":"API consumer 00000000-0000-0000-0000-000000000000 is closed and cannot be modified"}},"ErrorDeterminingCustomership":{"value":{"detail":"Error determining customer-identifier customership."}},"NoActiveCustomership":{"value":{"detail":"No active customership for customer-identifier. Customer should contact Vastuu Group support."}},"CustomerIdentifierInvalid":{"value":{"detail":"customer-identifier is invalid or doesn't exist"}},"CustomerIdentifierNotActive":{"value":{"detail":"customer-identifier is not active"}},"ApiConsumerNotRegistered":{"value":{"detail":"API consumer is not registered"}},"LimitedRoleException":{"value":{"detail":"You are not allowed to access requested data for the provided customer-identifier."}},"LimitedCountriesException":{"value":{"detail":"You are not allowed to access the requested data for the provided customer-identifier due to country restrictions."}},"NoActiveValvojaLicense":{"value":{"detail":"No active license.","error":"license_missing","product_plan_id":"","product_family_id":"Valvoja","product_name":"Valvoja"}}},"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"404":{"description":"Not Found","content":{"application/json":{"examples":{"ApiConsumerNotFound":{"value":{"detail":"API consumer not found."}},"CustomerNotFound":{"value":{"detail":"Customer identifier 00000000-0000-0000-0000-000000000000 not found."}}},"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"413":{"description":"Request Entity Too Large","content":{"application/json":{"examples":{"RequestTooLarge":{"value":{"detail":"Request exceeds the maximum allowed size."}}},"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"examples":{"RateLimitExceeded":{"value":{"detail":"Too many requests"}}},"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"500":{"description":"Internal Server Error","content":{"text/plain":{"schema":{"type":"string"},"examples":{"Example#1":{"value":"Unexpected error"}}}}},"400":{"description":"Bad Request – invalid or malformed parameters.\nThis error occurs, for example, if the `changed_after` query parameter is not a valid date-time.\n","content":{"application/json":{"schema":{"type":"object"},"examples":{"Example#1":{"value":{"status":-3,"result":null,"reason":"Bad request: Can't transform call to resource"}}}}}}},"x-billable":true,"description":"Return business IDs of companies with an active RP report version whose responsibility data has changed after `changed_after`. Fetch the actual data using `/responsibility`.\n\n**Required scope**: `luotettavakumppani/rp_full`\n"}},"/luotettavakumppani/v1.1/responsibility":{"get":{"tags":["Luotettava Kumppani API v1.1"],"summary":"Fetch responsibility information (RP)","operationId":"luotettavakumppani_responsibility_luotettavakumppani_v1_1_responsibility_get","security":[{"HTTPBearer":["luotettavakumppani/rp_full"]}],"parameters":[{"name":"business_id","in":"query","required":true,"schema":{"type":"string","description":"The business id of the organization to get","examples":["2327327-1"],"title":"Business Id"},"description":"The business id of the organization to get"},{"name":"customer-identifier","in":"header","required":true,"schema":{"type":"string","format":"uuid","description":"Customer identifier required on every request","title":"Customer-Identifier"},"description":"Customer identifier required on every request"}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Responsibility"},"examples":{"Example#1":{"value":{"esg":{"strategy":"YES","subcontractor_check":"YES","updated_at":"2024-08-23T07:50:22.061787Z"},"environment":{"co2_reduction_goal":"YES_GOALS_PUBLISHED","co2_reporting":"YES_REPORT_READY","certificates":["ISO_14001"],"updated_at":"2024-08-23T07:50:22.061787Z"},"occupational_safety":{"implemented":["YES_ISO_54001"],"certificates":["YES_ISO_45001"],"updated_at":"2024-08-23T07:50:22.061787Z"},"other_responsibility_matters":{"subcontractor_sanction_check":true,"subcontractor_procurement_check":false,"updated_at":"2024-08-23T07:50:22.061787Z"}}}}}}},"403":{"description":"403 Forbidden","content":{"application/json":{"examples":{"ApiConsumerClosed":{"value":{"detail":"API consumer 00000000-0000-0000-0000-000000000000 is closed and cannot be modified"}},"ErrorDeterminingCustomership":{"value":{"detail":"Error determining customer-identifier customership."}},"NoActiveCustomership":{"value":{"detail":"No active customership for customer-identifier. Customer should contact Vastuu Group support."}},"CustomerIdentifierInvalid":{"value":{"detail":"customer-identifier is invalid or doesn't exist"}},"CustomerIdentifierNotActive":{"value":{"detail":"customer-identifier is not active"}},"ApiConsumerNotRegistered":{"value":{"detail":"API consumer is not registered"}},"LimitedRoleException":{"value":{"detail":"You are not allowed to access requested data for the provided customer-identifier."}},"LimitedCountriesException":{"value":{"detail":"You are not allowed to access the requested data for the provided customer-identifier due to country restrictions."}},"NoActiveValvojaLicense":{"value":{"detail":"No active license.","error":"license_missing","product_plan_id":"","product_family_id":"Valvoja","product_name":"Valvoja"}}},"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"404":{"description":"Not Found","content":{"application/json":{"examples":{"ApiConsumerNotFound":{"value":{"detail":"API consumer not found."}},"CustomerNotFound":{"value":{"detail":"Customer identifier 00000000-0000-0000-0000-000000000000 not found."}}},"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"413":{"description":"Request Entity Too Large","content":{"application/json":{"examples":{"RequestTooLarge":{"value":{"detail":"Request exceeds the maximum allowed size."}}},"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"examples":{"RateLimitExceeded":{"value":{"detail":"Too many requests"}}},"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"500":{"description":"Internal Server Error","content":{"text/plain":{"schema":{"type":"string"},"examples":{"Example#1":{"value":"Unexpected error"}}}}}},"x-billable":true,"description":"Fetch RP responsibility information for a single company with an active RP report version. Use after `/responsibility_changed`.\n\n**Required scope**: `luotettavakumppani/rp_full`\n"}},"/luotettavakumppani/v1.1/rala_companies":{"post":{"tags":["Luotettava Kumppani API v1.1"],"summary":"Fetch Rala companies (RP)","operationId":"luotettavakumppani_rala_companies_luotettavakumppani_v1_1_rala_companies_post","security":[{"HTTPBearer":["luotettavakumppani/rp_full"]}],"parameters":[{"name":"customer-identifier","in":"header","required":true,"schema":{"type":"string","format":"uuid","description":"Customer identifier required on every request","title":"Customer-Identifier"},"description":"Customer identifier required on every request"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"string"},"description":"List of business id's that are included in the query","examples":[["2327327-1","2327327-2"]],"title":"Business Ids List"}}}},"responses":{"200":{"description":"","content":{"*/*":{"schema":{"type":"array","items":{"type":"string"}},"examples":{"Example#1":{"value":["2327327-1","2327327-2"]}}}}},"403":{"description":"403 Forbidden","content":{"application/json":{"examples":{"ApiConsumerClosed":{"value":{"detail":"API consumer 00000000-0000-0000-0000-000000000000 is closed and cannot be modified"}},"ErrorDeterminingCustomership":{"value":{"detail":"Error determining customer-identifier customership."}},"NoActiveCustomership":{"value":{"detail":"No active customership for customer-identifier. Customer should contact Vastuu Group support."}},"CustomerIdentifierInvalid":{"value":{"detail":"customer-identifier is invalid or doesn't exist"}},"CustomerIdentifierNotActive":{"value":{"detail":"customer-identifier is not active"}},"ApiConsumerNotRegistered":{"value":{"detail":"API consumer is not registered"}},"LimitedRoleException":{"value":{"detail":"You are not allowed to access requested data for the provided customer-identifier."}},"LimitedCountriesException":{"value":{"detail":"You are not allowed to access the requested data for the provided customer-identifier due to country restrictions."}},"NoActiveValvojaLicense":{"value":{"detail":"No active license.","error":"license_missing","product_plan_id":"","product_family_id":"Valvoja","product_name":"Valvoja"}}},"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"404":{"description":"Not Found","content":{"application/json":{"examples":{"ApiConsumerNotFound":{"value":{"detail":"API consumer not found."}},"CustomerNotFound":{"value":{"detail":"Customer identifier 00000000-0000-0000-0000-000000000000 not found."}}},"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"413":{"description":"Request Entity Too Large","content":{"application/json":{"examples":{"RequestTooLarge":{"value":{"detail":"Request exceeds the maximum allowed size."}}},"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"examples":{"RateLimitExceeded":{"value":{"detail":"Too many requests"}}},"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"401":{"description":"Unauthorized","content":{"*/*":{"schema":{"type":"object"}}}}},"x-billable":true,"description":"List companies with RALA competence and/or certification. Use this before `/rala_certificates`.\n\n**Required scope**: `luotettavakumppani/rp_full`\n"}},"/luotettavakumppani/v1.1/rala_certificates":{"get":{"tags":["Luotettava Kumppani API v1.1"],"summary":"Fetch RALA certificates (RP)","operationId":"luotettavakumppani_rala_certificates_luotettavakumppani_v1_1_rala_certificates_get","security":[{"HTTPBearer":["luotettavakumppani/rp_full"]}],"parameters":[{"name":"business_id","in":"query","required":true,"schema":{"type":"string","description":"The business id of the organization to get","examples":["2327327-1"],"title":"Business Id"},"description":"The business id of the organization to get"},{"name":"lang","in":"query","required":true,"schema":{"$ref":"#/components/schemas/CertificateLangEnum","description":"Language of the certificate name. If not given, name in Finnish is returned"},"description":"Language of the certificate name. If not given, name in Finnish is returned"},{"name":"customer-identifier","in":"header","required":true,"schema":{"type":"string","format":"uuid","description":"Customer identifier required on every request","title":"Customer-Identifier"},"description":"Customer identifier required on every request"}],"responses":{"200":{"description":"","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/RalaCertificate"}},"examples":{"Example#1":{"value":[{"business_id":"2311110-9","valid_to":"2025-12-31","certificate_type_id":2,"name":"RALA-laatusertifikaatti"},{"business_id":"2311110-9","valid_to":"2025-10-31","certificate_type_id":3,"name":"RALA-pätevyys"}]}}}}},"403":{"description":"403 Forbidden","content":{"application/json":{"examples":{"ApiConsumerClosed":{"value":{"detail":"API consumer 00000000-0000-0000-0000-000000000000 is closed and cannot be modified"}},"ErrorDeterminingCustomership":{"value":{"detail":"Error determining customer-identifier customership."}},"NoActiveCustomership":{"value":{"detail":"No active customership for customer-identifier. Customer should contact Vastuu Group support."}},"CustomerIdentifierInvalid":{"value":{"detail":"customer-identifier is invalid or doesn't exist"}},"CustomerIdentifierNotActive":{"value":{"detail":"customer-identifier is not active"}},"ApiConsumerNotRegistered":{"value":{"detail":"API consumer is not registered"}},"LimitedRoleException":{"value":{"detail":"You are not allowed to access requested data for the provided customer-identifier."}},"LimitedCountriesException":{"value":{"detail":"You are not allowed to access the requested data for the provided customer-identifier due to country restrictions."}},"NoActiveValvojaLicense":{"value":{"detail":"No active license.","error":"license_missing","product_plan_id":"","product_family_id":"Valvoja","product_name":"Valvoja"}}},"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"404":{"description":"Not Found","content":{"application/json":{"examples":{"ApiConsumerNotFound":{"value":{"detail":"API consumer not found."}},"CustomerNotFound":{"value":{"detail":"Customer identifier 00000000-0000-0000-0000-000000000000 not found."}}},"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"413":{"description":"Request Entity Too Large","content":{"application/json":{"examples":{"RequestTooLarge":{"value":{"detail":"Request exceeds the maximum allowed size."}}},"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"examples":{"RateLimitExceeded":{"value":{"detail":"Too many requests"}}},"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"401":{"description":"Unauthorized","content":{"*/*":{"schema":{"type":"object"}}}}},"x-billable":true,"description":"Fetch RALA certificates for a single company returned by `/rala_companies`.\n\n**Required scope**: `luotettavakumppani/rp_full`\n"}},"/luotettavakumppani/v1.1/rala_certificate_types":{"get":{"tags":["Luotettava Kumppani API v1.1"],"summary":"Fetch RALA certificate types (RP)","operationId":"luotettavakumppani_rala_certificate_types_luotettavakumppani_v1_1_rala_certificate_types_get","security":[{"HTTPBearer":["luotettavakumppani/rp_full"]}],"parameters":[{"name":"customer-identifier","in":"header","required":false,"schema":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"description":"Optional customer identifier, if applicable","title":"Customer-Identifier"},"description":"Optional customer identifier, if applicable"}],"responses":{"200":{"description":"","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/RalaCertificateType"}},"examples":{"Example#1":{"value":[{"id":2,"fi":{"name":"RALA-laatusertifikaatti","logo":"https://asiointi-api.rala.fi/img/icon-rala-laatu_fi.svg"},"se":{"name":"RALA-kvalitetscertifikatet","logo":"https://asiointi-api.rala.fi/img/icon-rala-laatu_se.png"},"en":{"name":"RALA Quality Certificate","logo":"https://asiointi-api.rala.fi/img/icon-rala-laatu_en.png"}},{"id":3,"fi":{"name":"RALA-pätevyys","logo":"https://asiointi-api.rala.fi/img/icon-rala-patevyys_fi.svg"},"se":{"name":"RALA-behörighet","logo":"https://asiointi-api.rala.fi/img/icon-rala-patevyys_se.png"},"en":{"name":"RALA-competence","logo":"https://asiointi-api.rala.fi/img/icon-rala-patevyys_en.png"}},{"id":5,"fi":{"name":"RALA-ympäristösertifikaatti","logo":"https://asiointi-api.rala.fi/img/icon-rala-ymparisto_fi.svg"},"se":{"name":"RALA-miljöcertifikatet","logo":"https://asiointi-api.rala.fi/img/icon-rala-ymparisto_se.png"},"en":{"name":"RALA Environmental Certificate","logo":"https://asiointi-api.rala.fi/img/icon-rala-ymparisto_en.png"}},{"id":20,"fi":{"name":"RALA-turvallisuussertifikaatti","logo":"https://asiointi-api.rala.fi/img/icon-rala-turvallisuus_fi.svg"},"se":{"name":"RALA-arbetsmiljöcertifikatet","logo":"https://asiointi-api.rala.fi/img/icon-rala-turvallisuus_se.png"},"en":{"name":"RALA Health and Safety Certificate","logo":"https://asiointi-api.rala.fi/img/icon-rala-turvallisuus_en.png"}},{"id":23,"fi":{"name":"RALA-kosteudenhallintasertifikaatti","logo":"https://asiointi-api.rala.fi/img/icon-rala-kosteudenhallinta_fi.svg"},"se":{"name":"RALA-fuktsäkerhetscertifikatet","logo":"https://asiointi-api.rala.fi/img/icon-rala-kosteudenhallinta_se.svg"},"en":{"name":"RALA Moisture Control Certificate","logo":"https://asiointi-api.rala.fi/img/icon-rala-kosteudenhallinta_en.svg"}}]}}}}},"403":{"description":"403 Forbidden","content":{"application/json":{"examples":{"ApiConsumerClosed":{"value":{"detail":"API consumer 00000000-0000-0000-0000-000000000000 is closed and cannot be modified"}},"ErrorDeterminingCustomership":{"value":{"detail":"Error determining customer-identifier customership."}},"NoActiveCustomership":{"value":{"detail":"No active customership for customer-identifier. Customer should contact Vastuu Group support."}},"CustomerIdentifierInvalid":{"value":{"detail":"customer-identifier is invalid or doesn't exist"}},"CustomerIdentifierNotActive":{"value":{"detail":"customer-identifier is not active"}},"ApiConsumerNotRegistered":{"value":{"detail":"API consumer is not registered"}},"LimitedRoleException":{"value":{"detail":"You are not allowed to access requested data for the provided customer-identifier."}},"LimitedCountriesException":{"value":{"detail":"You are not allowed to access the requested data for the provided customer-identifier due to country restrictions."}},"NoActiveValvojaLicense":{"value":{"detail":"No active license.","error":"license_missing","product_plan_id":"","product_family_id":"Valvoja","product_name":"Valvoja"}}},"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"404":{"description":"Not Found","content":{"application/json":{"examples":{"ApiConsumerNotFound":{"value":{"detail":"API consumer not found."}},"CustomerNotFound":{"value":{"detail":"Customer identifier 00000000-0000-0000-0000-000000000000 not found."}}},"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"413":{"description":"Request Entity Too Large","content":{"application/json":{"examples":{"RequestTooLarge":{"value":{"detail":"Request exceeds the maximum allowed size."}}},"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"examples":{"RateLimitExceeded":{"value":{"detail":"Too many requests"}}},"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"401":{"description":"Unauthorized","content":{"*/*":{"schema":{"type":"object"}}}}},"description":"Fetch RALA certificate type descriptions. This reference data changes rarely and can be cached.\n\n**Required scope**: `luotettavakumppani/rp_full`\n"}},"/luotettavakumppani/v1.1/cl_report_pdf":{"get":{"tags":["Luotettava Kumppani API v1.1"],"summary":"Fetch contractor's liability PDF report (CL)","operationId":"luotettavakumppani_cl_report_pdf_luotettavakumppani_v1_1_cl_report_pdf_get","security":[{"HTTPBearer":["luotettavakumppani/cl_pdf"]}],"parameters":[{"name":"business_id","in":"query","required":true,"schema":{"type":"string","description":"The business id of the organization to get","examples":["2327327-1"],"title":"Business Id"},"description":"The business id of the organization to get"},{"name":"country","in":"query","required":true,"schema":{"$ref":"#/components/schemas/routers__luotettavakumppani_1_1__CountryEnum","description":"The country of the organization to get"},"description":"The country of the organization to get"},{"name":"customer-identifier","in":"header","required":true,"schema":{"type":"string","format":"uuid","description":"Customer identifier required on every request","title":"Customer-Identifier"},"description":"Customer identifier required on every request"}],"responses":{"200":{"description":"OK","content":{"application/pdf":{"schema":{"type":"string","format":"byte"},"example":"Binary file"}}},"403":{"description":"403 Forbidden","content":{"application/json":{"examples":{"ApiConsumerClosed":{"value":{"detail":"API consumer 00000000-0000-0000-0000-000000000000 is closed and cannot be modified"}},"ErrorDeterminingCustomership":{"value":{"detail":"Error determining customer-identifier customership."}},"NoActiveCustomership":{"value":{"detail":"No active customership for customer-identifier. Customer should contact Vastuu Group support."}},"CustomerIdentifierInvalid":{"value":{"detail":"customer-identifier is invalid or doesn't exist"}},"CustomerIdentifierNotActive":{"value":{"detail":"customer-identifier is not active"}},"ApiConsumerNotRegistered":{"value":{"detail":"API consumer is not registered"}},"LimitedRoleException":{"value":{"detail":"You are not allowed to access requested data for the provided customer-identifier."}},"LimitedCountriesException":{"value":{"detail":"You are not allowed to access the requested data for the provided customer-identifier due to country restrictions."}},"NoActiveValvojaLicense":{"value":{"detail":"No active license.","error":"license_missing","product_plan_id":"","product_family_id":"Valvoja","product_name":"Valvoja"}}},"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"404":{"description":"Not Found","content":{"application/json":{"examples":{"ApiConsumerNotFound":{"value":{"detail":"API consumer not found."}},"CustomerNotFound":{"value":{"detail":"Customer identifier 00000000-0000-0000-0000-000000000000 not found."}}},"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"413":{"description":"Request Entity Too Large","content":{"application/json":{"examples":{"RequestTooLarge":{"value":{"detail":"Request exceeds the maximum allowed size."}}},"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"examples":{"RateLimitExceeded":{"value":{"detail":"Too many requests"}}},"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"x-billable":true,"description":"Fetch the latest available RP CL report as a PDF for a single company with an active RP CL or RP report version.\n \n **Required scope**: `luotettavakumppani/cl_pdf`\n"}},"/luotettavakumppani/v1.1/rp_report_html":{"get":{"tags":["Luotettava Kumppani API v1.1"],"summary":"Fetch Reliable Partner HTML report (RP)","operationId":"luotettavakumppani_rp_report_html_luotettavakumppani_v1_1_rp_report_html_get","security":[{"HTTPBearer":["luotettavakumppani/rp_full"]}],"parameters":[{"name":"business_id","in":"query","required":true,"schema":{"type":"string","description":"The business id of the organization to get","examples":["2327327-1"],"title":"Business Id"},"description":"The business id of the organization to get"},{"name":"customer-identifier","in":"header","required":true,"schema":{"type":"string","format":"uuid","description":"Customer identifier required on every request","title":"Customer-Identifier"},"description":"Customer identifier required on every request"}],"responses":{"200":{"description":"OK","content":{"text/html":{"schema":{"type":"string"},"example":"Binary file"}}},"403":{"description":"403 Forbidden","content":{"application/json":{"examples":{"ApiConsumerClosed":{"value":{"detail":"API consumer 00000000-0000-0000-0000-000000000000 is closed and cannot be modified"}},"ErrorDeterminingCustomership":{"value":{"detail":"Error determining customer-identifier customership."}},"NoActiveCustomership":{"value":{"detail":"No active customership for customer-identifier. Customer should contact Vastuu Group support."}},"CustomerIdentifierInvalid":{"value":{"detail":"customer-identifier is invalid or doesn't exist"}},"CustomerIdentifierNotActive":{"value":{"detail":"customer-identifier is not active"}},"ApiConsumerNotRegistered":{"value":{"detail":"API consumer is not registered"}},"LimitedRoleException":{"value":{"detail":"You are not allowed to access requested data for the provided customer-identifier."}},"LimitedCountriesException":{"value":{"detail":"You are not allowed to access the requested data for the provided customer-identifier due to country restrictions."}},"NoActiveValvojaLicense":{"value":{"detail":"No active license.","error":"license_missing","product_plan_id":"","product_family_id":"Valvoja","product_name":"Valvoja"}}},"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"404":{"description":"Not Found","content":{"application/json":{"examples":{"ApiConsumerNotFound":{"value":{"detail":"API consumer not found."}},"CustomerNotFound":{"value":{"detail":"Customer identifier 00000000-0000-0000-0000-000000000000 not found."}}},"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"413":{"description":"Request Entity Too Large","content":{"application/json":{"examples":{"RequestTooLarge":{"value":{"detail":"Request exceeds the maximum allowed size."}}},"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"examples":{"RateLimitExceeded":{"value":{"detail":"Too many requests"}}},"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"401":{"description":"Unauthorized","content":{"*/*":{"schema":{"type":"object"}}}}},"x-billable":true,"description":"Fetch the latest available RP report as HTML for a single company with an active RP report version.\n\n**Required scope**: `luotettavakumppani/rp_full`\n"}},"/personapi/v1.2/authority_report":{"get":{"tags":["Person API v1.2"],"summary":"Get tax authority employee report data for a person/employee","operationId":"personapi_authority_report_personapi_v1_2_authority_report_get","security":[{"HTTPBearer":["personapi/authority_report_get"]}],"parameters":[{"name":"id-type","in":"header","required":true,"schema":{"$ref":"#/components/schemas/routers__personapi_1_2__IdTypeEnum","description":"Type of the search key used"},"description":"Type of the search key used"},{"name":"id-value","in":"header","required":true,"schema":{"type":"string","pattern":"^[ -~]+$","description":"Value of the search key used for identifying person","title":"Id-Value"},"description":"Value of the search key used for identifying person"},{"name":"id-country","in":"header","required":false,"schema":{"$ref":"#/components/schemas/routers__personapi_1_2__CountryEnum","description":"Country code of the search key used to specify whether it's a Finnish or Swedish tax number / social security number. Not required when id-type is card_uid or card_barcode"},"description":"Country code of the search key used to specify whether it's a Finnish or Swedish tax number / social security number. Not required when id-type is card_uid or card_barcode"},{"name":"customer-identifier","in":"header","required":true,"schema":{"type":"string","format":"uuid","description":"Customer identifier required on every request","title":"Customer-Identifier"},"description":"Customer identifier required on every request"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"properties":{"names":{"items":{"$ref":"#/components/schemas/Names"},"type":"array","title":"Names","description":"List of person's names"},"date_of_birth":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Date Of Birth","description":"Date of birth","examples":["1980-01-20"]},"nationalities":{"anyOf":[{"items":{"type":"string","pattern":"^[A-Z]{2}$","description":"Country code","examples":["FI","SE"]},"type":"array"},{"type":"null"}],"title":"Nationalities","description":"Person's nationalities in ISO-3166 alpha-2 format country code as an array"},"gov_ids":{"items":{"$ref":"#/components/schemas/GovernmentID"},"type":"array","title":"Gov Ids","description":"List of person's government issued identifiers"},"employers":{"anyOf":[{"items":{"$ref":"#/components/schemas/app__personapi__model__employer__Employer"},"type":"array"},{"items":{"$ref":"#/components/schemas/EmployerOfficialOrgName"},"type":"array"},{"type":"null"}],"title":"Employers","description":"List of employers under which the person has an active employment"}},"type":"object","required":["names","date_of_birth","nationalities","gov_ids","employers"],"title":"Person"},"examples":{"EmployeeTaxAuthorityData":{"description":"Employee with a Finnish tax number","value":{"names":[{"full_name":"Veijo Rakennustyöntekijä","given_names":["Veijo"],"surnames":["Rakennustyöntekijä"],"titles":[],"sort_key":"Rakennustyöntekijä, Veijo"}],"date_of_birth":"1947-01-03","nationalities":["FI"],"gov_ids":[{"gov_id":"872364838237","id_type":"tax_number","country":"FI"}],"employers":[{"name":"Oy Yritys Ab","employers_contact_person":{"contact_phone":"+358501234567","contact_last_name":"Sukunimi","contact_first_name":"Etunimi","contact_email":"user@host.com"},"country":"FI","address":{"full_address":"Osoite 100\n00100 Helsinki","address":["Osoite 100"],"post_area":"Hellsinki","post_code":"00100","country":"FI"},"employment_periods":[{"contract_type":1}],"gov_org_ids":[{"gov_org_id":"3583758-0","org_id_type":"registration_number","country":"FI"}],"tax_number_registration_status":{"shipyard_worker":false,"construction_worker":true}}]}}}}}},"403":{"description":"Forbidden","content":{"application/json":{"examples":{"ApiConsumerClosed":{"value":{"detail":"API consumer 00000000-0000-0000-0000-000000000000 is closed and cannot be modified"}},"ErrorDeterminingCustomership":{"value":{"detail":"Error determining customer-identifier customership."}},"NoActiveCustomership":{"value":{"detail":"No active customership for customer-identifier. Customer should contact Vastuu Group support."}},"CustomerIdentifierInvalid":{"value":{"detail":"customer-identifier is invalid or doesn't exist"}},"CustomerIdentifierNotActive":{"value":{"detail":"customer-identifier is not active"}},"ApiConsumerNotRegistered":{"value":{"detail":"API consumer is not registered"}},"LimitedRoleException":{"value":{"detail":"You are not allowed to access requested data for the provided customer-identifier."}},"LimitedCountriesException":{"value":{"detail":"You are not allowed to access the requested data for the provided customer-identifier due to country restrictions."}},"CardStatusClosed":{"description":"Card id used for searching is either inactive or expired.","value":{"detail":"The card used for searching is inactive or has expired."}},"MissingScope":{"description":"The access token provided in the request does not have the necessary scope.","value":{"detail":"Missing scope \"personapi/authority_report_get\""}},"PermissionDenies":{"description":"The requester does not have access to view data of the requested employment","value":{"detail":"The requester organization does not have access to the requested employment."}}},"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"404":{"description":"Not Found","content":{"application/json":{"examples":{"ApiConsumerNotFound":{"value":{"detail":"API consumer not found."}},"CustomerNotFound":{"value":{"detail":"Customer identifier 00000000-0000-0000-0000-000000000000 not found."}},"EmploymentNotFound":{"description":"No employee information found using the given _id_type_, _id_country_, _id_value_ combination.","value":{"detail":"no person found"}}},"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"413":{"description":"Request Entity Too Large","content":{"application/json":{"examples":{"RequestTooLarge":{"value":{"detail":"Request exceeds the maximum allowed size."}}},"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"examples":{"RateLimitExceeded":{"value":{"detail":"Too many requests"}}},"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError","properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"}}}},"400":{"description":"Bad request.","content":{"application/json":{"examples":{"MissingIdCountry":{"description":"*id-country* parameter of the search key used to specify whether it's a Finnish or Swedish tax number / social security number. Not required when _id-type_ is **card_uid** or **card_barcode**","value":{"detail":"Country code is required for SSN and tax numbers."}},"MissingIdParams":{"description":"The caller needs to provide all 3 headers id-type, id-value and id-country","value":{"detail":"header 'id-country' missing"}}},"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}}},"description":"Tax authority employee report data for a person/employee.\n\nPerforming this request returns information about a person as well as current employment details. The information returned is sufficient to satisfy the reporting requirements of the Finnish Tax authority. The endpoint returns data only for employments with a Finnish tax number which has been verified against the Finnish tax number register. \n\n**Required scope:** `personapi/authority_report_get`"}},"/personapi/v1.2/authority_report/official_org_name":{"get":{"tags":["Person API v1.2"],"summary":"Get tax authority employee report data for a person/employee with the official name of the organization","operationId":"personapi_authority_report_official_org_name_personapi_v1_2_authority_report_official_org_name_get","security":[{"HTTPBearer":["personapi/authority_report_official_org_name_get"]}],"parameters":[{"name":"id-type","in":"header","required":true,"schema":{"$ref":"#/components/schemas/routers__personapi_1_2__IdTypeEnum","description":"Type of the search key used"},"description":"Type of the search key used"},{"name":"id-value","in":"header","required":true,"schema":{"type":"string","pattern":"^[ -~]+$","description":"Value of the search key used for identifying person","title":"Id-Value"},"description":"Value of the search key used for identifying person"},{"name":"id-country","in":"header","required":false,"schema":{"$ref":"#/components/schemas/routers__personapi_1_2__CountryEnum","description":"Country code of the search key used to specify whether it's a Finnish or Swedish tax number / social security number. Not required when id-type is card_uid or card_barcode"},"description":"Country code of the search key used to specify whether it's a Finnish or Swedish tax number / social security number. Not required when id-type is card_uid or card_barcode"},{"name":"customer-identifier","in":"header","required":true,"schema":{"type":"string","format":"uuid","description":"Customer identifier required on every request","title":"Customer-Identifier"},"description":"Customer identifier required on every request"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"properties":{"names":{"items":{"$ref":"#/components/schemas/Names"},"type":"array","title":"Names","description":"List of person's names"},"date_of_birth":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Date Of Birth","description":"Date of birth","examples":["1980-01-20"]},"nationalities":{"anyOf":[{"items":{"type":"string","pattern":"^[A-Z]{2}$","description":"Country code","examples":["FI","SE"]},"type":"array"},{"type":"null"}],"title":"Nationalities","description":"Person's nationalities in ISO-3166 alpha-2 format country code as an array"},"gov_ids":{"items":{"$ref":"#/components/schemas/GovernmentID"},"type":"array","title":"Gov Ids","description":"List of person's government issued identifiers"},"employers":{"anyOf":[{"items":{"$ref":"#/components/schemas/app__personapi__model__employer__Employer"},"type":"array"},{"items":{"$ref":"#/components/schemas/EmployerOfficialOrgName"},"type":"array"},{"type":"null"}],"title":"Employers","description":"List of employers under which the person has an active employment"}},"type":"object","required":["names","date_of_birth","nationalities","gov_ids","employers"],"title":"Person"}}}},"403":{"description":"Forbidden","content":{"application/json":{"examples":{"ApiConsumerClosed":{"value":{"detail":"API consumer 00000000-0000-0000-0000-000000000000 is closed and cannot be modified"}},"ErrorDeterminingCustomership":{"value":{"detail":"Error determining customer-identifier customership."}},"NoActiveCustomership":{"value":{"detail":"No active customership for customer-identifier. Customer should contact Vastuu Group support."}},"CustomerIdentifierInvalid":{"value":{"detail":"customer-identifier is invalid or doesn't exist"}},"CustomerIdentifierNotActive":{"value":{"detail":"customer-identifier is not active"}},"ApiConsumerNotRegistered":{"value":{"detail":"API consumer is not registered"}},"LimitedRoleException":{"value":{"detail":"You are not allowed to access requested data for the provided customer-identifier."}},"LimitedCountriesException":{"value":{"detail":"You are not allowed to access the requested data for the provided customer-identifier due to country restrictions."}},"CardStatusClosed":{"description":"Card id used for searching is either inactive or expired.","value":{"detail":"The card used for searching is inactive or has expired."}},"MissingScope":{"description":"The access token provided in the request does not have the necessary scope.","value":{"detail":"Missing scope \"personapi/authority_report_get\""}}},"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"404":{"description":"Not Found","content":{"application/json":{"examples":{"ApiConsumerNotFound":{"value":{"detail":"API consumer not found."}},"CustomerNotFound":{"value":{"detail":"Customer identifier 00000000-0000-0000-0000-000000000000 not found."}},"EmploymentNotFound":{"description":"No employee information found using the given _id_type_, _id_country_, _id_value_ combination.","value":{"detail":"no person found"}}},"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"413":{"description":"Request Entity Too Large","content":{"application/json":{"examples":{"RequestTooLarge":{"value":{"detail":"Request exceeds the maximum allowed size."}}},"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"examples":{"RateLimitExceeded":{"value":{"detail":"Too many requests"}}},"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError","properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"}}}},"400":{"description":"Bad request.","content":{"application/json":{"examples":{"MissingIdCountry":{"description":"*id-country* parameter of the search key used to specify whether it's a Finnish or Swedish tax number / social security number. Not required when _id-type_ is **card_uid** or **card_barcode**","value":{"detail":"Country code is required for SSN and tax numbers."}},"MissingIdParams":{"description":"The caller needs to provide all 3 headers id-type, id-value and id-country","value":{"detail":"header 'id-country' missing"}}},"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}}},"description":"Get the employee and employment details for the Finnish tax authority report. Include the employer official name from the Finnish business information system (YTJ)\n\nPerforming this request returns information about a person as well as current employment details. The information returned is sufficient to satisfy the reporting requirements of the Finnish Tax authority. The endpoint returns data only for employments with a Finnish tax number which has been verified against the Finnish tax number register.\n\n**Required scope:** `personapi/authority_report_official_org_name_get`"}},"/personapi/v1.2/contacts":{"get":{"tags":["Person API v1.2"],"summary":"Get contact information of one person/employee","operationId":"personapi_contacts_personapi_v1_2_contacts_get","security":[{"HTTPBearer":["personapi/contacts_get"]}],"parameters":[{"name":"id-type","in":"header","required":true,"schema":{"$ref":"#/components/schemas/routers__personapi_1_2__IdTypeEnum","description":"Type of the search key used"},"description":"Type of the search key used"},{"name":"id-value","in":"header","required":true,"schema":{"type":"string","pattern":"^[ -~]+$","description":"Value of the search key used for identifying person","title":"Id-Value"},"description":"Value of the search key used for identifying person"},{"name":"id-country","in":"header","required":false,"schema":{"$ref":"#/components/schemas/routers__personapi_1_2__CountryEnum","description":"Country code of the search key used to specify whether it's a Finnish or Swedish tax number / social security number. Not required when id-type is card_uid or card_barcode"},"description":"Country code of the search key used to specify whether it's a Finnish or Swedish tax number / social security number. Not required when id-type is card_uid or card_barcode"},{"name":"org-id-country","in":"header","required":false,"schema":{"type":"string","pattern":"^[A-Za-z]{2}$","description":"Country code of the search key used for identifying employer company, not required when id-type is card_uid or card_barcode","title":"Org-Id-Country"},"description":"Country code of the search key used for identifying employer company, not required when id-type is card_uid or card_barcode"},{"name":"org-id-type","in":"header","required":false,"schema":{"$ref":"#/components/schemas/OrgIdTypeEnum","description":"Type of the search key used for identifying employer company, not required when id-type is card_uid or card_barcode"},"description":"Type of the search key used for identifying employer company, not required when id-type is card_uid or card_barcode"},{"name":"org-id-value","in":"header","required":false,"schema":{"type":"string","pattern":"^[ -~]+$","description":"Value of the search key used for identifying employer company, not required when id-type is card_uid or card_barcode","examples":["2327327-1"],"title":"Org-Id-Value"},"description":"Value of the search key used for identifying employer company, not required when id-type is card_uid or card_barcode"},{"name":"customer-identifier","in":"header","required":true,"schema":{"type":"string","format":"uuid","description":"Customer identifier required on every request","title":"Customer-Identifier"},"description":"Customer identifier required on every request"}],"responses":{"200":{"description":"Contacts","content":{"application/json":{"schema":{"properties":{"names":{"items":{"$ref":"#/components/schemas/Name"},"type":"array","title":"Names","description":"List of person's names"},"phone_numbers":{"items":{"$ref":"#/components/schemas/PhoneNumber"},"type":"array","title":"Phone Numbers","description":"List of person's phone numbers"},"addresses":{"items":{"$ref":"#/components/schemas/ContactAddress"},"type":"array","title":"Addresses","description":"List of person's addresses. Returns an empty list","deprecated":true},"email_addresses":{"items":{"$ref":"#/components/schemas/EmailAddress"},"type":"array","title":"Email Addresses","description":"List of person's email addresses"}},"type":"object","required":["names","phone_numbers","addresses","email_addresses"],"title":"Contacts"}}}},"403":{"description":"Forbidden","content":{"application/json":{"examples":{"ApiConsumerClosed":{"value":{"detail":"API consumer 00000000-0000-0000-0000-000000000000 is closed and cannot be modified"}},"ErrorDeterminingCustomership":{"value":{"detail":"Error determining customer-identifier customership."}},"NoActiveCustomership":{"value":{"detail":"No active customership for customer-identifier. Customer should contact Vastuu Group support."}},"CustomerIdentifierInvalid":{"value":{"detail":"customer-identifier is invalid or doesn't exist"}},"CustomerIdentifierNotActive":{"value":{"detail":"customer-identifier is not active"}},"ApiConsumerNotRegistered":{"value":{"detail":"API consumer is not registered"}},"LimitedRoleException":{"value":{"detail":"You are not allowed to access requested data for the provided customer-identifier."}},"LimitedCountriesException":{"value":{"detail":"You are not allowed to access the requested data for the provided customer-identifier due to country restrictions."}},"MissingScope":{"description":"The access token provided in the request does not have the necessary scope.","value":{"detail":"Missing scope \"personapi/contacts_get\""}},"PermissionDenied":{"description":"The requester is trying to access contacts details of an employee without a verified Finnish tax number. The data is available only for employers.","value":{"detail":"The requester organization does not have access to the requested employment."}}},"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"404":{"description":"Not Found","content":{"application/json":{"examples":{"ApiConsumerNotFound":{"value":{"detail":"API consumer not found."}},"CustomerNotFound":{"value":{"detail":"Customer identifier 00000000-0000-0000-0000-000000000000 not found."}}},"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"413":{"description":"Request Entity Too Large","content":{"application/json":{"examples":{"RequestTooLarge":{"value":{"detail":"Request exceeds the maximum allowed size."}}},"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"examples":{"RateLimitExceeded":{"value":{"detail":"Too many requests"}}},"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError","properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"}}}},"400":{"description":"Bad request.","content":{"application/json":{"examples":{"MissingOrgSearchParams":{"description":"The endpoint needs to be called with a combination of tax number and organization identifiers.","value":{"detail":"type tax_number requires org search params"}},"MissingIdParams":{"description":"The caller needs to provide all 3 headers id-type, id-value and id-country","value":{"detail":"header 'id-country' missing"}}},"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}}},"description":"Search employee contact details.\n\nStarting from API version v1.2 the endpoint will also return contact details for employees without a verified tax number in the Finnish tax registry. The data is only available to the employer itself. 403 HTTP return code is returned if the data is not available to the requester. Also, tax number is not available as a search key when the employment data lacks a verified tax number.\n\n**Required scope:** `personapi/contacts_get`"}},"/personapi/v1.2/personal_information":{"get":{"tags":["Person API v1.2"],"summary":"Get tax number of one person/employee","operationId":"personapi_personal_information_personapi_v1_2_personal_information_get","security":[{"HTTPBearer":["personapi/personal_information_get"]}],"parameters":[{"name":"items","in":"query","required":true,"schema":{"$ref":"#/components/schemas/ItemsEnum","title":"Items","description":"Item types to include in the response (only tax_number is supported)"},"description":"Item types to include in the response (only tax_number is supported)"},{"name":"id-type","in":"header","required":true,"schema":{"$ref":"#/components/schemas/routers__personapi_1_2__IdTypeEnum","description":"Type of the search key used"},"description":"Type of the search key used"},{"name":"id-value","in":"header","required":true,"schema":{"type":"string","pattern":"^[ -~]+$","description":"Value of the search key used for identifying person","title":"Id-Value"},"description":"Value of the search key used for identifying person"},{"name":"id-country","in":"header","required":false,"schema":{"$ref":"#/components/schemas/routers__personapi_1_2__CountryEnum","description":"Country code of the search key used to specify whether it's a Finnish or Swedish tax number / social security number. Not required when id-type is card_uid or card_barcode"},"description":"Country code of the search key used to specify whether it's a Finnish or Swedish tax number / social security number. Not required when id-type is card_uid or card_barcode"},{"name":"customer-identifier","in":"header","required":true,"schema":{"type":"string","format":"uuid","description":"Customer identifier required on every request","title":"Customer-Identifier"},"description":"Customer identifier required on every request"}],"responses":{"200":{"description":"Contacts","content":{"application/json":{"schema":{"properties":{"tax_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Tax Number","description":"Person's tax number","examples":["1234567890"]}},"type":"object","required":["tax_number"],"title":"PersonalInformation"}}}},"403":{"description":"Forbidden","content":{"application/json":{"examples":{"ApiConsumerClosed":{"value":{"detail":"API consumer 00000000-0000-0000-0000-000000000000 is closed and cannot be modified"}},"ErrorDeterminingCustomership":{"value":{"detail":"Error determining customer-identifier customership."}},"NoActiveCustomership":{"value":{"detail":"No active customership for customer-identifier. Customer should contact Vastuu Group support."}},"CustomerIdentifierInvalid":{"value":{"detail":"customer-identifier is invalid or doesn't exist"}},"CustomerIdentifierNotActive":{"value":{"detail":"customer-identifier is not active"}},"ApiConsumerNotRegistered":{"value":{"detail":"API consumer is not registered"}},"LimitedRoleException":{"value":{"detail":"You are not allowed to access requested data for the provided customer-identifier."}},"LimitedCountriesException":{"value":{"detail":"You are not allowed to access the requested data for the provided customer-identifier due to country restrictions."}}},"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"404":{"description":"Not Found","content":{"application/json":{"examples":{"ApiConsumerNotFound":{"value":{"detail":"API consumer not found."}},"CustomerNotFound":{"value":{"detail":"Customer identifier 00000000-0000-0000-0000-000000000000 not found."}}},"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"413":{"description":"Request Entity Too Large","content":{"application/json":{"examples":{"RequestTooLarge":{"value":{"detail":"Request exceeds the maximum allowed size."}}},"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"examples":{"RateLimitExceeded":{"value":{"detail":"Too many requests"}}},"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError","properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"}}}},"400":{"description":"Bad request.","content":{"application/json":{"examples":{"InvalidItemsType":{"description":"A valid _items_ query parameter needs to be provided.","value":{"detail":"missing or wrong value in items"}},"MissingIdParams":{"description":"The caller needs to provide all 3 headers _id-type_, _id-value_ and _id-country_","value":{"detail":"header 'id-country' missing"}}},"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}}},"description":"Search employee tax number using card identifiers or ssn. The endpoint returns data only for employments with a Finnish tax number which has been verified against the Finnish tax number register.\n\n**Required scope:** `personapi/personal_information_get`"}},"/personapi/v1.2/card":{"get":{"tags":["Person API v1.2"],"summary":"Get card data","operationId":"personapi_card_personapi_v1_2_card_get","security":[{"HTTPBearer":["personapi/card_get"]}],"parameters":[{"name":"id-type","in":"header","required":true,"schema":{"$ref":"#/components/schemas/CardIdTypeEnum","description":"Type of the search key used"},"description":"Type of the search key used"},{"name":"id-value","in":"header","required":true,"schema":{"type":"string","pattern":"^[ -~]+$","description":"Value of the search key used for identifying person","title":"Id-Value"},"description":"Value of the search key used for identifying person"},{"name":"customer-identifier","in":"header","required":true,"schema":{"type":"string","format":"uuid","description":"Customer identifier required on every request","title":"Customer-Identifier"},"description":"Customer identifier required on every request"}],"responses":{"200":{"description":"Card data","content":{"application/json":{"schema":{"properties":{"card_barcode":{"type":"string","title":"Card Barcode","description":"Card barcode. The card barcode is a 12-digit number located on the top side of the card."},"card_uid":{"type":"string","title":"Card Uid","description":"Card UID: the internal 7-byte MIFARE unique identifier assigned to the card."},"valid_from_date":{"type":"string","format":"date","title":"Valid From Date","description":"Card validity start date"},"valid_until_date":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Valid Until Date","description":"Card validity end date"},"status":{"$ref":"#/components/schemas/CardStatus","description":"The current status of the card. Data is provided only for cards that are active."},"verification_status":{"$ref":"#/components/schemas/CardVerificationStatus","description":"Verification status of the card. A card is considered verified when the cardholder has confirmed it through the cardholder portal using strong authentication."},"card_holder":{"$ref":"#/components/schemas/CardHolder","description":"Card holder"},"employer":{"$ref":"#/components/schemas/CardEmployer","description":"Employer"}},"type":"object","required":["card_barcode","card_uid","valid_from_date","valid_until_date","status","verification_status","card_holder","employer"],"title":"CardData"},"examples":{"Construction Valtti card":{"summary":"Valtti card for construction sites","description":"Valtti card for construction sites","value":{"card_barcode":"739812348728","card_uid":"AE3B32FFAE3B12","valid_from_date":"2019-08-24","valid_until_date":"2024-08-24","status":"Active","verification_status":"Verified","card_holder":{"given_name":"Erkki","surname":"Esimerkki","date_of_birth":"2019-08-24","taxnumber":"123456789876","taxnumber_registry":["construction"]},"employer":{"name":"Oy Employer Ab","official_name":"Oy Employer Ab","registration_number":"6303826-8","country_code":"FI"}}},"Shipbuilding Valtti card":{"summary":"Valtti card for shipyards","description":"Valtti card for shipyards","value":{"card_barcode":"739812348728","card_uid":"AE3B32FFAE3B12","valid_from_date":"2019-08-24","valid_until_date":"2024-08-24","status":"Active","verification_status":"Verified","card_holder":{"given_name":"Erkki","surname":"Esimerkki","date_of_birth":"2019-08-24","taxnumber":"123456789876","taxnumber_registry":["shipbuilding"]},"employer":{"name":"Oy Employer Ab","official_name":"Oy Employer Ab","registration_number":"6303826-8","country_code":"FI"}}},"Generic Valtti card":{"summary":"Generic Valtti card","description":"Generic Valtti card. A generic Valtti card lacks both tax number and tax number registry details.","value":{"card_barcode":"545216342768","card_uid":"BC4B87FFAE4B12","valid_from_date":"2019-08-12","valid_until_date":"2024-08-12","status":"Active","verification_status":"Verified","card_holder":{"given_name":"Enni","surname":"Esimerkki","date_of_birth":"2019-08-24"},"employer":{"name":"Oy Employer Ab","official_name":"Oy Employer Ab","registration_number":"6303826-8","country_code":"FI"}}}}}}},"403":{"description":"Permission denied","content":{"application/json":{"examples":{"ApiConsumerClosed":{"value":{"detail":"API consumer 00000000-0000-0000-0000-000000000000 is closed and cannot be modified"}},"ErrorDeterminingCustomership":{"value":{"detail":"Error determining customer-identifier customership."}},"NoActiveCustomership":{"value":{"detail":"No active customership for customer-identifier. Customer should contact Vastuu Group support."}},"CustomerIdentifierInvalid":{"value":{"detail":"customer-identifier is invalid or doesn't exist"}},"CustomerIdentifierNotActive":{"value":{"detail":"customer-identifier is not active"}},"ApiConsumerNotRegistered":{"value":{"detail":"API consumer is not registered"}},"LimitedRoleException":{"value":{"detail":"You are not allowed to access requested data for the provided customer-identifier."}},"LimitedCountriesException":{"value":{"detail":"You are not allowed to access the requested data for the provided customer-identifier due to country restrictions."}},"PermissionDenied":{"summary":"Permission denied.","description":"The requester is not allowed to access the requested organization.","value":{"detail":"Forbidden. The requester is not allowed to access the requested organization.","reason":"PermissionDenied"}},"CardClosed":{"summary":"Card terminated.","description":"The card used for the search is either inactive or has expired.","value":{"detail":"The card used for the search is either inactive or has expired.","reason":"CardClosed","card_termination_reason":"NewCardProduced"}}},"schema":{"$ref":"#/components/schemas/PermissionDenied"}}}},"404":{"description":"Not Found","content":{"application/json":{"examples":{"ApiConsumerNotFound":{"value":{"detail":"API consumer not found."}},"CustomerNotFound":{"value":{"detail":"Customer identifier 00000000-0000-0000-0000-000000000000 not found."}},"CardNotFound":{"description":"No card found with the given card identifier.","value":{"detail":"No card found with the given card identifier."}}},"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"413":{"description":"Request Entity Too Large","content":{"application/json":{"examples":{"RequestTooLarge":{"value":{"detail":"Request exceeds the maximum allowed size."}}},"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"examples":{"RateLimitExceeded":{"value":{"detail":"Too many requests"}}},"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError","properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"}}}}},"description":"Retrieve card data using a barcode or internal chip UID.\n\nThe endpoints returns card basic information like status and validity, card holder, card holder employer.\n\nThis endpoint provides data for Valtti cards used in construction/shipbuilding as well as for generic Valtti cards. Access to generic Valtti cards is limited to the employer.\n\n**Required scope:** `personapi/card_get`"}},"/tarkastaja/v1.1/organization_permission_information":{"post":{"tags":["Tarkastaja API v1.1"],"summary":"Organization permission information","operationId":"tarkastaja_organization_permission_information_tarkastaja_v1_1_organization_permission_information_post","security":[{"HTTPBearer":["tarkastaja/employment_get"]}],"parameters":[{"name":"licenses","in":"query","required":false,"schema":{"type":"boolean","description":"Return licenses information if available","enum":[true,false],"default":false,"title":"Licenses"},"description":"Return licenses information if available"},{"name":"customer-identifier","in":"header","required":true,"schema":{"type":"string","format":"uuid","description":"Customer identifier required on every request","title":"Customer-Identifier"},"description":"Customer identifier required on every request"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/OrganizationPermissionInformationBody"},"title":"Body"}}}},"responses":{"200":{"description":"Organization permission information","content":{"application/json":{"schema":{"properties":{"permission":{"items":{"$ref":"#/components/schemas/OrganizationPermissionInformationRow"},"type":"array","title":"Permission","description":"Organizations that the data consumer has access to"},"no_permission":{"items":{"$ref":"#/components/schemas/OrganizationPermissionInformationRow"},"type":"array","title":"No Permission","description":"Organizations that the data consumer does not have access to"}},"type":"object","required":["permission","no_permission"],"title":"OrganizationPermissionInformation"}}}},"403":{"description":"Forbidden.","content":{"application/json":{"examples":{"ApiConsumerClosed":{"value":{"detail":"API consumer 00000000-0000-0000-0000-000000000000 is closed and cannot be modified"}},"ErrorDeterminingCustomership":{"value":{"detail":"Error determining customer-identifier customership."}},"NoActiveCustomership":{"value":{"detail":"No active customership for customer-identifier. Customer should contact Vastuu Group support."}},"CustomerIdentifierInvalid":{"value":{"detail":"customer-identifier is invalid or doesn't exist"}},"CustomerIdentifierNotActive":{"value":{"detail":"customer-identifier is not active"}},"ApiConsumerNotRegistered":{"value":{"detail":"API consumer is not registered"}},"LimitedRoleException":{"value":{"detail":"You are not allowed to access requested data for the provided customer-identifier."}},"LimitedCountriesException":{"value":{"detail":"You are not allowed to access the requested data for the provided customer-identifier due to country restrictions."}},"NoActiveValttiTarkastajaLicense":{"value":{"detail":"No active license.","error":"license_missing","product_plan_id":"","product_family_id":"ValttiPlusTarkastajaAPI","product_name":"Valtti+ Tarkastaja API"}},"MissingScope":{"description":"The access token provided in the request does not have the necessary scope.","value":{"detail":"Missing scope \"tarkastaja/employment_get\""}},"PermissionDenied":{"description":"The provided customer-identifier is used in attempt to access more resources than it is allowed to access.","value":{"detail":"You are not allowed to access requested data for the provided customer-identifier."}}},"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"404":{"description":"Not Found","content":{"application/json":{"examples":{"ApiConsumerNotFound":{"value":{"detail":"API consumer not found."}},"CustomerNotFound":{"value":{"detail":"Customer identifier 00000000-0000-0000-0000-000000000000 not found."}}},"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"413":{"description":"Request Entity Too Large","content":{"application/json":{"examples":{"RequestTooLarge":{"value":{"detail":"Request exceeds the maximum allowed size."}}},"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"examples":{"RateLimitExceeded":{"value":{"detail":"Too many requests"}}},"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"422":{"description":"Request couldn't be validated. This should be considered a programmer error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"500":{"description":"Internal Server Error."}},"description":"Employers must either directly authorize each principal contractor or external party to access their employee data, or provide a global permission.This API endpoint is for the principal contractors or external parties and can be used to check which companies have authorized the user of their employee data.\n\n**Required scope:** `tarkastaja/employment_get`"}},"/tarkastaja/v1.1/employment":{"get":{"tags":["Tarkastaja API v1.1"],"summary":"Search employments","operationId":"tarkastaja_employment_tarkastaja_v1_1_employment_get","security":[{"HTTPBearer":["tarkastaja/employment_get"]}],"parameters":[{"name":"org_id","in":"query","required":true,"schema":{"type":"string","description":"Government id of the organization","examples":["2327327-1"],"title":"Org Id"},"description":"Government id of the organization"},{"name":"org_id_type","in":"query","required":true,"schema":{"type":"string","description":"Type of the organization id","enum":["registration_number","vat_number"],"title":"Org Id Type"},"description":"Type of the organization id"},{"name":"org_id_country","in":"query","required":true,"schema":{"type":"string","pattern":"^[A-Z]{2}$","description":"Country of the organization id","examples":["FI"],"title":"Org Id Country"},"description":"Country of the organization id"},{"name":"person_id","in":"query","required":true,"schema":{"type":"string","description":"Person id","examples":["100010010011"],"title":"Person Id"},"description":"Person id"},{"name":"person_id_type","in":"query","required":true,"schema":{"type":"string","description":"Type of the person id","enum":["tax_number"],"title":"Person Id Type"},"description":"Type of the person id"},{"name":"person_id_country","in":"query","required":true,"schema":{"type":"string","pattern":"^[A-Z]{2}$","description":"Country of the person id","examples":["FI"],"title":"Person Id Country"},"description":"Country of the person id"},{"name":"customer-identifier","in":"header","required":true,"schema":{"type":"string","format":"uuid","description":"Customer identifier required on every request","title":"Customer-Identifier"},"description":"Customer identifier required on every request"}],"responses":{"200":{"description":"Employment details","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Employment"},"title":"Response Search Employments Tarkastaja V1 1 Employment Get"}}}},"403":{"description":"Forbidden.","content":{"application/json":{"examples":{"ApiConsumerClosed":{"value":{"detail":"API consumer 00000000-0000-0000-0000-000000000000 is closed and cannot be modified"}},"ErrorDeterminingCustomership":{"value":{"detail":"Error determining customer-identifier customership."}},"NoActiveCustomership":{"value":{"detail":"No active customership for customer-identifier. Customer should contact Vastuu Group support."}},"CustomerIdentifierInvalid":{"value":{"detail":"customer-identifier is invalid or doesn't exist"}},"CustomerIdentifierNotActive":{"value":{"detail":"customer-identifier is not active"}},"ApiConsumerNotRegistered":{"value":{"detail":"API consumer is not registered"}},"LimitedRoleException":{"value":{"detail":"You are not allowed to access requested data for the provided customer-identifier."}},"LimitedCountriesException":{"value":{"detail":"You are not allowed to access the requested data for the provided customer-identifier due to country restrictions."}},"NoActiveValttiTarkastajaLicense":{"value":{"detail":"No active license.","error":"license_missing","product_plan_id":"","product_family_id":"ValttiPlusTarkastajaAPI","product_name":"Valtti+ Tarkastaja API"}},"MissingAccessPermission":{"description":"The requested organization needs to have an active Valtti service plan and it needs to add permission to the requester to access it's employment data.","value":{"detail":"Forbidden. The requester is not allowed to access the requested organization."}}},"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"404":{"description":"Employment not found. This will always be returned if permissions are in order and there are no matches.","content":{"application/json":{"examples":{"ApiConsumerNotFound":{"value":{"detail":"API consumer not found."}},"CustomerNotFound":{"value":{"detail":"Customer identifier 00000000-0000-0000-0000-000000000000 not found."}},"OrganizationNotFound":{"value":{"detail":"Organization resource not found"}}},"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"413":{"description":"Request Entity Too Large","content":{"application/json":{"examples":{"RequestTooLarge":{"value":{"detail":"Request exceeds the maximum allowed size."}}},"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"examples":{"RateLimitExceeded":{"value":{"detail":"Too many requests"}}},"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"422":{"description":"Request couldn't be validated. This should be considered a programmer error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"description":"Get employments by person's natural identifiers, as seen by the given organization.\n\nThe response might include multiple responses for the same person, if the person is visible to the requester through multiple organizations with the same id. The response will always be an array.\n\n**Required scope:** `tarkastaja/employment_get`"}},"/tarkastaja/v1.1/employment/by_card":{"get":{"tags":["Tarkastaja API v1.1"],"summary":"Search employments by Valtti Card","operationId":"tarkastaja_employment_by_card_tarkastaja_v1_1_employment_by_card_get","security":[{"HTTPBearer":["tarkastaja/employment_get"]}],"parameters":[{"name":"barcode","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Barcode number of the Valtti Card","examples":["655421645882"],"title":"Barcode"},"description":"Barcode number of the Valtti Card"},{"name":"uid","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Chip id of the Valtti Card","examples":["04E24B9AAF4801"],"title":"Uid"},"description":"Chip id of the Valtti Card"},{"name":"customer-identifier","in":"header","required":true,"schema":{"type":"string","format":"uuid","description":"Customer identifier required on every request","title":"Customer-Identifier"},"description":"Customer identifier required on every request"}],"responses":{"200":{"description":"Employment details","content":{"application/json":{"schema":{"properties":{"id":{"type":"string","pattern":"^EMex-[0-9a-f-]+$","title":"Id","description":"Employment ID"},"employer":{"$ref":"#/components/schemas/app__tarkastaja__v1_1__model__employment__Employer","description":"Employer organization's details"},"person":{"$ref":"#/components/schemas/app__tarkastaja__v1_1__model__employment__Person","description":"Person's details"},"documents":{"items":{"oneOf":[{"$ref":"#/components/schemas/IdentificationDocument"},{"$ref":"#/components/schemas/ResidencePermitDocument"},{"$ref":"#/components/schemas/A1CertificateDocument"}],"discriminator":{"propertyName":"type","mapping":{"a1certificate":"#/components/schemas/A1CertificateDocument","identification":"#/components/schemas/IdentificationDocument","residencepermit":"#/components/schemas/ResidencePermitDocument"}}},"type":"array","title":"Documents","description":"List of documents related to the employment.\nThe documents are only included if the company has a Valtti service plan."},"competences":{"items":{"$ref":"#/components/schemas/CompetenceWithType"},"type":"array","title":"Competences","description":"List of competences related to the employment.\nThe competences are only included if the company has a Valtti service plan."},"posted_worker_contact_info":{"anyOf":[{"$ref":"#/components/schemas/PostedWorkerContactInfo"},{"type":"null"}],"description":"Contact information for the posted worker. Added by the employer in the Vastuu Group Employee Management service"}},"type":"object","required":["id","employer","person","documents","competences"],"title":"Employment"}}}},"403":{"description":"Forbidden.","content":{"application/json":{"examples":{"ApiConsumerClosed":{"value":{"detail":"API consumer 00000000-0000-0000-0000-000000000000 is closed and cannot be modified"}},"ErrorDeterminingCustomership":{"value":{"detail":"Error determining customer-identifier customership."}},"NoActiveCustomership":{"value":{"detail":"No active customership for customer-identifier. Customer should contact Vastuu Group support."}},"CustomerIdentifierInvalid":{"value":{"detail":"customer-identifier is invalid or doesn't exist"}},"CustomerIdentifierNotActive":{"value":{"detail":"customer-identifier is not active"}},"ApiConsumerNotRegistered":{"value":{"detail":"API consumer is not registered"}},"LimitedRoleException":{"value":{"detail":"You are not allowed to access requested data for the provided customer-identifier."}},"LimitedCountriesException":{"value":{"detail":"You are not allowed to access the requested data for the provided customer-identifier due to country restrictions."}},"NoActiveValttiTarkastajaLicense":{"value":{"detail":"No active license.","error":"license_missing","product_plan_id":"","product_family_id":"ValttiPlusTarkastajaAPI","product_name":"Valtti+ Tarkastaja API"}},"MissingAccessPermission":{"description":"The requested organization needs to have an active Valtti service plan and it needs to add permission to the requester to access it's employment data.","value":{"detail":"Forbidden. The requester is not allowed to access the requested organization."}}},"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"404":{"description":"Card not found.","content":{"application/json":{"examples":{"ApiConsumerNotFound":{"value":{"detail":"API consumer not found."}},"CustomerNotFound":{"value":{"detail":"Customer identifier 00000000-0000-0000-0000-000000000000 not found."}},"CardNotFound":{"description":"Card with the given id does not exist.","value":{"detail":"barcode and uid are mutually exclusive"}},"CardInactive":{"description":"Card with the given id is not active.","value":{"detail":"The card used for searching is inactive or has expired."}}},"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"413":{"description":"Request Entity Too Large","content":{"application/json":{"examples":{"RequestTooLarge":{"value":{"detail":"Request exceeds the maximum allowed size."}}},"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"examples":{"RateLimitExceeded":{"value":{"detail":"Too many requests"}}},"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"422":{"description":"Invalid parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"},"examples":{"BarcodeUidMutuallyExclusive":{"description":"Provide either card barcode or card uid but not both.","value":{"detail":"barcode and uid are mutually exclusive"}},"MissingBarcodeOrUid":{"description":"Provide either card *barcode* or card *uid* query string parameter.","value":{"detail":"Either barcode or uid must be provided"}}}}}}},"description":"Search employments by Valtti Card chip uid or barcode number.\nYou can use either the chip id (uid) or the barcode number, but not both.\n\n**Required scope:** `tarkastaja/employment_get`"}},"/tarkastaja/v1.1/employment/{employment_id}":{"get":{"tags":["Tarkastaja API v1.1"],"summary":"Get employment by id","operationId":"tarkastaja_employment_by_id_tarkastaja_v1_1_employment__employment_id__get","security":[{"HTTPBearer":["tarkastaja/employment_get"]}],"parameters":[{"name":"employment_id","in":"path","required":true,"schema":{"type":"string","pattern":"^EMex-[0-9a-f-]+$","examples":["EMex-6e5fce6544bdc33f2a436308f3f4d02c-a9209fd3"],"title":"Employment Id"}},{"name":"customer-identifier","in":"header","required":true,"schema":{"type":"string","format":"uuid","description":"Customer identifier required on every request","title":"Customer-Identifier"},"description":"Customer identifier required on every request"}],"responses":{"200":{"description":"Employment details","content":{"application/json":{"schema":{"properties":{"id":{"type":"string","pattern":"^EMex-[0-9a-f-]+$","title":"Id","description":"Employment ID"},"employer":{"$ref":"#/components/schemas/app__tarkastaja__v1_1__model__employment__Employer","description":"Employer organization's details"},"person":{"$ref":"#/components/schemas/app__tarkastaja__v1_1__model__employment__Person","description":"Person's details"},"documents":{"items":{"oneOf":[{"$ref":"#/components/schemas/IdentificationDocument"},{"$ref":"#/components/schemas/ResidencePermitDocument"},{"$ref":"#/components/schemas/A1CertificateDocument"}],"discriminator":{"propertyName":"type","mapping":{"a1certificate":"#/components/schemas/A1CertificateDocument","identification":"#/components/schemas/IdentificationDocument","residencepermit":"#/components/schemas/ResidencePermitDocument"}}},"type":"array","title":"Documents","description":"List of documents related to the employment.\nThe documents are only included if the company has a Valtti service plan."},"competences":{"items":{"$ref":"#/components/schemas/CompetenceWithType"},"type":"array","title":"Competences","description":"List of competences related to the employment.\nThe competences are only included if the company has a Valtti service plan."},"posted_worker_contact_info":{"anyOf":[{"$ref":"#/components/schemas/PostedWorkerContactInfo"},{"type":"null"}],"description":"Contact information for the posted worker. Added by the employer in the Vastuu Group Employee Management service"}},"type":"object","required":["id","employer","person","documents","competences"],"title":"Employment"}}}},"403":{"description":"Forbidden.","content":{"application/json":{"examples":{"ApiConsumerClosed":{"value":{"detail":"API consumer 00000000-0000-0000-0000-000000000000 is closed and cannot be modified"}},"ErrorDeterminingCustomership":{"value":{"detail":"Error determining customer-identifier customership."}},"NoActiveCustomership":{"value":{"detail":"No active customership for customer-identifier. Customer should contact Vastuu Group support."}},"CustomerIdentifierInvalid":{"value":{"detail":"customer-identifier is invalid or doesn't exist"}},"CustomerIdentifierNotActive":{"value":{"detail":"customer-identifier is not active"}},"ApiConsumerNotRegistered":{"value":{"detail":"API consumer is not registered"}},"LimitedRoleException":{"value":{"detail":"You are not allowed to access requested data for the provided customer-identifier."}},"LimitedCountriesException":{"value":{"detail":"You are not allowed to access the requested data for the provided customer-identifier due to country restrictions."}},"NoActiveValttiTarkastajaLicense":{"value":{"detail":"No active license.","error":"license_missing","product_plan_id":"","product_family_id":"ValttiPlusTarkastajaAPI","product_name":"Valtti+ Tarkastaja API"}},"MissingAccessPermission":{"description":"The requested organization needs to have an active Valtti service plan and it needs to add permission to the requester to access it's employment data.","value":{"detail":"Forbidden. The requester is not allowed to access the requested organization."}}},"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"404":{"description":"Employment not found. This will always be returned if permissions are in order and there are no matches.","content":{"application/json":{"examples":{"ApiConsumerNotFound":{"value":{"detail":"API consumer not found."}},"CustomerNotFound":{"value":{"detail":"Customer identifier 00000000-0000-0000-0000-000000000000 not found."}},"EmploymentNotFound":{"description":"Employment not found.","value":{"detail":"Resource not found"}}},"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"413":{"description":"Request Entity Too Large","content":{"application/json":{"examples":{"RequestTooLarge":{"value":{"detail":"Request exceeds the maximum allowed size."}}},"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"examples":{"RateLimitExceeded":{"value":{"detail":"Too many requests"}}},"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"422":{"description":"Request couldn't be validated. This should be considered a programmer error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"description":"Get employment by ID.\n\nEmployments are tied to a single organization, so the organization ID is not required and the endpoint will always return a single employment.\n\n**Required scope:** `tarkastaja/employment_get`"}},"/tarkastaja/v1.1/attachment/{file_token}":{"get":{"tags":["Tarkastaja API v1.1"],"summary":"Get an attachment","operationId":"tarkastaja_attachment_tarkastaja_v1_1_attachment__file_token__get","security":[{"HTTPBearer":["tarkastaja/employment_get"]}],"parameters":[{"name":"file_token","in":"path","required":true,"schema":{"type":"string","examples":["5dd89dc2-a8bb-463f-883c-27a72b478ad0"],"title":"File Token"}},{"name":"customer-identifier","in":"header","required":true,"schema":{"type":"string","format":"uuid","description":"Customer identifier required on every request","title":"Customer-Identifier"},"description":"Customer identifier required on every request"}],"responses":{"200":{"description":"The attachment binary content. Currently this is an image file. The Content-Type response header tells the exact image file format (eg. image/png or image/jpg).","content":{"application/octet-stream":{"schema":{"type":"string"}}}},"403":{"description":"Forbidden.","content":{"application/json":{"examples":{"ApiConsumerClosed":{"value":{"detail":"API consumer 00000000-0000-0000-0000-000000000000 is closed and cannot be modified"}},"ErrorDeterminingCustomership":{"value":{"detail":"Error determining customer-identifier customership."}},"NoActiveCustomership":{"value":{"detail":"No active customership for customer-identifier. Customer should contact Vastuu Group support."}},"CustomerIdentifierInvalid":{"value":{"detail":"customer-identifier is invalid or doesn't exist"}},"CustomerIdentifierNotActive":{"value":{"detail":"customer-identifier is not active"}},"ApiConsumerNotRegistered":{"value":{"detail":"API consumer is not registered"}},"LimitedRoleException":{"value":{"detail":"You are not allowed to access requested data for the provided customer-identifier."}},"LimitedCountriesException":{"value":{"detail":"You are not allowed to access the requested data for the provided customer-identifier due to country restrictions."}},"NoActiveValttiTarkastajaLicense":{"value":{"detail":"No active license.","error":"license_missing","product_plan_id":"","product_family_id":"ValttiPlusTarkastajaAPI","product_name":"Valtti+ Tarkastaja API"}},"MissingAccessPermission":{"description":"The requested organization needs to have an active Valtti service plan and it needs to add permission to the requester to access it's employment data. Also, the single-use token is bound to the requester organization and is only valid for the organization who requested the employment details.","value":{"detail":"Forbidden. The requester is not allowed to access the requested organization."}}},"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"404":{"description":"Attachment not found. Either the single-use token has been used or it has expired.","content":{"application/json":{"examples":{"ApiConsumerNotFound":{"value":{"detail":"API consumer not found."}},"CustomerNotFound":{"value":{"detail":"Customer identifier 00000000-0000-0000-0000-000000000000 not found."}},"AttachmentNotFound":{"description":"Attachment not found. Either the single-use token has been used or it has expired.","value":{"detail":"Attachment not found."}}},"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"413":{"description":"Request Entity Too Large","content":{"application/json":{"examples":{"RequestTooLarge":{"value":{"detail":"Request exceeds the maximum allowed size."}}},"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"examples":{"RateLimitExceeded":{"value":{"detail":"Too many requests"}}},"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError","properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"}}}}},"description":"Reads an attachment file. The attachment URLs are not persistent. They include a single-use token valid for 30 minutes. The the URL becomes invalid after the attachment has been fetched successfully once.\n\n**Required scope:** `tarkastaja/employment_get`\n\nThe attachments are fetched through one of the _/tarkastaja/v1.1/employment/*_ endpoints. The employment document contains _competences_ and _documents_ and those in turn contain _attachments_ (see the example below). _attachments_ contains URLs to the actual binary files. The last part of the URL is the single-use token.\n```\n\"attachments\": [\n  {\n    \"id\": \"string\",\n    \"created_at\": \"2024-09-23T11:06:21.358Z\",\n    \"url\": {\n      \"original\": \"https://api.vastuugroup.fi/tarkastaja/v1.1/attachment/8eafe507-7aa1-4202-a4ae-0e7326f34245\",\n      \"preview\": \"https://api.vastuugroup.fi/tarkastaja/v1.1/attachment/b3410347-9dbb-4b45-b73e-c445ceaae3fa\",\n      \"thumbnail\": \"https://api.vastuugroup.fi/tarkastaja/v1.1/attachment/3aa9f49a-66d2-42d8-bdbe-e2dc06a1f118\"\n    }\n  }\n]\n```"}},"/tarkastaja/v1.1/competence_types":{"get":{"tags":["Tarkastaja API v1.1"],"summary":"Return all competence type definitions","operationId":"tarkastaja_competence_types_tarkastaja_v1_1_competence_types_get","security":[{"HTTPBearer":["tarkastaja/employment_get"]}],"parameters":[{"name":"customer-identifier","in":"header","required":false,"schema":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"description":"Optional customer identifier, if applicable","title":"Customer-Identifier"},"description":"Optional customer identifier, if applicable"}],"responses":{"200":{"description":"Competence types","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CompetenceType"},"title":"Response Get Competence Types Tarkastaja V1 1 Competence Types Get"}}}},"403":{"description":"Forbidden","content":{"application/json":{"examples":{"ApiConsumerClosed":{"value":{"detail":"API consumer 00000000-0000-0000-0000-000000000000 is closed and cannot be modified"}},"ErrorDeterminingCustomership":{"value":{"detail":"Error determining customer-identifier customership."}},"NoActiveCustomership":{"value":{"detail":"No active customership for customer-identifier. Customer should contact Vastuu Group support."}},"CustomerIdentifierInvalid":{"value":{"detail":"customer-identifier is invalid or doesn't exist"}},"CustomerIdentifierNotActive":{"value":{"detail":"customer-identifier is not active"}},"ApiConsumerNotRegistered":{"value":{"detail":"API consumer is not registered"}},"LimitedRoleException":{"value":{"detail":"You are not allowed to access requested data for the provided customer-identifier."}},"LimitedCountriesException":{"value":{"detail":"You are not allowed to access the requested data for the provided customer-identifier due to country restrictions."}}},"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"404":{"description":"Not Found","content":{"application/json":{"examples":{"ApiConsumerNotFound":{"value":{"detail":"API consumer not found."}},"CustomerNotFound":{"value":{"detail":"Customer identifier 00000000-0000-0000-0000-000000000000 not found."}}},"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"413":{"description":"Request Entity Too Large","content":{"application/json":{"examples":{"RequestTooLarge":{"value":{"detail":"Request exceeds the maximum allowed size."}}},"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"examples":{"RateLimitExceeded":{"value":{"detail":"Too many requests"}}},"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError","properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"}}}}},"description":"Get competence types supported by the system and visible to the requester organization. If `Customer-Identifier` is not specified, only public competence types are returned.\n\n**Required scope:** `tarkastaja/employment_get`"}},"/test-data/v1.0/":{"get":{"tags":["Test Data API v1.0"],"summary":"Fetch Test Data","description":"Fetch a collection of test data objects used for external API testing purposes.\nThis endpoint is available only in test environment.\n\n**The returned test data must be used when testing the available APIs to ensure\nconsistent and valid test results.**\n\n**Required scope**: `test-data/read`","operationId":"readiness_endpoint_test_data_v1_0__get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TestDataResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"examples":{"ApiConsumerClosed":{"value":{"detail":"API consumer 00000000-0000-0000-0000-000000000000 is closed and cannot be modified"}},"ErrorDeterminingCustomership":{"value":{"detail":"Error determining customer-identifier customership."}},"NoActiveCustomership":{"value":{"detail":"No active customership for customer-identifier. Customer should contact Vastuu Group support."}},"CustomerIdentifierInvalid":{"value":{"detail":"customer-identifier is invalid or doesn't exist"}},"CustomerIdentifierNotActive":{"value":{"detail":"customer-identifier is not active"}},"ApiConsumerNotRegistered":{"value":{"detail":"API consumer is not registered"}},"LimitedRoleException":{"value":{"detail":"You are not allowed to access requested data for the provided customer-identifier."}},"LimitedCountriesException":{"value":{"detail":"You are not allowed to access the requested data for the provided customer-identifier due to country restrictions."}}},"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"404":{"description":"Not Found","content":{"application/json":{"examples":{"ApiConsumerNotFound":{"value":{"detail":"API consumer not found."}},"CustomerNotFound":{"value":{"detail":"Customer identifier 00000000-0000-0000-0000-000000000000 not found."}}},"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"413":{"description":"Request Entity Too Large","content":{"application/json":{"examples":{"RequestTooLarge":{"value":{"detail":"Request exceeds the maximum allowed size."}}},"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"examples":{"RateLimitExceeded":{"value":{"detail":"Too many requests"}}},"schema":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}}}}},"security":[{"HTTPBearer":["test-data/read"]}]}}},"components":{"schemas":{"ActiveLicense":{"properties":{"product_family_id":{"$ref":"#/components/schemas/ProductFamilyId","description":"Identifier for the product family","examples":["Valvoja"]},"product_family_name":{"$ref":"#/components/schemas/ProductFamilyName","description":"Name of the product family","examples":["Valvoja"]},"product_name":{"type":"string","title":"Product Name","description":"Name of the product","examples":["Valvoja Lite Max 50"]},"usage_amount":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Usage Amount","description":"Amount of usage for this license tier","examples":["14"]},"usage_tier_cap":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Usage Tier Cap","description":"Maximum allowed usage for this license tier","examples":["50"]},"start_date":{"type":"string","title":"Start Date","description":"Start date and time of the usage period","examples":["2024-12-16T13:44:48Z"]},"end_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"End Date","description":"End date and time of the usage period","examples":[null]},"billing_period_start_date":{"type":"string","title":"Billing Period Start Date","description":"Start date and time of the billing period","examples":["2024-12-16T13:44:48Z"]},"billing_period_end_date":{"type":"string","title":"Billing Period End Date","description":"End date and time of the billing period","examples":["2025-12-16T13:44:48Z"]},"applicable_services":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Applicable Services","description":"List of services that this license applies to","examples":[["luotettavakumppani"]]}},"type":"object","required":["product_family_id","product_family_name","product_name","usage_amount","usage_tier_cap","start_date","end_date","billing_period_start_date","billing_period_end_date","applicable_services"],"title":"ActiveLicense"},"ApiConsumerOut":{"properties":{"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"},"closed_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Closed At"},"api_consumer_id":{"type":"string","format":"uuid","title":"Api Consumer Id"},"application_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Application Name"},"client_id":{"type":"string","title":"Client Id"},"organization_name":{"type":"string","title":"Organization Name"},"organization_identifiers":{"items":{"$ref":"#/components/schemas/CompanyIdentifierOut"},"type":"array","title":"Organization Identifiers"},"role":{"items":{"$ref":"#/components/schemas/ApiConsumerRole"},"type":"array","title":"Role"},"status":{"$ref":"#/components/schemas/ApiConsumerStatus"}},"type":"object","required":["created_at","updated_at","closed_at","api_consumer_id","client_id","organization_name","organization_identifiers","role","status"],"title":"ApiConsumerOut"},"ApiConsumerRole":{"type":"string","enum":["application_partner","application_partner_sepo_hidden","customer","trainer_partner","internal"],"title":"ApiConsumerRole"},"ApiConsumerStatus":{"type":"string","enum":["active","inactive","closed"],"title":"ApiConsumerStatus"},"CardIdTypeEnum":{"type":"string","enum":["card_barcode","card_uid"],"title":"CardIdTypeEnum"},"CertificateLangEnum":{"type":"string","enum":["fi","en","se"],"title":"CertificateLangEnum"},"CompanyIdentifierOut":{"properties":{"organization_identifier":{"type":"string","title":"Organization Identifier"},"organization_identifier_country":{"type":"string","title":"Organization Identifier Country"},"organization_identifier_type":{"type":"string","title":"Organization Identifier Type"}},"type":"object","required":["organization_identifier","organization_identifier_country","organization_identifier_type"],"title":"CompanyIdentifierOut"},"CreateBody":{"properties":{"valid_from":{"type":"string","format":"date","title":"Valid From","description":"A date string in YYYY-MM-DD format","examples":["2025-01-01"]},"valid_until":{"type":"string","format":"date","title":"Valid Until","description":"A date string in YYYY-MM-DD format","examples":["2026-01-01"]},"competence_type":{"type":"string","title":"Competence Type","description":"Reference to competence_type resource","examples":["CT-FIEAH-H"]},"first_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"First Name","description":"First name of the person for whom this competence is being added. Required if id-type is birthdate-name."},"last_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Last Name","description":"Last name of the person for whom this competence is being added. Required if id-type is birthdate-name."}},"type":"object","required":["valid_from","valid_until","competence_type"],"title":"CreateBody"},"CustomerIdentifierOut":{"properties":{"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"},"closed_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Closed At"},"api_consumer_id":{"type":"string","format":"uuid","title":"Api Consumer Id"},"customer_identifier":{"type":"string","format":"uuid","title":"Customer Identifier"},"organization_name":{"type":"string","title":"Organization Name"},"organization_identifiers":{"items":{"$ref":"#/components/schemas/CompanyIdentifierOut"},"type":"array","title":"Organization Identifiers"},"status":{"$ref":"#/components/schemas/CustomerStatus"},"first_used_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"First Used At","description":"Indicates when customer identifier was first taken into use.This field is set only once, on the initial usage event."},"licenses":{"anyOf":[{"items":{"$ref":"#/components/schemas/ActiveLicense"},"type":"array"},{"type":"null"}],"title":"Licenses"},"api_consumer":{"$ref":"#/components/schemas/ApiConsumerOut"}},"type":"object","required":["created_at","updated_at","closed_at","api_consumer_id","customer_identifier","organization_name","organization_identifiers","status","first_used_at","api_consumer"],"title":"CustomerIdentifierOut"},"CustomerIdentifierWithoutApiConsumerOut":{"properties":{"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"},"closed_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Closed At"},"api_consumer_id":{"type":"string","format":"uuid","title":"Api Consumer Id"},"customer_identifier":{"type":"string","format":"uuid","title":"Customer Identifier"},"organization_name":{"type":"string","title":"Organization Name"},"organization_identifiers":{"items":{"$ref":"#/components/schemas/CompanyIdentifierOut"},"type":"array","title":"Organization Identifiers"},"status":{"$ref":"#/components/schemas/CustomerStatus"},"first_used_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"First Used At","description":"Indicates when customer identifier was first taken into use.This field is set only once, on the initial usage event."},"licenses":{"anyOf":[{"items":{"$ref":"#/components/schemas/ActiveLicense"},"type":"array"},{"type":"null"}],"title":"Licenses"}},"type":"object","required":["created_at","updated_at","closed_at","api_consumer_id","customer_identifier","organization_name","organization_identifiers","status","first_used_at"],"title":"CustomerIdentifierWithoutApiConsumerOut"},"CustomerIdentifiersOut":{"properties":{"limit":{"type":"integer","title":"Limit"},"offset":{"type":"integer","title":"Offset"},"next_offset":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Next Offset"},"api_consumer":{"$ref":"#/components/schemas/ApiConsumerOut"},"customer_identifiers":{"items":{"$ref":"#/components/schemas/CustomerIdentifierWithoutApiConsumerOut"},"type":"array","title":"Customer Identifiers"}},"type":"object","required":["limit","offset","next_offset","api_consumer","customer_identifiers"],"title":"CustomerIdentifiersOut"},"CustomerStatus":{"type":"string","enum":["active","closed"],"title":"CustomerStatus"},"DeleteBody":{"properties":{"id_values":{"items":{"type":"string"},"type":"array","title":"Id Values","description":"Declares which competences are to be deleted","examples":[["XXXX-XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-XXXXXXXX"]]},"id_type":{"type":"string","title":"Id Type","description":"Declares which resource type is to be deleted","examples":["competence-id"]},"operation":{"type":"string","title":"Operation","description":"Declares how the competence is to be removed","examples":["delete"]}},"type":"object","required":["id_values","id_type","operation"],"title":"DeleteBody"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ItemsEnum":{"type":"string","enum":["tax_number"],"title":"ItemsEnum"},"OrderBy":{"type":"string","enum":["created_at_asc","created_at_desc"],"title":"OrderBy"},"OrgIdTypeEnum":{"type":"string","enum":["registration_number","vat_number"],"title":"OrgIdTypeEnum"},"OrganizationPermissionInformationBody":{"properties":{"org_id":{"type":"string","title":"Org Id","description":"Government id of the organization","examples":["2327327-1"]},"org_id_type":{"type":"string","enum":["registration_number","vat_number"],"title":"Org Id Type","description":"Type of the organization id"},"org_id_country":{"type":"string","pattern":"^[A-Z]{2}$","title":"Org Id Country","description":"Country of the organization id","examples":["FI"]}},"type":"object","required":["org_id","org_id_type","org_id_country"],"title":"OrganizationPermissionInformationBody"},"ProductFamilyId":{"type":"string","enum":["Valvoja","ValttiPlusTarkastajaAPI"],"title":"ProductFamilyId"},"ProductFamilyName":{"type":"string","enum":["Valvoja","Valtti+ Tarkastaja API"],"title":"ProductFamilyName"},"TestCompany":{"properties":{"business_id":{"type":"string","title":"Business Id","description":"Test company business id"},"company_name":{"type":"string","title":"Company Name","description":"Test company name"},"country":{"type":"string","title":"Country","description":"Test company country code"},"note":{"type":"string","title":"Note","description":"Test company note"}},"type":"object","required":["business_id","company_name","country","note"],"title":"TestCompany"},"TestDataResponse":{"properties":{"persons":{"items":{"$ref":"#/components/schemas/TestPerson"},"type":"array","title":"Persons","description":"List of test persons"},"companies":{"items":{"$ref":"#/components/schemas/TestCompany"},"type":"array","title":"Companies","description":"List of test companies"}},"type":"object","required":["persons","companies"],"title":"TestDataResponse"},"TestEmployment":{"properties":{"business_ids":{"items":{"type":"string"},"type":"array","title":"Business Ids","description":"List of test companies business ids"},"status":{"type":"string","title":"Status","description":"Employment status"},"note":{"type":"string","title":"Note","description":"Employment note"},"valtti_cards":{"items":{"$ref":"#/components/schemas/TestValttiCard"},"type":"array","title":"Valtti Cards","description":"List of test Valtti cards"}},"type":"object","required":["business_ids","status","note","valtti_cards"],"title":"TestEmployment"},"TestPerson":{"properties":{"first_name":{"type":"string","title":"First Name","description":"Test person first name"},"surname":{"type":"string","title":"Surname","description":"Test person surname"},"tax_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Tax Number","description":"Test person tax number"},"ssn":{"type":"string","title":"Ssn","description":"Test person ssn"},"country":{"type":"string","title":"Country","description":"Test person country code"},"note":{"type":"string","title":"Note","description":"Test person note"},"employments":{"items":{"$ref":"#/components/schemas/TestEmployment"},"type":"array","title":"Employments","description":"List of employments"}},"type":"object","required":["first_name","surname","tax_number","ssn","country","note","employments"],"title":"TestPerson"},"TestValttiCard":{"properties":{"barcode":{"type":"string","title":"Barcode","description":"Test Valtti card barcode"},"uid":{"type":"string","title":"Uid","description":"Test Valtti card uid"},"status":{"type":"string","title":"Status","description":"Test Valtti card status"},"note":{"type":"string","title":"Note","description":"Test Valtti card note"}},"type":"object","required":["barcode","uid","status","note"],"title":"TestValttiCard"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"routers__competence_input__CountryEnum":{"type":"string","enum":["FI","EE","SE"],"title":"CountryEnum"},"routers__competence_input__IdTypeEnum":{"type":"string","enum":["ssn","tax_number","card_barcode","card_uid","birthdate_name"],"title":"IdTypeEnum"},"routers__luotettavakumppani_1_1__CountryEnum":{"type":"string","enum":["fi","ee"],"title":"CountryEnum"},"routers__personapi_1_2__CountryEnum":{"type":"string","enum":["fi","FI","se","SE"],"title":"CountryEnum"},"routers__personapi_1_2__IdTypeEnum":{"type":"string","enum":["ssn","tax_number","card_barcode","card_uid"],"title":"IdTypeEnum"},"ConflictError":{"type":"object","description":"HTTP 409 error response. This always indicates a misconfiguration in the system.","properties":{"error":{"type":"string","description":"Error code.","enum":["Conflict"]},"message":{"description":"Description indicating why the request was invalid.","type":"string"}},"required":["message","error"]},"BadRequestError":{"type":"object","description":"HTTP 400 error response","properties":{"error":{"type":"string","description":"Error code.","enum":["SchemaError","InvalidLengthError","InvalidFormatError","InvalidChecksumError","InvalidComponentError","UnsupportedCountry","InvalidBirthDate"]},"message":{"description":"Description indicating why the request was invalid.","type":"string"}},"required":["message","error"]},"UnauthorizedError":{"type":"object","description":"HTTP 401 error response.","properties":{"error":{"type":"string","description":"Error code.","enum":["ScopeError"]},"message":{"type":"string","description":"Description why the authorization failed."}},"required":["message","error"]},"ForbiddenError":{"type":"object","description":"HTTP 403 error response for forbidden access.","properties":{"error":{"type":"string","description":"Error code.","enum":["ForbiddenError"]},"message":{"type":"string","description":"Description why the request is forbidden."}},"required":["message","error"]},"NotFoundError":{"type":"object","description":"HTTP 404 error response.","properties":{"error":{"type":"string","description":"Error code.","enum":["PersonMissing","CompetenceTypeMissing","ClientMissing","OrganisationMissing","CompetenceMissing"]},"message":{"type":"string","description":"Description for what was not found."}},"required":["error","message"]},"CompetenceNotFound":{"type":"object","description":"HTTP 400 error response.","properties":{"error":{"type":"string","description":"Error code.","enum":["CompetenceNotFound"]},"message":{"type":"string","description":"Description for the competence that was not found."}},"required":["error","message"]},"DeleteFailed":{"type":"object","description":"HTTP 400 error response.","properties":{"error":{"type":"string","description":"Error code.","enum":["DeleteFailed","CompetenceNotFound"]},"message":{"type":"string","description":"Description why the delete failed."}},"required":["error","message"]},"Competence":{"type":"object","required":["competence_type_id","created_date","granted_by_org_id","id","type","valid_from_date","valid_until_date"],"properties":{"competence_type_id":{"type":"string","description":"Competence type resource ID","example":"CT-1234"},"created_date":{"type":"string","nullable":true,"description":"UTC timestamp for the competence creation."},"granted_by_org_id":{"type":"string","description":"Id of organisation certifying the competence."},"id":{"type":"string","description":"Competence resource ID","example":"367e-78c7f25c7ba0f994b753c6f7d083738d-c8405388"},"type":{"type":"string","enum":["competence"],"description":"Always \"competence\"."},"valid_from_date":{"nullable":true,"type":"string","description":"Date from which the certification is valid."},"valid_until_date":{"nullable":true,"type":"string","description":"Date until which the certification is valid."}}},"InputCompetence":{"type":"object","properties":{"competence_card_id":{"type":"string","nullable":true,"description":"Id of the card proving the certification, as recorded on the card."},"valid_from":{"nullable":true,"type":"string","format":"date","description":"A UTC date.","example":"2015-10-10"},"valid_until":{"nullable":true,"type":"string","format":"date","description":"A UTC date."},"competence_type":{"type":"string","description":"Reference to competence_type resource, like \"CT-1234\"."}},"required":["valid_from","valid_until","competence_type","competence_card_id"]},"DeleteCompetencesRequest":{"type":"object","properties":{"id-values":{"description":"Declares which competences are to be deleted","type":"array","minItems":1,"maxItems":10,"items":{"type":"string","example":"XXXX-XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-XXXXXXXX"}},"id-type":{"description":"Declares which resource type is to be deleted","type":"string","enum":["competence-id"],"example":"competence-id"},"operation":{"description":"Declares how the competence is to be removed","type":"string","example":"revoke"}},"required":["id-values","id-type","operation"]},"DeletedCompetences":{"type":"object","properties":{"removed_ids":{"type":"array","items":{"type":"string","example":"XXXX-XXXXXXXX-XXXX"}},"failed_removals":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"XXXX-XXXXXXXX-XXXX"},"reason":{"type":"string","example":"Failed to remove competence"}}}}}},"DeleteCompetenceRequest":{"type":"object","properties":{"id-value":{"description":"Declares which competence to delete","type":"string","nullable":true,"example":"XXXX-XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-XXXXXXXX"},"id-type":{"description":"Declares which resource type is to be deleted","type":"string","nullable":true,"enum":["competence-id"],"example":"competence-id"},"operation":{"description":"Declares how the competence is to be removed","nullable":true,"type":"string","example":"revoke"}},"required":["id-value","id-type","operation"]},"DeletedCompetence":{"type":"object","properties":{"removed_competence_id":{"type":"string","example":"XXXX-XXXXXXXX-XXXX"}}},"InputCompetenceOrgId":{"type":"object","properties":{"valid_from":{"nullable":true,"type":"string","format":"date","description":"A UTC date.","example":"2015-10-10"},"valid_until":{"nullable":true,"type":"string","format":"date","description":"A UTC date."},"competence_type":{"type":"string","description":"Reference to competence_type resource. Can be either in qvarn or human readable form."},"competence_type_id_type":{"type":"string","description":"The competence type can be passed either in qvarn or human readable form. This parameter shows which form is used.","enum":["human-readable","qvarn"]},"competence_card_holder_names":{"type":"array","description":"Names as recorded on the card.","items":{"type":"object","properties":{"full_name":{"type":"string","description":"Full name of the competence card holder.","example":"Suomalainen Testaaja"},"sort_key":{"type":"string","nullable":true,"description":"Version of the name used for sorting."},"given_names":{"type":"array","items":{"type":"string"},"nullable":true,"description":"-"},"surnames":{"type":"array","items":{"type":"string"},"nullable":true,"description":"-"}}}}},"required":["competence_type","competence_type_id_type"]},"GetCardResponseOK":{"type":"object","xml":{"name":"GetCardResponse"},"properties":{"xmlns":{"type":"string","xml":{"attribute":true},"example":"http://www.tilaajavastuu.fi/korva.xsd"},"result":{"type":"string","xml":{"attribute":true},"example":"OK"},"Card":{"properties":{"barCodeId":{"description":"Card identifier","type":"string","xml":{"attribute":true},"example":"123456789012"},"uid":{"description":"ID generated by producer","type":"string","xml":{"attribute":true},"example":"1A245V7DA0FDD"},"validUntil":{"description":"Card's validity period","type":"string","xml":{"attribute":true},"example":"2024-12-12T23:00:00.000+02:00"},"Status":{"type":"object","properties":{"status":{"description":"Card's status","type":"string","xml":{"attribute":true},"example":"status"},"modifiedBy":{"description":"Status modifier","type":"string","xml":{"attribute":true},"example":"modifiedBy"},"modifiedDate":{"description":"Date of modification","type":"string","xml":{"attribute":true},"example":"2019-11-08T14:05:39.000+02:00"},"cardVerificationStatus":{"description":"Card verification status","type":"string","enum":["not_eligible","verified","unverified"],"xml":{"attribute":true},"example":"verified"}}},"Person":{"type":"object","properties":{"firstName":{"description":"Person's first name","type":"string","xml":{"attribute":true},"example":"Matti"},"surname":{"description":"Person's surname","type":"string","xml":{"attribute":true},"example":"Meikäläinen"},"taxNumber":{"description":"Person's tax number","type":"string","xml":{"attribute":true},"example":"100011111111"},"birthDay":{"description":"Person's date of birth","type":"string","xml":{"attribute":true},"example":"01.03.1988"}}},"Employer":{"type":"object","properties":{"name":{"description":"Employer's name","type":"string","xml":{"attribute":true},"example":"Vastuu Group Oy"},"businessId":{"description":"Employer's business identity code","type":"string","xml":{"attribute":true},"example":"2327327-1"},"countryCode":{"description":"Employer's business identity country code","type":"string","xml":{"attribute":true},"example":"FI"}}}}}}},"GetCardResponseInvalidRequest":{"type":"object","xml":{"name":"GetCardResponse"},"properties":{"errorText":{"type":"string","xml":{"attribute":true}},"result":{"type":"string","xml":{"attribute":true}},"xmlns":{"type":"string","xml":{"attribute":true}}}},"GetCardResponseNotFound":{"type":"object","xml":{"name":"GetCardResponse"},"properties":{"errorText":{"type":"string","xml":{"attribute":true},"example":"Card not found"},"result":{"type":"string","xml":{"attribute":true},"example":"NotFound"},"xmlns":{"type":"string","xml":{"attribute":true},"example":"http://www.tilaajavastuu.fi/korva.xsd"}}},"FindCardResponseOK":{"type":"object","xml":{"name":"FindCardResponse"},"properties":{"result":{"type":"string","xml":{"attribute":true},"example":"OK"},"xmlns":{"type":"string","xml":{"attribute":true},"example":"http://www.tilaajavastuu.fi/korva.xsd"},"Cards":{"type":"object","properties":{"amount":{"description":"Count how many cards were found","type":"integer","xml":{"attribute":true},"example":1},"Card":{"type":"array","description":"List of cards","items":{"type":"object","properties":{"uid":{"description":"ID generated by producer","type":"string","xml":{"attribute":true},"example":"04B79917030180"},"Status":{"type":"object","properties":{"status":{"description":"Card's status","type":"string","enum":["Closed","Expired"],"xml":{"attribute":true},"example":"Closed"},"modifiedDate":{"description":"Date of modification","type":"string","format":"date-time","xml":{"attribute":true},"example":"2024-12-04T00:00:05.000+02:00"},"cardVerificationStatus":{"description":"Card verification status","type":"string","enum":["not_eligible","verified","unverified"],"xml":{"attribute":true},"example":"unverified"}}}}}}}}}},"FindCardResponseInvalidRequest":{"type":"object","xml":{"name":"FindCardResponse"},"properties":{"result":{"type":"string","xml":{"attribute":true},"example":"InvalidRequest"},"xmlns":{"type":"string","xml":{"attribute":true},"example":"http://www.tilaajavastuu.fi/korva.xsd"}}},"BusinessId":{"type":"string","description":"Business id for a company","example":"2327327-1"},"TaxBasicReg":{"type":"object","properties":{"interpretation":{"type":"string","enum":["GREEN","BLUE","GREY","YELLOW","RED"],"description":"Interpretation:\n * `GREEN` - OK\n * `BLUE` - Attention (Huomioi)\n * `GREY` - Information pending (Odotetaan tietoja)\n * `YELLOW` - Investigate (Selvitä)\n * `RED` - STOP\n"},"status":{"type":"string","description":"Register information\n  * `Rekisterissä` - In register\n  * `Ei rekisterissä` - Not in register\n"},"remark":{"type":"string","description":"Additional remark providing context for the register status"},"registration_start_date":{"type":"string","format":"date"}},"required":["interpretation"]},"VatReg":{"type":"object","description":"Value added tax register information","properties":{"registration_start_date":{"type":"string","format":"date","example":"2010-05-01"},"status":{"type":"string","description":"Register information\n  * `Rekisterissä` - In register\n  * `Ei rekisterissä` - Not in register\n"},"type":{"type":"string","description":"Value added tax descriptions:\n  * `Yritys on alv-velvollinen liiketoiminnasta` -\n  * `Yritys on alv-velvollinen kiinteistön käyttöoikeuden luovuttamisesta` -\n  * `Yritys on alv-velvollinen alkutuottajana ja/tai kuvataiteilijana` - \n  * `Yritys on alv-velvollinen liiketoiminnasta vastuuryhmän jäsenenä` - \n  * `Yritys on alv-velvollinen ulkomaalaisena` - \n  * `Yritys on alv-velvollinen ostajana tai omasta käytöstä` - \n  * `Yritys on alv-velvollinen porotaloudesta` - \n  * `Yritys on alv-velvollinen paliskunnan osakkaana` - \n  * `Yritys on EU-palvelumyynneistä alv-ilmoituksenantovelvollinen` - \n  * `Yritys on alv-velvollinen taide-esineen myynnistä tai tekijänä` -\n","example":"Liiketoiminnasta arvonlisäverovelvollinen"}}},"VatRegInfo":{"type":"object","properties":{"interpretation":{"type":"string","enum":["GREEN","BLUE","GREY","YELLOW","RED"],"description":"Interpretation:\n * `GREEN` - OK\n * `BLUE` - Attention (Huomioi)\n * `GREY` - Information pending (Odotetaan tietoja)\n * `YELLOW` - Investigate (Selvitä)\n * `RED` - STOP\n"},"status":{"type":"string","description":"Register information\n  * `Rekisterissä` - In register\n  * `Ei rekisterissä` - Not in register\n"},"vat_number":{"type":"string","example":"FI23273271"},"vat_regs":{"type":"array","items":{"$ref":"#/components/schemas/VatReg"}}},"required":["interpretation","vat_regs"]},"PrePaymentReg":{"type":"object","properties":{"interpretation":{"type":"string","enum":["GREEN","BLUE","GREY","YELLOW","RED"],"description":"Interpretation:\n * `GREEN` - OK\n * `BLUE` - Attention (Huomioi)\n * `GREY` - Information pending (Odotetaan tietoja)\n * `YELLOW` - Investigate (Selvitä)\n * `RED` - STOP\n"},"status":{"type":"string"},"remark":{"type":"string","description":"Additional remark providing context for the register status"},"registration_start_date":{"type":"string","format":"date"}},"required":["interpretation"]},"TradeReg":{"type":"object","properties":{"interpretation":{"type":"string","enum":["GREEN","BLUE","GREY","YELLOW","RED"],"description":"Interpretation:\n * `GREEN` - OK\n * `BLUE` - Attention (Huomioi)\n * `GREY` - Information pending (Odotetaan tietoja)\n * `YELLOW` - Investigate (Selvitä)\n * `RED` - STOP\n"},"status":{"type":"string","description":"Register information\n  * `Rekisterissä` - In register\n  * `Ei rekisterissä` - Not in register\n"},"remark":{"type":"string","description":"Additional remark providing context for the register status"},"registration_start_date":{"type":"string","format":"date"}},"required":["interpretation"]},"EmployerReg":{"type":"object","properties":{"interpretation":{"type":"string","enum":["GREEN","BLUE","GREY","YELLOW","RED"],"description":"Interpretation:\n * `GREEN` - OK\n * `BLUE` - Attention (Huomioi)\n * `GREY` - Information pending (Odotetaan tietoja)\n * `YELLOW` - Investigate (Selvitä)\n * `RED` - STOP\n"},"status":{"type":"string","description":"Register information\n  * `Rekisterissä` - In register\n  * `Ei rekisterissä` - Not in register\n"},"remark":{"type":"string","description":"Additional remark providing context for the register status","example":"Ei palkattua työvoimaa. Ei velvollisuutta kuulua Työnantajarekisteriin."},"registration_start_date":{"type":"string","format":"date"}},"required":["interpretation"]},"Bis":{"type":"object","properties":{"source":{"type":"string","example":"Suomen Asiakastieto Oy"},"updated":{"type":"string","format":"date","example":"2023-07-18"},"interpretation":{"type":"string","enum":["GREEN","BLUE","GREY","YELLOW","RED"],"description":"Interpretation:\n * `GREEN` - OK\n * `BLUE` - Attention (Huomioi)\n * `GREY` - Information pending (Odotetaan tietoja)\n * `YELLOW` - Investigate (Selvitä)\n * `RED` - STOP\n"},"tax_basic_reg":{"$ref":"#/components/schemas/TaxBasicReg"},"vat_reg_info":{"$ref":"#/components/schemas/VatRegInfo"},"prepayment_reg":{"$ref":"#/components/schemas/PrePaymentReg"},"trade_reg":{"$ref":"#/components/schemas/TradeReg"},"employer_reg":{"$ref":"#/components/schemas/EmployerReg"}},"required":["tax_basic_reg","vat_reg_info","prepayment_reg","trade_reg","employer_reg"]},"Person":{"type":"object","properties":{"source":{"type":"string","example":"Suomen Asiakastieto Oy"},"birthdate":{"type":"string","format":"date","example":"2000-01-01"},"role":{"type":"string","example":"Toimitusjohtaja"},"surname":{"type":"string","example":"Meikäläinen"},"forename":{"type":"string","example":"Matti"}},"required":["role","surname","forename"]},"CompanyRelations":{"type":"object","properties":{"interpretation":{"type":"string","enum":["GREEN","BLUE","GREY","YELLOW","RED"],"description":"Interpretation:\n * `GREEN` - OK\n * `BLUE` - Attention (Huomioi)\n * `GREY` - Information pending (Odotetaan tietoja)\n * `YELLOW` - Investigate (Selvitä)\n * `RED` - STOP\n"},"status":{"type":"string","example":"Ei liiketoimintakieltoja","description":"Status:\n * `Ei liiketoimintakieltoja` - No business prohibition\n * `Liiketoimintakielto` - Some key person(s) have business prohibition\n"},"persons":{"type":"array","items":{"$ref":"#/components/schemas/Person"}}},"required":["interpretation","persons"]},"Tax":{"type":"object","description":"Common remarks used in the tax-element. \n\n* No remark element \n * Maksamattomia veroja. \n * Verojen maksutiedot eivät ole vielä saatavilla. \n * Verojen maksutiedot tilaajavastuulain tarkoittamalla tavalla kunnossa (maksujärjestely voimassa). \n * Yrityssaneerausohjelma tai muu tuomioistuimen vahvistama velkajärjestely voimassa, katso kaupparekisteriote. \n * Yrityksellä on muutoksenhausta johtuva perintäkielto voimassa. \n * Yrityksen erääntyneet verovelat ovat perintäkiellossa. Tuomioistuin on päättänyt joko 1. yrityssaneeraushakemukseen liittyvästä väliaikaisesta perintäkiellosta tai 2. tuomioistuin on päättänyt varhaisen tai perusmuotoisen yrityssaneerausmenettelyn aloittamisesta. Saneerausohjelmaa ei ole vielä vahvistettu tuomioistuimessa. \n * Yrityssaneerausohjelma tai muu tuomioistuimen vahvistama velkajärjestely voimassa, katso kaupparekisteriote. Yrityksellä on maksamattomia veroja. \n * Järjestämätöntä verovelkaa 500 - 10 000 euroa. Yritystä ei ole merkitty julkiseen verovelkarekisteriin verovelkojen vuoksi. \n * Yrityssaneerausohjelma tai muu tuomioistuimen vahvistama velkajärjestely voimassa, katso kaupparekisteriote. Järjestämätöntä verovelkaa 500 - 10 000 euroa. Yritystä ei ole merkitty julkiseen verovelkarekisteriin verovelkojen vuoksi. \n * Yrityssaneerausohjelma tai muu tuomioistuimen vahvistama velkajärjestely voimassa, katso kaupparekisteriote. Yrityksellä on maksuohjelman ulkopuolista verovelkaa yli 10 000 euroa, mutta siitä on maksuohjelma. \n * Yritys on merkitty julkiseen verovelkarekisteriin. Yrityksen erääntyneet verovelat ovat perintäkiellossa. Tuomioistuin on päättänyt joko 1. yrityssaneeraushakemukseen liittyvästä väliaikaisesta perintäkiellosta tai 2. tuomioistuin on päättänyt varhaisen tai perusmuotoisen yrityssaneerausmenettelyn aloittamisesta. Saneerausohjelmaa ei ole vielä vahvistettu tuomioistuimessa. \n \n Common descriptions used in the tax-element. \n\n* No description \n * Yritys on merkitty julkiseen verovelkarekisteriin. Tuomioistuin on päättänyt joko 1. yrityssaneeraushakemukseen liittyvästä väliaikaisesta perintäkiellosta tai 2. varhaisen tai perusmuotoisen yrityssaneerausmenettelyn aloittamisesta. Tarkista raportin veromaksutiedot ja pyydä sopimuskumppanilta lisäselvitystä tilanteesta.","properties":{"interpretation":{"type":"string","enum":["GREEN","BLUE","GREY","YELLOW","RED"],"description":"Interpretation: * `GREEN` - OK * `BLUE` - Attention (Huomioi) * `GREY` - Information pending (Odotetaan tietoja) * `YELLOW` - Investigate (Selvitä) * `RED` - STOP\n"},"status":{"type":"string","description":"Payment information:\n  * `Odotetaan tietoja` - Waiting for information\n  * `Maksettu` - Paid\n  * `Maksamatta` - Unpaid\n  * `Yrityssaneerausohjelma/velkäjärjestely hyväksytty` - Debt restructuring accepted\n  * `Perintäkielto` - Collection ban\n  * `Perintäkielto, saneerausmenettely` - Collection ban, restructuring procedure\n  * `Yrityssaneerausohjelma hyväksytty, Maksamattomia uusia` - Restructuring accepted, new unpaid taxes\n  * `Pientä verovelkaa (500-10 000 e)` - Small tax debt (500-10 000 e)\n  * `Yrityssaneerausohjelma hyväksytty, Maksamattomia uusia yli 10 000 euroa ja niistä maksusuunnitelma.` - Restructuring accepted, new unpaid taxes over 10 000 euros with payment plan\n  * `Perintäkielto, saneerausmenettely, merkintä verovelkarekisterissä` - Collection ban, restructuring procedure, entry in tax debt registry\n","example":"Maksettu"},"source":{"type":"string","example":"Verohallinto"},"remark":{"type":"string","description":"Additional remark","example":"Maksamattomia veroja."},"description":{"type":"string","description":"Additional description","example":"Yritys on merkitty julkiseen verovelkarekisteriin. Tuomioistuin on päättänyt joko 1. yrityssaneeraushakemukseen liittyvästä väliaikaisesta perintäkiellosta tai 2. varhaisen tai perusmuotoisen yrityssaneerausmenettelyn aloittamisesta. Tarkista raportin veromaksutiedot ja pyydä sopimuskumppanilta lisäselvitystä tilanteesta."},"updated":{"type":"string","format":"date","example":"2023-06-26"}},"required":["interpretation"]},"PensionInsurance":{"type":"object","properties":{"source":{"type":"string","example":"Eläkevakuutusyhtiö"},"updated":{"type":"string","format":"date","example":"2023-06-29"},"status":{"type":"string","description":"Payment information:\n  * `Odotetaan tietoja` -  Waiting for information\n  * `Maksettu` - Paid\n  * `Maksamatta` - Unpaid\n  * `Yrityssaneerausohjelma/velkäjärjestely hyväksytty` - Debt restructuring accepted\n  * `Maksujärjestely` - Payment arrangement\n  * `Perintäkielto, saneerausmenettely` - Collection ban, restructuring procedure\n","example":"Maksettu"}},"required":["source","updated"]},"PensionInsurances":{"type":"object","properties":{"interpretation":{"type":"string","enum":["GREEN","BLUE","GREY","YELLOW","RED"],"description":"Interpretation: * `GREEN` - OK * `BLUE` - Attention (Huomioi) * `GREY` - Information pending (Odotetaan tietoja) * `YELLOW` - Investigate (Selvitä) * `RED` - STOP\n"},"status":{"type":"string","description":"Payment information:\n  * `Odotetaan tietoja` -  Waiting for information\n  * `Maksettu` - Paid\n  * `Maksamatta` - Unpaid\n  * `Yrityssaneerausohjelma/velkäjärjestely hyväksytty` - Debt restructuring accepted\n  * `Maksujärjestely` - Payment arrangement\n  * `Perintäkielto, saneerausmenettely` - Collection ban, restructuring procedure\n  * `Ei ilmoitettu` - Not reported\n","example":"Maksamatta"},"remark":{"type":"string","description":"Additional remark","example":"Yrityksellä on maksamattomia eläkevakuutusmaksuja."},"insurances":{"type":"array","items":{"$ref":"#/components/schemas/PensionInsurance"}}},"required":["interpretation","insurances"]},"EntrepreneurInsurances":{"type":"object","properties":{"interpretation":{"type":"string","enum":["GREEN","BLUE","GREY","YELLOW","RED"],"description":"Interpretation: * `GREEN` - OK * `BLUE` - Attention (Huomioi) * `GREY` - Information pending (Odotetaan tietoja) * `YELLOW` - Investigate (Selvitä) * `RED` - STOP\n"},"status":{"type":"string","description":"Status of the notification:\n  * `Ilmoitettu` - Reported\n  * `Ei ilmoitettu` - Not reported\n","example":"Ei ilmoitettu"},"description":{"type":"string","example":"Ei enää pakollinen tieto"}},"required":["interpretation"]},"CollectiveAgreement":{"type":"object","properties":{"name":{"type":"string","example":"TIETOTEKNIIKAN PALVELUALAN TYÖEHTOSOPIMUS"},"source":{"type":"string","example":"Yrityksen ilmoittama"}},"required":["name","source"]},"CollectiveAgreements":{"type":"object","properties":{"interpretation":{"type":"string","enum":["GREEN","BLUE","GREY","YELLOW","RED"],"description":"Interpretation:\n * `GREEN` - OK\n * `BLUE` - Attention (Huomioi)\n * `GREY` - Information pending (Odotetaan tietoja)\n * `YELLOW` - Investigate (Selvitä)\n * `RED` - STOP\n"},"status":{"type":"string","description":"Status of the notification:\n  * `Ilmoitettu` - Reported\n  * `Ei ilmoitettu` - Not reported\n","example":"Ilmoitettu"},"agreements":{"type":"array","items":{"$ref":"#/components/schemas/CollectiveAgreement"}}},"required":["interpretation","agreements"]},"AccidentInsurance":{"type":"object","properties":{"date_of_issue":{"type":"string","format":"date","example":"2023-06-08"},"insurer":{"type":"string","example":"LähiTapiola"},"source":{"type":"string","example":"Vakuutusyhtiö"},"status":{"type":"string","description":"Status of the notification:\n  * `Ilmoitettu` - Reported\n  * `Ei ilmoitettu` - Not reported\n","example":"Ilmoitettu"},"type":{"type":"string","description":"Possible types:\n  * `Lakisääteinen tapaturmavakuutus` - Statutory accident insurance \n  * `Vapaaehtoinen tapaturmavakuutus` - Voluntary accident insurance\n  * `Yrittäjän tapaturmavakuutus` - Entrepreneur accident insurance\n","example":"Lakisääteinen"}},"required":["date_of_issue","insurer","source","type"]},"AccidentInsurances":{"type":"object","properties":{"interpretation":{"type":"string","enum":["GREEN","BLUE","GREY","YELLOW","RED"],"description":"Interpretation:\n * `GREEN` - OK\n * `BLUE` - Attention (Huomioi)\n * `GREY` - Information pending (Odotetaan tietoja)\n * `YELLOW` - Investigate (Selvitä)\n * `RED` - STOP\n"},"status":{"type":"string","description":"Status of the notification:\n  * `Ilmoitettu` - Reported\n  * `Ei ilmoitettu` - Not reported\n","example":"Ilmoitettu"},"remark":{"type":"string","example":"Tapaturmavakuutus on otettu ja voimassa."},"insurances":{"type":"array","items":{"$ref":"#/components/schemas/AccidentInsurance"}}},"required":["interpretation","insurances"]},"RegisterExtract":{"type":"object","properties":{"source":{"type":"string","example":"PRH"},"type":{"type":"string","description":"Extract type:\n  * `Kaupparekisteri` - Trade register\n  * `Säätiörekisteri` - Trust register\n  * `Yhdistysrekisteri` - Union register\n","example":"Kaupparekisteri"},"updated":{"type":"string","format":"date","example":"2023-06-24"},"status":{"type":"string","description":"* `Kunnossa` - Ok * `Puuttuu` - Missing\n","example":"Kunnossa"},"text":{"type":"string","description":"Register extract in text format"}},"required":["source","type","text"]},"RegisterInformation":{"type":"object","properties":{"interpretation":{"type":"string","enum":["GREEN","BLUE","GREY","YELLOW","RED"],"description":"Interpretation:\n * `GREEN` - OK\n * `BLUE` - Attention (Huomioi)\n * `GREY` - Information pending (Odotetaan tietoja)\n * `YELLOW` - Investigate (Selvitä)\n * `RED` - STOP\n"},"status":{"type":"string","description":"* `Kunnossa` - Ok * `Puuttuu` - Missing\n","example":"Kunnossa"},"register_extracts":{"type":"array","items":{"$ref":"#/components/schemas/RegisterExtract"}}},"required":["interpretation","register_extracts"]},"Clreport":{"type":"object","properties":{"main_business":{"type":"string","example":"Langattoman verkon hallinta ja palvelut"},"company_format":{"type":"string","description":"Organization's legal entity type","example":"Osakeyhtiö"},"domicile":{"type":"string","description":"The domicile of an organization","example":"Helsinki"},"activity":{"type":"string","description":"Status of the company\n  * `Voimassa` - Active\n  * `Selvitystilassa` - Liquidation\n  * `Saneerausmenettely` - Restructuring\n  * `Konkurssissa` - Bankrupt\n  * `Lakannut` - Dissolved\n  * `Elinkeinotoiminta päättynyt` - Activity ended\n  * `Toiminta keskeytynyt` - Activity paused\n  * `` - Activity unknown\n","example":"Voimassa"},"country":{"type":"string","description":"Organization's country code","example":"FI"},"registration_number":{"type":"string","description":"Organization's registry number","example":"2327327-1"},"company_name":{"description":"Organization's name","type":"string","example":"Vastuu Group Oy"},"interpretation":{"type":"string","enum":["GREEN","BLUE","GREY","YELLOW","RED"],"description":"Main interpretation of the company according to 'Tilaajavastuulaki':\n * `GREEN` - OK\n * `BLUE` - Attention (Huomioi)\n * `GREY` - Information pending (Odotetaan tietoja)\n * `YELLOW` - Investigate (Selvitä)\n * `RED` - STOP\n"},"bis":{"$ref":"#/components/schemas/Bis"},"company_relations":{"$ref":"#/components/schemas/CompanyRelations"},"tax":{"$ref":"#/components/schemas/Tax"},"pension_insurances":{"$ref":"#/components/schemas/PensionInsurances"},"entrepreneur_insurances":{"$ref":"#/components/schemas/EntrepreneurInsurances"},"collective_agreements":{"$ref":"#/components/schemas/CollectiveAgreements"},"accident_insurances":{"$ref":"#/components/schemas/AccidentInsurances"},"register_information":{"$ref":"#/components/schemas/RegisterInformation"},"liability_insurances":{"$ref":"#/components/schemas/LiabilityInsurances"},"health_cares":{"$ref":"#/components/schemas/HealthCares"},"rala":{"$ref":"#/components/schemas/Rala"},"ratings":{"type":"array","items":{"$ref":"#/components/schemas/Rating"}},"operating_licenses":{"$ref":"#/components/schemas/OperatingLicenses"}},"required":["main_business","company_format","domicile","activity","country","registration_number","company_name","interpretation","bis","company_relations","tax","pension_insurances","entrepreneur_insurances","collective_agreements","accident_insurances","register_information","health_cares","ratings"]},"Clreports":{"type":"object","properties":{"archive_code":{"type":"string","description":"Archive ID of the report","example":"1701938655442"},"valid_until":{"type":"string","format":"date","description":"Report valid until date","example":"2023-07-19"},"valid_from":{"type":"string","format":"date","description":"Report valid from date","example":"2023-07-19"},"created":{"type":"string","format":"date-time","description":"Report creation date","example":"2023-07-19T06:44:12"},"interpretation":{"type":"string","enum":["GREEN","BLUE","GREY","YELLOW","RED"],"description":"Interpretation:\n * `GREEN` - Ok\n * `BLUE` - Attention (Huomioi)\n * `GREY` - Information pending (Odotetaan tietoja)\n * `YELLOW` - Investigate (Selvitä)\n * `RED` - STOP\n"},"description":{"type":"string"},"reports":{"type":"array","items":{"$ref":"#/components/schemas/Clreport"}}},"required":["archive_code","valid_until","valid_from","created","interpretation","description","reports"]},"LiabilityInsurance":{"type":"object","properties":{"amount_insured":{"type":"string","description":"Amount insured or in case of Potilasvakuutus text: 'Lakisääteinen'"},"business_area":{"type":"string","description":"Business area of the insurance"},"date_of_issue":{"type":"string","format":"date"},"insurer":{"type":"string","description":"Name of the insurance company","example":"IF Vahinkovakuutusyhtiö Oy"},"source":{"type":"string"},"status":{"type":"string","description":"Status of the notification:\n  * `Ilmoitettu` - Reported\n  * `Ei ilmoitettu` - Not reported\n","example":"Ilmoitettu"},"valid_from":{"type":"string","format":"date"},"valid_until":{"type":"string","format":"date"},"validity_area":{"type":"string","description":"Validity area in free form text. (Whatever reads in the insurance text)"},"description":{"type":"string"}},"required":["insurer","source"]},"InsuredCompany":{"type":"object","properties":{"company_name":{"type":"string","description":"Organization's name","example":"Vastuu Group Oy"},"country_code":{"type":"string","description":"Organization's country code","example":"FI"},"registration_number":{"type":"string","description":"Organization's registry number","example":"2327327-1"},"liability_insurances":{"type":"array","items":{"$ref":"#/components/schemas/LiabilityInsurance"}}},"required":["company_name","country_code","registration_number","liability_insurances"]},"LiabilityInsurances":{"type":"object","properties":{"created":{"type":"string","format":"date-time"},"status":{"type":"string","description":"Status of the notification:\n  * `Ilmoitettu` - Reported\n  * `Ei ilmoitettu` - Not reported\n","example":"Ilmoitettu"},"insured_companies":{"type":"array","items":{"$ref":"#/components/schemas/InsuredCompany"}}},"required":["archive_code","created","insured_companies"]},"HealthCareProvider":{"type":"object","properties":{"address":{"type":"string","example":"Testikatu 1 00000 Testikaupunki"},"occupational_health_center":{"type":"string","example":"Suomen Terveystalo Oy"},"registered":{"type":"string","format":"date","example":"2017-06-28"},"source":{"type":"string","example":"TV"}},"required":["source"]},"CompanyHealthServices":{"type":"object","properties":{"company_name":{"type":"string","description":"Organization's name","example":"Vastuu Group Oy"},"country_code":{"type":"string","description":"Organization's country code","example":"FI"},"registration_number":{"type":"string","description":"Organization's registry number","example":"2327327-1"},"health_care_providers":{"type":"array","items":{"$ref":"#/components/schemas/HealthCareProvider"}}},"required":["company_name","country_code","registration_number","health_care_providers"]},"HealthCares":{"type":"object","properties":{"interpretation":{"type":"string","enum":["GREEN","BLUE","GREY","YELLOW","RED"],"description":"Interpretation:\n * `GREEN` - OK\n * `BLUE` - Attention (Huomioi)\n * `GREY` - Information pending (Odotetaan tietoja)\n * `YELLOW` - Investigate (Selvitä)\n * `RED` - STOP\n"},"status":{"type":"string","description":"Status of the notification:\n  * `Ilmoitettu` - Reported\n  * `Ei ilmoitettu` - Not reported\n","example":"Ilmoitettu"},"remark":{"type":"string","description":"Additional remark providing context for the health care","example":"Yrityksellä ei ole palkattua työvoimaa."},"created":{"type":"string","format":"date-time","description":"Report creation date","example":"2023-07-19T06:44:12"},"company_health_services":{"type":"array","items":{"$ref":"#/components/schemas/CompanyHealthServices"}}},"required":["interpretation","status","created","company_health_services"]},"Rala":{"type":"object","properties":{"description":{"type":"string","description":"RALA competence and certification info:\n  * `Yritys on RALA-pätevä` - Company is RALA competent\n  * `Yritys ei ole RALA-pätevä` - Company is not RALA competent\n  * `Yritys on RALA-sertifioitu` - Company is RALA certified\n  * `Yritys on RALA-pätevä ja RALA-sertifioitu` - Company is RALA competent and certified\n","example":"Yritys ei ole RALA-pätevä."},"created":{"type":"string","format":"date-time","description":"Report creation date","example":"2023-07-19T06:44:12"}},"required":["description","created"]},"Rating":{"type":"object","properties":{"source":{"type":"string","example":"Suomen Asiakastieto Oy"},"updated":{"type":"string","format":"date-time","example":"2023-10-02T09:54:05"},"description":{"type":"string","description":"Additional description","example":"Luottokelpoinen"},"rated_business_id":{"type":"string","example":"2327327-1"},"type":{"type":"string","description":"Type of rating","example":"Suomen Vahvimmat Hopea"}},"required":["source","updated","description","rated_business_id","type"]},"OperatingLicense":{"type":"object","properties":{"count":{"type":"string","description":"Count of this type of licenses"},"type":{"type":"string","description":"Type of license","example":"Tavaraliikennelupa"}},"required":["count","type"]},"OperatingLicenses":{"type":"object","properties":{"freight":{"type":"boolean"},"public_transport":{"type":"boolean"},"registration_number":{"type":"string"},"source":{"type":"string"},"taxi":{"type":"boolean"},"updated":{"type":"string","format":"date"},"licenses":{"type":"array","items":{"$ref":"#/components/schemas/OperatingLicense"}}},"required":["licenses"]},"ClRegisterInformation":{"type":"object","properties":{"archive_code":{"type":"string","description":"Archive ID of the report","example":"1701938655442"},"created":{"type":"string","format":"date-time"},"version":{"type":"string"},"matching_registration_number":{"type":"string","description":"Organization's registry number, that matches the requested business id","example":"2327327-1"},"clreports":{"$ref":"#/components/schemas/Clreports"}},"required":["archive_code","created","version","matching_registration_number","clreports"]},"CreditRating":{"type":"object","deprecated":true,"description":"DEPRECATED: Credit rating data is no longer available. This field always returns interpretation GREY without scoring. Use the failure_score field for the replacement data. Previously: Credit rating of the company (luottoluokitus in Finnish) with scoring range 0-1000.","properties":{"interpretation":{"type":"string","enum":["GREEN","BLUE","GREY","YELLOW","RED"],"description":"Interpretation:\n * `GREEN` - Excellent\n * `BLUE` - Requires Attention\n * `GREY` - Information pending or missing\n * `YELLOW` - Requires Investigation\n * `RED` - Requires Review\n"},"source":{"type":"string","example":"Dun & Bradstreet Finland Oy"}},"required":["interpretation","source"]},"DebtCollection":{"type":"object","description":"Debt collection classification (perintätieto in Finnish) of the company. Classifications are between 1-5. Classification value of 5 will give RED interpretation as company has significant amount of unpaid debts. Classification value of 4 will give YELLOW interpretation as company has some unpaid debts. Classification values between 1-3 will give GREEN interpretation as company has no substantial unpaid debts. If classification is not available, the value will be 0 with GREY interpretation","properties":{"interpretation":{"type":"string","enum":["GREEN","BLUE","GREY","YELLOW","RED"],"description":"Interpretation:\n * `GREEN` - Excellent\n * `BLUE` - Requires Attention\n * `GREY` - Information pending or missing\n * `YELLOW` - Requires Investigation\n * `RED` - Requires Review\n"},"classification":{"type":"integer","format":"int32"},"source":{"type":"string","example":"Intrum Oy"}},"required":["interpretation","classification","source"]},"FailureScore":{"type":"object","description":"D&B Failure Score classification (konkurssiluokka in Finnish). Predicts the likelihood of a company experiencing financial stress in the next 12 months. Score range is 1-100 (percentile). Failure class is derived from the score: Class 1 (95-100, lowest risk), Class 2 (69-94), Class 3 (34-68), Class 4 (2-33), Class 5 (1, highest risk).","properties":{"interpretation":{"type":"string","enum":["GREEN","GREY","YELLOW","RED"],"description":"Interpretation:\n * `GREEN` - Score 21-100, low bankruptcy risk\n * `YELLOW` - Score 2-20, moderate bankruptcy risk\n * `RED` - Score 1, high bankruptcy risk\n * `GREY` - Score not available (no D&B failure score data for the company). When GREY, `failure_class` and `score` are null. A GREY failure score is treated as \"no data\" and does NOT negatively affect the combined/overall interpretation (see the /interpretations endpoint), but it is still reflected in `finance_classification_sub_interpretation`.\n"},"failure_class":{"type":"integer","format":"int32","description":"Failure class (1-5). Class 1 is lowest risk, Class 5 is highest risk. Null if not available.","nullable":true},"score":{"type":"number","format":"double","description":"Failure score percentile (1-100). Higher is better. Null if not available.","nullable":true},"source":{"type":"string","example":"Dun & Bradstreet Finland Oy"}},"required":["interpretation","source"]},"Classifications":{"type":"object","description":"Finance classifications including credit rating (deprecated, always GREY), failure score, and debt collection.","properties":{"credit_rating":{"$ref":"#/components/schemas/CreditRating"},"failure_score":{"$ref":"#/components/schemas/FailureScore"},"debt_collection":{"$ref":"#/components/schemas/DebtCollection"}},"required":["credit_rating","failure_score","debt_collection"]},"Remark":{"type":"object","description":"A remark (maksuhäiriö in Finnish).","properties":{"code":{"type":"string","description":"Remark code. Actual code descriptions can be fetched using /luotettavakumppani/v1.1/remark_codes -endpoint"},"date":{"type":"string","format":"date-time","description":"Date of the remark","example":"2018-01-16T00:00:00Z"},"amount":{"type":"number","description":"Remark amount in euros","example":1535.11},"creditor_name":{"type":"string","description":"Name of the creditor","example":"Työttömyysvakuutusrahasto"},"source":{"type":"string","description":"Source of the remark","example":"Oikeusrekisterikeskus"},"paid_date":{"type":"string","format":"date-time"},"expires_date":{"type":"string","format":"date-time"},"valid_to_date":{"type":"string","format":"date-time"}},"required":["code","date","amount"]},"Remarks":{"type":"object","description":"Remarks list and interpretation. In case there are remarks, interpretation is YELLOW, otherwise GREEN","properties":{"interpretation":{"type":"string","enum":["GREEN","BLUE","GREY","YELLOW","RED"],"description":"Interpretation:\n * `GREEN` - Excellent\n * `BLUE` - Requires Attention\n * `GREY` - Information pending or missing\n * `YELLOW` - Requires Investigation\n * `RED` - Requires Review\n"},"remarks":{"type":"array","items":{"$ref":"#/components/schemas/Remark"}}},"required":["interpretation","remarks"]},"TaxDebt":{"type":"object","description":"Interpretation of tax debt","properties":{"interpretation":{"type":"string","enum":["GREEN","BLUE","GREY","YELLOW","RED"],"description":"Interpretation:\n * `GREEN` - Excellent\n * `BLUE` - Requires Attention\n * `GREY` - Information pending or missing\n * `YELLOW` - Requires Investigation\n * `RED` - Requires Review\n"}},"required":["interpretation"]},"Sanction":{"type":"object","properties":{"name":{"type":"string","description":"For a person their whole name, for company-wide sanction the company name (or empty)"},"source":{"type":"string","description":"Source of the sanction","example":"EU_GLOBAL"},"provider":{"type":"string","description":"Sanction provider","example":"TRAPETS"},"url_list":{"type":"array","description":"Link to external service that describes the sanction","items":{"type":"string"}},"first_update":{"type":"string","format":"date-time"},"last_update":{"type":"string","format":"date-time"}},"required":["name","source","provider","url_list","externalId","last_update"]},"CompanySanctions":{"type":"object","description":"Company sanctions info. If company has sanctions, interpretation is RED, otherwise GREEN","properties":{"interpretation":{"type":"string","enum":["GREEN","BLUE","GREY","YELLOW","RED"],"description":"Interpretation:\n * `GREEN` - Excellent\n * `BLUE` - Requires Attention\n * `GREY` - Information pending or missing\n * `YELLOW` - Requires Investigation\n * `RED` - Requires Review\n"},"sanctions":{"type":"array","items":{"$ref":"#/components/schemas/Sanction"}}},"required":["interpretation","sanctions"]},"Other":{"type":"object","description":"Other financial interpretation info. Includes information about remarks, tax debt and sanctions","properties":{"remarks":{"$ref":"#/components/schemas/Remarks"},"tax_debt":{"$ref":"#/components/schemas/TaxDebt"},"company_sanctions":{"$ref":"#/components/schemas/CompanySanctions"}},"required":["remarks","tax_debt","company_sanctions"]},"Summary":{"type":"object","description":"Financial summary. Includes information external classifications and other financial interpretations","properties":{"classifications":{"$ref":"#/components/schemas/Classifications"},"other":{"$ref":"#/components/schemas/Other"}},"required":["classifications","other"]},"KeyFigures":{"type":"object","description":"Key figures information","properties":{"turnover":{"type":"integer","format":"int32","description":"Turnover in thousands of Euros"},"change_of_turnover":{"type":"number","description":"Change of turnover in percentages"},"operating_result_pct":{"type":"number","description":"Operating result percentage"},"net_result_pct":{"type":"number","description":"Net result percentage"},"equity_ratio_pct":{"type":"number","description":"Equity ratio percentage"},"gearing":{"type":"number","description":"Gearing"},"quick_ratio":{"type":"number","description":"Quick ratio"},"current_ratio":{"type":"number","description":"Current ratio"},"fiscal_period_end_date":{"type":"string","format":"date-time"},"result_before_closing_entries_and_taxes":{"type":"integer","format":"int32","description":"Result before closing entries and taxes in thousands of Euros"},"fiscal_period_result":{"type":"integer","format":"int32","description":"Fiscal period result before in thousands of Euros"},"operating_result":{"type":"integer","format":"int32","description":"Operating result before in thousands of Euros"},"source":{"type":"string","example":"Dun & Bradstreet Finland Oy"}},"required":["fiscal_period_end_date","source"]},"Finance":{"type":"object","description":"Company finance information. Includes summary with interpretations and key figures history for last available 3 years","properties":{"summary":{"$ref":"#/components/schemas/Summary"},"history":{"type":"array","items":{"$ref":"#/components/schemas/KeyFigures"}}},"required":["summary","history"]},"RpAndClInterpretations":{"type":"object","description":"Includes color coded interpretation of company RP and RP CL combined interpretations. Combined interpretation is a summary of all sub interpretations. I.e. worst sub interpretation is the value of combined interpretation.","properties":{"business_id":{"type":"string"},"cl":{"$ref":"#/components/schemas/ClInterpretation"},"rp":{"$ref":"#/components/schemas/CombinedInterpretation"}},"required":["cl"]},"ClInterpretation":{"type":"object","properties":{"archive_code":{"type":"string","description":"Archive ID of the report","example":"1701938655442"},"interpretation":{"type":"string","enum":["GREEN","BLUE","GREY","YELLOW","RED"],"description":"Combined interpretation: * `GREEN` - OK * `BLUE` - Attention (Huomioi) * `GREY` - Information pending (Odotetaan tietoja) * `YELLOW` - Investigate (Selvitä) * `RED` - STOP\n"},"cl_activity":{"type":"string","enum":["ACTIVE","EXPIRED"],"description":"Activity:\n * `ACTIVE` - The company has an active reliable partner contractor liability report\n * `EXPIRED` - The company's reliable partner contractor liability report is expired\n"},"updated_at":{"type":"string","format":"date-time"}},"required":["archive_code","interpretation","cl_activity","updated_at"]},"CombinedInterpretation":{"type":"object","description":"Includes color coded interpretation of company RP combined interpretation. Combined interpretation is a summary of all sub interpretations. I.e. worst sub interpretation is the value of combined interpretation.","properties":{"combined_interpretation":{"type":"string","enum":["GREEN","BLUE","GREY","YELLOW","RED"],"description":"Combined interpretation: * `GREEN` - Excellent * `BLUE` - Requires Attention * `GREY` - Information pending or missing * `YELLOW` - Requires Investigation * `RED` - Requires Review\n"},"rp_activity":{"type":"string","enum":["ACTIVE","EXPIRED"],"description":"Activity:\n * `ACTIVE` - Company has active reliable partner report\n * `EXPIRED` - Company's reliable partner report is expired\n"},"updated_at":{"type":"string","format":"date-time"}},"required":["combined_interpretation","rp_activity","updated_at"]},"ClInterpretationInfo":{"type":"object","properties":{"business_id":{"type":"string"},"archive_code":{"type":"string","description":"Archive ID of the report","example":"1701938655442"},"interpretation":{"type":"string","enum":["GREEN","BLUE","GREY","YELLOW","RED"],"description":"Combined interpretation: * `GREEN` - OK * `BLUE` - Attention (Huomioi) * `GREY` - Information pending (Odotetaan tietoja) * `YELLOW` - Investigate (Selvitä) * `RED` - STOP\n"},"cl_activity":{"type":"string","enum":["ACTIVE","EXPIRED"],"description":"Activity:\n * `ACTIVE` - The company has an active reliable partner contractor liability report\n * `EXPIRED` - The company's reliable partner contractor liability report is expired\n"},"updated_at":{"type":"string","format":"date-time"}},"required":["business_id","archive_code","interpretation","cl_activity","updated_at"]},"PreCalculatedSubInterpretations":{"type":"object","description":"Includes color coded interpretation of company state and sub interpretations. Combined interpretation is a summary of all sub interpretations. I.e. worst sub interpretation is the value of combined interpretation.","properties":{"business_id":{"type":"string","description":"Business id of the company","example":"2327327-1"},"rp_activity":{"type":"string","enum":["ACTIVE","EXPIRED"],"description":"Activity:\n * `ACTIVE` - Company has active reliable partner report\n * `EXPIRED` - Company's reliable partner report is expired\n"},"combined_interpretation":{"type":"string","enum":["GREEN","BLUE","GREY","YELLOW","RED"],"description":"Combined interpretation (the worst of the sub interpretations below), with one exception: a GREY (no data) failure score is excluded from this overall value, so missing failure score data does not drag the combined interpretation down. The GREY failure score is still visible in `finance_classification_sub_interpretation`.\n * `GREEN` - Excellent\n * `BLUE` - Requires Attention\n * `GREY` - Information pending or missing\n * `YELLOW` - Requires Investigation\n * `RED` - Requires Review\n"},"cl_report_sub_interpretation":{"type":"string","enum":["GREEN","BLUE","GREY","YELLOW","RED"],"description":"Cl interpretation:\n * `GREEN` - OK\n * `BLUE` - Attention (Huomioi)\n * `GREY` - Information pending (Odotetaan tietoja)\n * `YELLOW` - Investigate (Selvitä)\n * `RED` - STOP\n"},"key_person_sub_interpretation":{"type":"string","enum":["GREEN","BLUE","GREY","YELLOW","RED"],"description":"Key person interpretation:\n * `GREEN` - Excellent\n * `BLUE` - Requires Attention\n * `GREY` - Information pending or missing\n * `YELLOW` - Requires Investigation\n * `RED` - Requires Review\n"},"finance_classification_sub_interpretation":{"type":"string","enum":["GREEN","BLUE","GREY","YELLOW","RED"],"description":"Finance classification interpretation: * `GREEN` - Excellent * `BLUE` - Requires Attention * `GREY` - Information pending or missing * `YELLOW` - Requires Investigation * `RED` - Requires Review\n"},"finance_other_sub_interpretation":{"type":"string","enum":["GREEN","BLUE","GREY","YELLOW","RED"],"description":"Other financial information interpretation: * `GREEN` - Excellent * `BLUE` - Requires Attention * `GREY` - Information pending or missing * `YELLOW` - Requires Investigation * `RED` - Requires Review\n"},"company_sub_interpretation":{"type":"string","enum":["GREEN","BLUE","GREY","YELLOW","RED"],"description":"Simplifies `company_status` into standardized interpretation values for easier evaluation. Interpretation: * `GREEN` - Excellent * `BLUE` - Requires Attention * `GREY` - Information pending or missing * `YELLOW` - Requires Investigation * `RED` - Requires Review\n"},"company_status":{"type":"string","enum":["ACTIVE","CONDITION_UNKNOWN","DISSOLVED","BANKRUPT","LIQUIDATED","RESTRUCTURING","ACTIVITY_ENDED","ACTIVITY_PAUSED","NO_STATUS"],"description":"Company status according to ytj. Affects combined interpretation by the following: In case company status is BANKRUPT, LIQUIDATED, DISSOLVED, ACTIVITY_PAUSED or ACTIVITY_ENDED interpretation is RED. In case status is RESTRUCTURING interpretation is YELLOW. Otherwise GREEN: * `ACTIVE` - voimassa in ytj * `CONDITION_UNKNOWN` - Condition unknown * `DISSOLVED` - lakannut in ytj * `BANKRUPT` - konkurssissa in ytj * `LIQUIDATED` - selvitystilassa in ytj * `RESTRUCTURING` - saneerausmenettely in ytj * `ACTIVITY_ENDED` - elinkeinotoiminta päättynyt in ytj * `ACTIVITY_PAUSED` - toiminta keskeytynyt in ytj * `NO_STATUS` - Condition unknown\n"},"updated_at":{"type":"string","format":"date-time"}},"required":["business_id","combined_interpretation","cl_report_sub_interpretation","key_person_sub_interpretation","finance_classification_sub_interpretation","finance_other_sub_interpretation","company_sub_interpretation","company_status","updated_at"]},"Code":{"type":"object","properties":{"code_value":{"type":"string","description":"Code that is used in remarks or key persons"},"code_description":{"type":"string","description":"Code description in finnish"},"code_description_english":{"type":"string","description":"Code description in english"},"code_description_swedish":{"type":"string","description":"Code description in swedish"}},"required":["code_value","code_description","code_description_english","code_description_swedish"]},"KeyPersonConnection":{"type":"object","description":"Company connection of a key person. I.e. role in other company and remarks and sanctions related to connected company.","properties":{"business_id":{"type":"string","description":"Business id of the connected company"},"company_name":{"type":"string","description":"Name of the connected company"},"status":{"type":"string","enum":["ACTIVE","CONDITION_UNKNOWN","DISSOLVED","BANKRUPT","LIQUIDATED","RESTRUCTURING","ACTIVITY_ENDED","ACTIVITY_PAUSED","NO_STATUS"],"description":"Status of the connected company"},"role_code":{"type":"string","description":"Role code. Actual code descriptions can be fetched using /luotettavakumppani/v1.1/key_person_role_codes -endpoint"},"role_start_date":{"type":"string","format":"date-time"},"role_end_date":{"type":"string","format":"date-time"},"remarks":{"type":"array","items":{"$ref":"#/components/schemas/Remark"}},"sanctions":{"type":"array","items":{"$ref":"#/components/schemas/Sanction"}}},"required":["business_id","company_name","status","role_code","remarks","sanctions"]},"KeyPerson":{"type":"object","properties":{"first_names":{"type":"string","description":"Person first names"},"last_name":{"type":"string","description":"Person last name"},"role_code":{"type":"string","description":"Role code. Actual code descriptions can be fetched using /luotettavakumppani/v1.1/key_person_role_codes -endpoint"},"role_start_date":{"type":"string","format":"date-time"},"role_end_date":{"type":"string","format":"date-time"},"business_prohibition":{"type":"boolean","description":"Indicates if the person has business prohibition"},"partial_business_prohibition":{"type":"boolean","description":"Indicates if the person has partial business prohibition"},"ownership_extent":{"type":"number","description":"Ownership percentage in case of beneficial owner"},"beneficial_owner":{"type":"boolean","description":"Flag indicating if the given key person is a beneficial owner"},"sanctions":{"type":"array","items":{"$ref":"#/components/schemas/Sanction"}},"connections":{"type":"array","items":{"$ref":"#/components/schemas/KeyPersonConnection"}},"source":{"type":"string","description":"Source of the data","example":"Dun & Bradstreet Finland Oy"}},"required":["first_names","last_name","role_code","role_start_date","sanctions","connections","source"]},"KeyPersons":{"type":"object","description":"Key persons data. Lists key persons and beneficial owners separately. Interpretation for person sanctions and business prohibition is RED in cas of sanctions or business prohibition. Otherwise, interpretations are GREEN.","properties":{"key_persons":{"type":"array","items":{"$ref":"#/components/schemas/KeyPerson"}},"beneficial_owners":{"type":"array","items":{"$ref":"#/components/schemas/KeyPerson"}},"business_prohibition_interpretation":{"type":"string","enum":["GREEN","BLUE","GREY","YELLOW","RED"],"description":"Interpretation: * `GREEN` - Excellent * `BLUE` - Requires Attention * `GREY` - Information pending or missing * `YELLOW` - Requires Investigation * `RED` - Requires Review\n"},"person_sanction_interpretation":{"type":"string","enum":["GREEN","BLUE","GREY","YELLOW","RED"],"description":"Interpretation: * `GREEN` - Excellent * `BLUE` - Requires Attention * `GREY` - Information pending or missing * `YELLOW` - Requires Investigation * `RED` - Requires Review\n"}},"required":["key_persons","beneficial_owners","business_prohibition_interpretation","person_sanction_interpretation"]},"Esg":{"type":"object","description":"Environmental, Social and Governance","properties":{"strategy":{"type":"string","enum":["YES","YES_INTERNAL","NO"],"description":"Esg strategy info\n * `YES` - Esg strategy published\n * `YES_INTERNAL` - Internal Esg strategy\n * `NO` - No Esg strategy\n"},"subcontractor_check":{"type":"string","enum":["YES","NO","PARTIAL","NA"],"description":"Company ensures that subcontractors have no sanctions \n  * `YES` - Ensured\n  * `NO` - Not ensured\n  * `PARTIAL` - Partially ensured\n  * `NA` - Info not available\n"},"updated_at":{"type":"string","format":"date-time"}},"required":["strategy","subcontractor_check","updated_at"]},"Environment":{"type":"object","properties":{"co2_reduction_goal":{"type":"string","enum":["YES_GOALS_PUBLISHED","YES_GOALS_PUBLISHED_INTERNALLY","NO_GOALS"],"description":"* `YES_GOALS_PUBLISHED` - Co2 reduction goals published * `YES_GOALS_PUBLISHED_INTERNALLY` - Co2 reduction goals published internally * `NO_GOALS` - No Co2 reduction goals\n"},"co2_reporting":{"type":"string","enum":["YES_REPORT_READY","READY_TO_IMPROVE","NOT_READY","NOT_APPLICABLE"],"description":"* `YES_REPORT_READY` - Co2 reporting available  * `READY_TO_IMPROVE` - Ready to improve Co2 reporting * `NOT_READY` - Co2 reporting not available * `NOT_APPLICABLE` - Co2 reporting not applicable\n"},"certificates":{"type":"array","items":{"type":"string"}},"updated_at":{"type":"string","format":"date-time"}},"required":["co2_reduction_goal","co2_reporting","certificates","updated_at"]},"OccupationalSafety":{"type":"object","properties":{"implemented":{"type":"array","items":{"type":"string"},"description":"Implemented occupational safety standards","example":"[\"ISO_45001\"]"},"certificates":{"type":"array","items":{"type":"string"},"description":"Implemented occupational safety certificates","example":"[\"ISO_45001\"]"},"updated_at":{"type":"string","format":"date-time","description":"Last time company has updated this data"}},"required":["implemented","certificates","updated_at"]},"OtherResponsibilityMatters":{"type":"object","properties":{"subcontractor_sanction_check":{"type":"boolean","description":"Flag indicating company checks subcontractors sanctions"},"subcontractor_procurement_check":{"type":"boolean","deprecated":true,"description":"Deprecated: Flag indicating company checks subcontractors procurement"},"public_procurement_units_as_customers":{"type":"boolean","description":"Flag indicating "},"company_one_of_following":{"type":"boolean","description":"Shown only if `public_procurement_units_as_customers` is true"},"updated_at":{"type":"string","format":"date-time","description":"Last time company has updated this data"}},"required":["subcontractor_sanction_check","subcontractor_procurement_check","updated_at"]},"Responsibility":{"type":"object","description":"Collection of company responsibility info","properties":{"esg":{"$ref":"#/components/schemas/Esg"},"environment":{"$ref":"#/components/schemas/Environment"},"occupational_safety":{"$ref":"#/components/schemas/OccupationalSafety"},"other_responsibility_matters":{"$ref":"#/components/schemas/OtherResponsibilityMatters"}},"required":["esg","environment","occupational_safety","other_responsibility_matters"]},"ReportVersions":{"type":"object","properties":{"cl":{"type":"array","items":{"type":"string"},"description":"List of companies that have RP CL service only"},"rp":{"type":"array","items":{"type":"string"},"description":"List of companies that have RP service"},"no_report":{"type":"array","items":{"type":"string"},"description":"List of companies that have neither RP CL nor RP service subscribed"},"required":["cl","rp","no_report"]}},"NameAndLogoUrl":{"type":"object","properties":{"name":{"type":"string"},"logo":{"type":"string"}},"required":["name","logo"]},"RalaCertificateType":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"fi":{"$ref":"#/components/schemas/NameAndLogoUrl"},"se":{"$ref":"#/components/schemas/NameAndLogoUrl"},"en":{"$ref":"#/components/schemas/NameAndLogoUrl"}},"required":["id","fi","se","en"]},"RalaCertificate":{"type":"object","properties":{"business_id":{"type":"string"},"valid_to":{"type":"string","format":"date"},"certificate_type_id":{"type":"integer","format":"int32"},"name":{"type":"string"}},"required":["business_id","valid_to","certificate_type_id","name"]},"status":{"type":"object","properties":{"type":{"type":"string"},"value":{"type":"string"},"description":{"type":"string"}},"required":["type","value","description"]},"statuses":{"type":"object","example":"Kunnossa","properties":{"Ilmoitettu":{"$ref":"#/components/schemas/status","value":"Ilmoitettu","description":"signed up"},"Ei ilmoitettu":{"$ref":"#/components/schemas/status","value":"Ei ilmoitettu","description":"not signed up"},"Rekisterissä":{"$ref":"#/components/schemas/status","value":"Rekisterissä","description":"registered"},"Ei rekisterissä":{"$ref":"#/components/schemas/status","value":"Ei rekisterissä","description":"not registered"},"Maksettu":{"$ref":"#/components/schemas/status","value":"Maksettu","description":"paid"},"Maksamatta":{"$ref":"#/components/schemas/status","value":"Maksamatta","description":"unpaid"},"Maksujärjestely":{"$ref":"#/components/schemas/status","value":"Maksujärjestely","description":"payment arrangement"},"Maksuohjelma":{"$ref":"#/components/schemas/status","value":"Maksuohjelma","description":"payment program"},"Odotetaan tietoja":{"$ref":"#/components/schemas/status","value":"Odotetaan tietoja","description":"waiting for information"},"Yrityssaneeraus":{"$ref":"#/components/schemas/status","value":"Yrityssaneeraus","description":"company reorganization"},"Saneerausohjelma hyväksytty":{"$ref":"#/components/schemas/status","value":"Saneerausohjelma hyväksytty","description":"company reorganization approved"},"Liiketoimintakielto":{"$ref":"#/components/schemas/status","value":"Liiketoimintakielto","description":"ban on business operations"},"Ei liiketoimintakieltoja":{"$ref":"#/components/schemas/status","value":"Ei liiketoimintakieltoja","description":"no ban on business operations"},"Ei vastuuhenkilöitä yrityksessä":{"$ref":"#/components/schemas/status","value":"Ei vastuuhenkilöitä yrityksessä","description":"no persons authorised to represent the company"},"Puuttuu":{"$ref":"#/components/schemas/status","value":"Puuttuu","description":"missing"},"Kunnossa":{"$ref":"#/components/schemas/status","value":"Kunnossa","description":"in order"},"Ei kunnossa":{"$ref":"#/components/schemas/status","value":"Ei kunnossa","description":"not in order"},"Perintäkielto":{"$ref":"#/components/schemas/status","value":"Perintäkielto","description":"debt collection prohibited"},"Yrityssaneerausohjelma hyväksytty, Maksamattomia uusia":{"$ref":"#/components/schemas/status","value":"Yrityssaneerausohjelma hyväksytty, Maksamattomia uusia","description":"company reorganization approved, unpaid new"},"Perintäkielto, saneerausmenettely":{"$ref":"#/components/schemas/status","value":"Perintäkielto, saneerausmenettely","description":"debt collection prohibited, reorganization process"},"Yrityssaneerausohjelma/ velkäjärjestely hyväksytty":{"$ref":"#/components/schemas/status","value":"Yrityssaneerausohjelma/ velkäjärjestely hyväksytty","description":"company reorganization / debt arrangement approved"},"Perintäkielto, saneerausmenettely, merkintä verovelkarekisterissä":{"$ref":"#/components/schemas/status","value":"Perintäkielto, saneerausmenettely, merkintä verovelkarekisterissä","description":"debt collection prohibited, reorganization process, registered in tax debt register"}}},"interpretation":{"type":"object","properties":{"type":{"type":"string"},"value":{"type":"string"},"description":{"type":"string"}},"required":["type","value","description"]},"interpretations":{"type":"object","example":"Ok","properties":{"Seis":{"$ref":"#/components/schemas/interpretation","type":"string","value":"Seis","description":"Stop"},"Selvitä":{"$ref":"#/components/schemas/interpretation","type":"string","value":"Selvitä","description":"Resolution needed"},"Tietoja odotetaan":{"$ref":"#/components/schemas/interpretation","type":"string","value":"Tietoja odotetaan","description":"Waiting for information"},"Huomioi":{"$ref":"#/components/schemas/interpretation","type":"string","value":"Huomioi","description":"Observe"},"Ok":{"$ref":"#/components/schemas/interpretation","type":"string","value":"Ok","description":"Ok"}}},"A1CertificateDocument":{"properties":{"id":{"type":"string","title":"Id","description":"External ID of the document","examples":["81601429-c1c3-453e-89b7-5306f72b08ef"]},"country":{"anyOf":[{"type":"string","pattern":"^[A-Z]{2}$","description":"Country code","examples":["FI","SE"]},{"type":"null"}],"title":"Country"},"valid_until":{"type":"string","format":"date","title":"Valid Until","description":"Expiration date of the document"},"attachments":{"items":{"$ref":"#/components/schemas/Attachment"},"type":"array","title":"Attachments","description":"List of document attachments. Attachments are image files associated with either competences or documents. They can be for example a certificate of a course or a scan of a passport."},"source_org":{"$ref":"#/components/schemas/DocumentOrg","description":"Organization that added the document","examples":["Oy Yritys Ab"]},"type":{"type":"string","const":"a1certificate","title":"Type","default":"a1certificate"}},"type":"object","required":["id","country","valid_until","attachments","source_org"],"title":"A1CertificateDocument"},"Attachment":{"properties":{"id":{"type":"string","title":"Id","description":"Attachment ID","examples":["50d8013f-2132-448c-9459-a203cdd17918"]},"created_at":{"type":"string","format":"date-time","title":"Created At","description":"Creation date and time of the attachment","examples":["2024-12-23T12:38:14.248482Z"]},"url":{"$ref":"#/components/schemas/AttachmentUrls","description":"Single-use URLs to the attachment","examples":["https://api.vastuugroup.fi/tarkastaja/v1.1/attachment/a718712c-cd53-4848-96e9-66b1ca7bde61"]}},"type":"object","required":["id","created_at","url"],"title":"Attachment"},"AttachmentUrls":{"properties":{"original":{"type":"string","title":"Original","description":"Single-use URL to the original attachment"},"preview":{"type":"string","title":"Preview","description":"Single-use URL to the preview version of the attachment"},"thumbnail":{"type":"string","title":"Thumbnail","description":"Single-use URL to the thumbnail version of the attachment"}},"type":"object","required":["original","preview","thumbnail"],"title":"AttachmentUrls"},"CardData":{"properties":{"card_barcode":{"type":"string","title":"Card Barcode","description":"Card barcode. The card barcode is a 12-digit number located on the top side of the card."},"card_uid":{"type":"string","title":"Card Uid","description":"Card UID: the internal 7-byte MIFARE unique identifier assigned to the card."},"valid_from_date":{"type":"string","format":"date","title":"Valid From Date","description":"Card validity start date"},"valid_until_date":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Valid Until Date","description":"Card validity end date"},"status":{"$ref":"#/components/schemas/CardStatus","description":"The current status of the card. Data is provided only for cards that are active."},"verification_status":{"$ref":"#/components/schemas/CardVerificationStatus","description":"Verification status of the card. A card is considered verified when the cardholder has confirmed it through the cardholder portal using strong authentication."},"card_holder":{"$ref":"#/components/schemas/CardHolder","description":"Card holder"},"employer":{"$ref":"#/components/schemas/CardEmployer","description":"Employer"}},"type":"object","required":["card_barcode","card_uid","valid_from_date","valid_until_date","status","verification_status","card_holder","employer"],"title":"CardData"},"CardEmployer":{"properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"Employer company name"},"official_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Official Name","description":"Employer official company name from the Finnish Business Information System."},"register_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Register Number","description":"Company register number or business identity code.","example":"6303826-8"},"country_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Country Code","description":"Company register number or business identity code country."}},"type":"object","required":["name","official_name","register_number","country_code"],"title":"CardEmployer"},"CardHolder":{"properties":{"given_name":{"type":"string","title":"Given Name","description":"Card holder given names.","example":"Erkki"},"surname":{"type":"string","title":"Surname","description":"Card holder surname.","example":"Esimerkki"},"date_of_birth":{"type":"string","format":"date","title":"Date Of Birth","description":"Card holder date of birth in ISO 8601 YYYY-MM-DD format."},"taxnumber":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Taxnumber","description":"Optional Finnish tax number of the cardholder, for employees listed in the Finnish Tax Number Register.","example":"123456789876"},"taxnumber_registry":{"anyOf":[{"items":{"$ref":"#/components/schemas/TaxnumberRegistry"},"type":"array"},{"type":"null"}],"title":"Taxnumber Registry","description":"Optional list of tax number registers the cardholder is included in."}},"type":"object","required":["given_name","surname","date_of_birth"],"title":"CardHolder"},"CardStatus":{"type":"string","enum":["Closed","Active","Inactive"],"title":"CardStatus"},"CardTerminationReason":{"type":"string","enum":["NewCardProduced","EmploymentRemoved","TerminatedByAdministrator","EmployeeTaxRegisterChanged","CardExpired","EmployeeNameChanged","Other"],"title":"CardTerminationReason"},"CardVerificationStatus":{"type":"string","enum":["Verified","VerificationPending","NotVerified"],"title":"CardVerificationStatus"},"CompetenceOrg":{"properties":{"name":{"type":"string","title":"Name"}},"type":"object","required":["name"],"title":"CompetenceOrg"},"CompetenceSource":{"type":"string","enum":["employer","trainer"],"title":"CompetenceSource"},"CompetenceType":{"properties":{"competence_type_id":{"type":"string","title":"Competence Type Id"},"names":{"items":{},"type":"array","title":"Names"},"descriptions":{"items":{},"type":"array","title":"Descriptions"}},"type":"object","required":["competence_type_id","names","descriptions"],"title":"CompetenceType"},"CompetenceWithType":{"properties":{"id":{"type":"string","title":"Id","description":"Competence ID","examples":["8ec200a0-7907-45e8-85ca-7892dc2d808c"]},"type":{"type":"string","title":"Type","description":"Human-readable competence type","examples":["CT-FIAJOKA-7"]},"valid_from_date":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Valid From Date","description":"Start date of the competence","examples":["2022-01-01"]},"valid_until_date":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Valid Until Date","description":"Expiration date of the competence","examples":["2034-04-01"]},"source":{"$ref":"#/components/schemas/CompetenceSource","description":"Source of the competence. Currently there are two sources for competences in the system. Trainer competences which have been imported by external trainer partners. Employer competence which have been added to the system by the employers themselves."},"source_org":{"anyOf":[{"$ref":"#/components/schemas/CompetenceOrg"},{"type":"null"}],"description":"Organization which added the competence","examples":["Oy Yritys Ab"]},"attachments":{"items":{"$ref":"#/components/schemas/Attachment"},"type":"array","title":"Attachments","description":"List of competence attachments"}},"type":"object","required":["id","type","valid_from_date","valid_until_date","source","source_org","attachments"],"title":"CompetenceWithType"},"ContactAddress":{"properties":{"full_address":{"type":"string","title":"Full Address","description":"Street address, post area, and post code as one string"},"post_code":{"type":"string","title":"Post Code","description":"Post code of the address"},"country":{"type":"string","title":"Country","description":"Country of the address in ISO-3166 alpha-2 format country code"},"post_area":{"type":"string","title":"Post Area","description":"Post area/city of the address"},"address_lines":{"items":{"type":"string"},"type":"array","title":"Address Lines","description":"Street address lines as a list"}},"type":"object","required":["full_address","post_code","country","post_area","address_lines"],"title":"ContactAddress"},"ContactPerson":{"properties":{"contact_phone":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Contact Phone","description":"Phone number of employer's contact person","example":"+358501234567"},"contact_last_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Contact Last Name","description":"Last name of employer's contact person","example":"Lastname"},"contact_first_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Contact First Name","description":"First name of employer's contact person","example":"Firstname"},"contact_email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Contact Email","description":"Email address of employer's contact person","example":"user@host.com"}},"type":"object","required":["contact_phone","contact_last_name","contact_first_name","contact_email"],"title":"ContactPerson"},"Contacts":{"properties":{"names":{"items":{"$ref":"#/components/schemas/Name"},"type":"array","title":"Names","description":"List of person's names"},"phone_numbers":{"items":{"$ref":"#/components/schemas/PhoneNumber"},"type":"array","title":"Phone Numbers","description":"List of person's phone numbers"},"addresses":{"items":{"$ref":"#/components/schemas/ContactAddress"},"type":"array","title":"Addresses","description":"List of person's addresses. Returns an empty list","deprecated":true},"email_addresses":{"items":{"$ref":"#/components/schemas/EmailAddress"},"type":"array","title":"Email Addresses","description":"List of person's email addresses"}},"type":"object","required":["names","phone_numbers","addresses","email_addresses"],"title":"Contacts"},"DocumentOrg":{"properties":{"name":{"type":"string","title":"Name"}},"type":"object","required":["name"],"title":"DocumentOrg"},"EmailAddress":{"properties":{"email_address":{"type":"string","title":"Email Address","description":"Person's email address","example":"user@host.com"}},"type":"object","required":["email_address"],"title":"EmailAddress"},"EmployeeInformationAccessRow":{"properties":{"organization":{"$ref":"#/components/schemas/app__tarkastaja__v1_1__model__employment__Employer","description":"Details of the organization."},"created_at":{"type":"string","format":"date-time","title":"Created At","description":"Time the access was granted."}},"type":"object","required":["organization","created_at"],"title":"EmployeeInformationAccessRow"},"EmployerAddress":{"properties":{"full_address":{"type":"string","title":"Full Address","description":"Street address, post area, and post code as one string","example":"Address 1 A, 00100 Helsinki"},"address":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Address","description":"Street address lines as an array","example":"Address 1 A"},"post_area":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Post Area","description":"Post area/city of the address","example":"Helsinki"},"post_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Post Code","description":"Post code of the address","example":"00100"},"country":{"type":"string","pattern":"^[A-Z]{2}$","title":"Country","description":"Country code","examples":["FI","SE"]}},"type":"object","required":["full_address","address","post_area","post_code","country"],"title":"EmployerAddress"},"EmployerOfficialOrgName":{"properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"Employer's name","example":"Oy Employer Ab"},"employers_contact_person":{"anyOf":[{"$ref":"#/components/schemas/ContactPerson"},{"type":"null"}]},"country":{"type":"string","pattern":"^[A-Z]{2}$","title":"Country","description":"Country code","examples":["FI","SE"]},"address":{"anyOf":[{"$ref":"#/components/schemas/EmployerAddress"},{"type":"null"}],"description":"Employer's address details"},"employment_periods":{"anyOf":[{"items":{"$ref":"#/components/schemas/EmploymentPeriod"},"type":"array"},{"type":"null"}],"title":"Employment Periods","description":"Person's employment's details (provided by employer representative, currently only one employment period entity found in response)"},"gov_org_ids":{"items":{"$ref":"#/components/schemas/GovernmentOrgID"},"type":"array","title":"Gov Org Ids","description":"List of employer's organization identifiers"},"tax_number_registration_status":{"anyOf":[{"$ref":"#/components/schemas/TaxNumberRegistrationStatus"},{"type":"null"}],"description":"The information to which tax number register the tax number belongs to (employmentspecific)"},"official_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Official Name","description":"Employer's official organization name"}},"type":"object","required":["name","employers_contact_person","country","address","employment_periods","gov_org_ids","tax_number_registration_status","official_name"],"title":"EmployerOfficialOrgName"},"Employment":{"properties":{"id":{"type":"string","pattern":"^EMex-[0-9a-f-]+$","title":"Id","description":"Employment ID"},"employer":{"$ref":"#/components/schemas/app__tarkastaja__v1_1__model__employment__Employer","description":"Employer organization's details"},"person":{"$ref":"#/components/schemas/app__tarkastaja__v1_1__model__employment__Person","description":"Person's details"},"documents":{"items":{"oneOf":[{"$ref":"#/components/schemas/IdentificationDocument"},{"$ref":"#/components/schemas/ResidencePermitDocument"},{"$ref":"#/components/schemas/A1CertificateDocument"}],"discriminator":{"propertyName":"type","mapping":{"a1certificate":"#/components/schemas/A1CertificateDocument","identification":"#/components/schemas/IdentificationDocument","residencepermit":"#/components/schemas/ResidencePermitDocument"}}},"type":"array","title":"Documents","description":"List of documents related to the employment.\nThe documents are only included if the company has a Valtti service plan."},"competences":{"items":{"$ref":"#/components/schemas/CompetenceWithType"},"type":"array","title":"Competences","description":"List of competences related to the employment.\nThe competences are only included if the company has a Valtti service plan."},"posted_worker_contact_info":{"anyOf":[{"$ref":"#/components/schemas/PostedWorkerContactInfo"},{"type":"null"}],"description":"Contact information for the posted worker. Added by the employer in the Vastuu Group Employee Management service"}},"type":"object","required":["id","employer","person","documents","competences"],"title":"Employment"},"EmploymentPeriod":{"properties":{"contract_type":{"type":"integer","enum":[1,3,4],"title":"Contract Type","description":"Type of contract of employment in tax authority's employee report format (1 = direct employment / työsuhteinen | 3 = independent contractor / ammatinharjoittaja tai vastaava | 4 = trainee work / harjoittelija)"}},"type":"object","required":["contract_type"],"title":"EmploymentPeriod"},"GovOrgId":{"properties":{"org_id":{"type":"string","title":"Org Id","description":"Government id of the organization","examples":["123456-7"]},"org_id_type":{"$ref":"#/components/schemas/OrganizationIdType","description":"Type of the organization id"},"org_id_country":{"type":"string","pattern":"^[A-Z]{2}$","title":"Org Id Country","description":"Country of the organization id","examples":["FI","SE"]}},"type":"object","required":["org_id","org_id_type","org_id_country"],"title":"GovOrgId"},"GovernmentID":{"properties":{"gov_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Gov Id","description":"Person's government ID value","examples":["120099999999"]},"id_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Id Type","description":"Type of the government ID","examples":["tax_number"]},"country":{"anyOf":[{"type":"string","pattern":"^[A-Z]{2}$","description":"Country code","examples":["FI","SE"]},{"type":"null"}],"title":"Country"}},"type":"object","required":["gov_id","id_type","country"],"title":"GovernmentID"},"GovernmentOrgID":{"properties":{"gov_org_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Gov Org Id","description":"Value of employer's organization identifier","example":"123456-7"},"org_id_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Org Id Type","description":"Organization identifier's type","example":"register_number"},"country":{"anyOf":[{"type":"string","pattern":"^[A-Z]{2}$","description":"Country code","examples":["FI","SE"]},{"type":"null"}],"title":"Country"}},"type":"object","required":["gov_org_id","org_id_type","country"],"title":"GovernmentOrgID"},"IdentificationDocument":{"properties":{"id":{"type":"string","title":"Id","description":"External ID of the document","examples":["81601429-c1c3-453e-89b7-5306f72b08ef"]},"country":{"anyOf":[{"type":"string","pattern":"^[A-Z]{2}$","description":"Country code","examples":["FI","SE"]},{"type":"null"}],"title":"Country"},"valid_until":{"type":"string","format":"date","title":"Valid Until","description":"Expiration date of the document"},"attachments":{"items":{"$ref":"#/components/schemas/Attachment"},"type":"array","title":"Attachments","description":"List of document attachments. Attachments are image files associated with either competences or documents. They can be for example a certificate of a course or a scan of a passport."},"source_org":{"$ref":"#/components/schemas/DocumentOrg","description":"Organization that added the document","examples":["Oy Yritys Ab"]},"type":{"type":"string","const":"identification","title":"Type","default":"identification"},"id_type":{"type":"string","title":"Id Type","description":"Type of the identification document"},"document_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Document Number","description":"Document number"}},"type":"object","required":["id","country","valid_until","attachments","source_org","id_type","document_number"],"title":"IdentificationDocument"},"Name":{"properties":{"full_name":{"type":"string","title":"Full Name","description":"Person's full name","example":"John Doe"},"surnames":{"items":{"type":"string"},"type":"array","title":"Surnames","description":"Person's surnames as a list","example":["Doe"]},"titles":{"items":{"type":"string"},"type":"array","title":"Titles","description":"Person's titles as a list. Returns an empty list.","deprecated":true,"example":[]},"given_names":{"items":{"type":"string"},"type":"array","title":"Given Names","description":"Person's given names as a list","example":["John"]},"sort_key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sort Key","description":"Person's sort keys in Qvarn","example":"Doe, John"}},"type":"object","required":["full_name","surnames","titles","given_names","sort_key"],"title":"Name"},"Names":{"properties":{"full_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Full Name","description":"Person's full name","examples":["John Doe"]},"given_names":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Given Names","description":"Person's first names as an array","examples":["John"]},"surnames":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Surnames","description":"Person's surnames as an array","examples":["Doe"]},"titles":{"anyOf":[{"items":{},"type":"array"},{"type":"null"}],"title":"Titles","description":"Deprecated, empty list","example":[]},"sort_key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sort Key","description":"Person's sort keys in Qvarn"}},"type":"object","required":["full_name","given_names","surnames","titles","sort_key"],"title":"Names"},"OrganizationId":{"properties":{"type":{"$ref":"#/components/schemas/OrganizationIdType","description":"Type of the identifier"},"value":{"type":"string","title":"Value","description":"Value of the identifier","examples":["123456-7"]},"country":{"type":"string","pattern":"^[A-Z]{2}$","title":"Country","description":"Country code","examples":["FI","SE"]}},"type":"object","required":["type","value","country"],"title":"OrganizationId"},"OrganizationIdType":{"type":"string","enum":["registration_number","vat_number"],"title":"OrganizationIdType"},"OrganizationPermissionInformation":{"properties":{"permission":{"items":{"$ref":"#/components/schemas/OrganizationPermissionInformationRow"},"type":"array","title":"Permission","description":"Organizations that the data consumer has access to"},"no_permission":{"items":{"$ref":"#/components/schemas/OrganizationPermissionInformationRow"},"type":"array","title":"No Permission","description":"Organizations that the data consumer does not have access to"}},"type":"object","required":["permission","no_permission"],"title":"OrganizationPermissionInformation"},"OrganizationPermissionInformationRow":{"properties":{"org_id":{"type":"string","title":"Org Id","description":"Government id of the organization","examples":["123456-7"]},"org_id_type":{"$ref":"#/components/schemas/OrganizationIdType","description":"Type of the organization id"},"org_id_country":{"type":"string","pattern":"^[A-Z]{2}$","title":"Org Id Country","description":"Country of the organization id","examples":["FI","SE"]},"license":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"License","description":"Whether the organization has the required license for accessing its information. This field is only present when the 'licenses' query parameter is true. When present, the value is always a boolean (true/false)."}},"type":"object","required":["org_id","org_id_type","org_id_country"],"title":"OrganizationPermissionInformationRow"},"PermissionDenied":{"properties":{"detail":{"type":"string","title":"Detail"},"reason":{"$ref":"#/components/schemas/PermissionDeniedReason","description":"234","example":"CardClosed"},"card_termination_reason":{"anyOf":[{"$ref":"#/components/schemas/CardTerminationReason"},{"type":"null"}]}},"type":"object","required":["detail","reason"],"title":"PermissionDenied"},"PermissionDeniedReason":{"type":"string","enum":["CardClosed","PermissionDenied"],"title":"PermissionDeniedReason"},"PersonId":{"properties":{"type":{"$ref":"#/components/schemas/PersonIdType","description":"Type of the identifier"},"value":{"type":"string","title":"Value","description":"Value of the identifier"},"country":{"type":"string","pattern":"^[A-Z]{2}$","title":"Country","description":"Country code","examples":["FI","SE"]}},"type":"object","required":["type","value","country"],"title":"PersonId"},"PersonIdType":{"type":"string","enum":["tax_number"],"title":"PersonIdType"},"PersonalInformation":{"properties":{"tax_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Tax Number","description":"Person's tax number","examples":["1234567890"]}},"type":"object","required":["tax_number"],"title":"PersonalInformation"},"PhoneNumber":{"properties":{"phone_number":{"type":"string","title":"Phone Number","description":"Person's phone number","example":"+358501234567"}},"type":"object","required":["phone_number"],"title":"PhoneNumber"},"PostedWorkerContactInfo":{"properties":{"name":{"type":"string","title":"Name","description":"Name of the contact person or the organization","examples":["Erkki Esimerkki","Oy Yritys Ab"]},"email":{"type":"string","title":"Email","description":"Email of the contact info","examples":["user@host.com"]},"phone_number":{"type":"string","title":"Phone Number","description":"Phone number with country code","examples":["+358501234567"]},"address":{"type":"string","title":"Address","description":"Finnish address of the contact info","examples":["Esimerkkitie 1 A 11"]},"city":{"type":"string","title":"City","description":"Finnish city","examples":["Helsinki"]},"postal_code":{"type":"string","title":"Postal Code","description":"Finnish postal code","examples":["00100"]},"co_address":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Co Address","description":"The 'care of' or c/o address is used whenever sending mail to a person who does not actually live or work at the address.","examples":["c/o Maisa Malli"]}},"type":"object","required":["name","email","phone_number","address","city","postal_code","co_address"],"title":"PostedWorkerContactInfo"},"ResidencePermitDocument":{"properties":{"id":{"type":"string","title":"Id","description":"External ID of the document","examples":["81601429-c1c3-453e-89b7-5306f72b08ef"]},"country":{"anyOf":[{"type":"string","pattern":"^[A-Z]{2}$","description":"Country code","examples":["FI","SE"]},{"type":"null"}],"title":"Country"},"valid_until":{"type":"string","format":"date","title":"Valid Until","description":"Expiration date of the document"},"attachments":{"items":{"$ref":"#/components/schemas/Attachment"},"type":"array","title":"Attachments","description":"List of document attachments. Attachments are image files associated with either competences or documents. They can be for example a certificate of a course or a scan of a passport."},"source_org":{"$ref":"#/components/schemas/DocumentOrg","description":"Organization that added the document","examples":["Oy Yritys Ab"]},"type":{"type":"string","const":"residencepermit","title":"Type","default":"residencepermit"},"document_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Document Number","description":"Document number"}},"type":"object","required":["id","country","valid_until","attachments","source_org","document_number"],"title":"ResidencePermitDocument"},"TaxNumberRegistrationStatus":{"properties":{"shipyard_worker":{"type":"boolean","title":"Shipyard Worker","description":"Tax number is registered to shipyard tax number register"},"construction_worker":{"type":"boolean","title":"Construction Worker","description":"Tax number is registered to construction tax number register"}},"type":"object","required":["shipyard_worker","construction_worker"],"title":"TaxNumberRegistrationStatus"},"TaxnumberRegistry":{"type":"string","enum":["construction","shipbuilding"],"title":"TaxnumberRegistry"},"app__personapi__model__employer__Employer":{"properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"Employer's name","example":"Oy Employer Ab"},"employers_contact_person":{"anyOf":[{"$ref":"#/components/schemas/ContactPerson"},{"type":"null"}]},"country":{"type":"string","pattern":"^[A-Z]{2}$","title":"Country","description":"Country code","examples":["FI","SE"]},"address":{"anyOf":[{"$ref":"#/components/schemas/EmployerAddress"},{"type":"null"}],"description":"Employer's address details"},"employment_periods":{"anyOf":[{"items":{"$ref":"#/components/schemas/EmploymentPeriod"},"type":"array"},{"type":"null"}],"title":"Employment Periods","description":"Person's employment's details (provided by employer representative, currently only one employment period entity found in response)"},"gov_org_ids":{"items":{"$ref":"#/components/schemas/GovernmentOrgID"},"type":"array","title":"Gov Org Ids","description":"List of employer's organization identifiers"},"tax_number_registration_status":{"anyOf":[{"$ref":"#/components/schemas/TaxNumberRegistrationStatus"},{"type":"null"}],"description":"The information to which tax number register the tax number belongs to (employmentspecific)"}},"type":"object","required":["name","employers_contact_person","country","address","employment_periods","gov_org_ids","tax_number_registration_status"],"title":"Employer"},"app__personapi__model__person__Person":{"properties":{"names":{"items":{"$ref":"#/components/schemas/Names"},"type":"array","title":"Names","description":"List of person's names"},"date_of_birth":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Date Of Birth","description":"Date of birth","examples":["1980-01-20"]},"nationalities":{"anyOf":[{"items":{"type":"string","pattern":"^[A-Z]{2}$","description":"Country code","examples":["FI","SE"]},"type":"array"},{"type":"null"}],"title":"Nationalities","description":"Person's nationalities in ISO-3166 alpha-2 format country code as an array"},"gov_ids":{"items":{"$ref":"#/components/schemas/GovernmentID"},"type":"array","title":"Gov Ids","description":"List of person's government issued identifiers"},"employers":{"anyOf":[{"items":{"$ref":"#/components/schemas/app__personapi__model__employer__Employer"},"type":"array"},{"items":{"$ref":"#/components/schemas/EmployerOfficialOrgName"},"type":"array"},{"type":"null"}],"title":"Employers","description":"List of employers under which the person has an active employment"}},"type":"object","required":["names","date_of_birth","nationalities","gov_ids","employers"],"title":"Person"},"app__tarkastaja__v1_1__model__employment__Employer":{"properties":{"name":{"type":"string","title":"Name","description":"Name of the organization"},"identifiers":{"items":{"$ref":"#/components/schemas/OrganizationId"},"type":"array","title":"Identifiers","description":"List of organization identifiers"}},"type":"object","required":["name","identifiers"],"title":"Employer"},"app__tarkastaja__v1_1__model__employment__Person":{"properties":{"first_name":{"type":"string","title":"First Name","description":"First name of the person","examples":["John"]},"last_name":{"type":"string","title":"Last Name","description":"Last name of the person","examples":["Doe"]},"nationality":{"anyOf":[{"type":"string","pattern":"^[A-Z]{2}$","description":"Country code","examples":["FI","SE"]},{"type":"null"}],"title":"Nationality"},"date_of_birth":{"type":"string","format":"date","title":"Date Of Birth","description":"Date of birth","examples":["1980-01-20"]},"identifiers":{"items":{"$ref":"#/components/schemas/PersonId"},"type":"array","title":"Identifiers","description":"List of person identifiers"}},"type":"object","required":["first_name","last_name","nationality","date_of_birth","identifiers"],"title":"Person"},"OneList":{"properties":{"list_id":{"type":"integer","format":"int64"},"name":{"type":"string"},"status":{"type":"string","enum":["ACTIVE","ARCHIVED"]},"external_id":{"type":"string"},"watcher_count":{"type":"integer","format":"int32"},"watchers":{"type":"array","items":{"$ref":"#/components/schemas/PartnerWatcher"}},"active_companies_count":{"type":"integer","format":"int32"},"total_companies_count":{"type":"integer","format":"int32"},"warnings":{"$ref":"#/components/schemas/Warnings"},"archived_at":{"type":"string","format":"date-time"},"created":{"type":"string","format":"date-time"}}},"PartnerWatcher":{"properties":{"user_id":{"type":"string"},"first_name":{"type":"string"},"last_name":{"type":"string"},"start_date":{"type":"string","format":"date-time"},"end_date":{"type":"string","format":"date-time"}}},"Warnings":{"properties":{"yellow_count":{"type":"integer","format":"int64"},"red_count":{"type":"integer","format":"int64"}}},"ListRequest":{"properties":{"name":{"type":"string","maxLength":300,"minLength":1},"notes":{"type":"string","maxLength":3000,"minLength":0},"external_id":{"type":"string"},"postal_address":{"type":"string","maxLength":300,"minLength":0},"postal_code":{"type":"string","maxLength":300,"minLength":0},"post_office":{"type":"string","maxLength":300,"minLength":0},"watcher_ids":{"type":"array","items":{"type":"string"}}},"required":["name"]},"Modifier":{"properties":{"name":{"type":"string"},"modifier_type":{"type":"string","enum":["USER","CUSTOMER_SERVICE","DELETED_USER","UNKNOWN_USER","SYSTEM","PARTNERAPI"]}}},"CompanyBasics":{"properties":{"company_name":{"type":"string"},"status":{"type":"string","enum":["ACTIVE","TERMINATED","BANKRUPT","UNKNOWN"]}}},"CompanyEntry":{"properties":{"entry_id":{"type":"integer","format":"int64"},"gov_id":{"$ref":"#/components/schemas/GovId"},"basic":{"$ref":"#/components/schemas/CompanyBasics"},"parent":{"$ref":"#/components/schemas/CompanyEntryParent"},"chain_position":{"type":"integer","format":"int32"},"monitoring_period":{"$ref":"#/components/schemas/MonitoringPeriod"},"interpretations":{"$ref":"#/components/schemas/PartnerInterpretations"},"meets_requirements":{"type":"string","enum":["YES","NO","NO_REQUIREMENTS","NOT_SUPPORTED"]},"subcontractor_details":{"$ref":"#/components/schemas/SubcontractorDetails"}}},"CompanyEntryParent":{"properties":{"entry_id":{"type":"integer","format":"int64"},"gov_id":{"$ref":"#/components/schemas/GovId"},"basic":{"$ref":"#/components/schemas/CompanyBasics"}}},"GovId":{"properties":{"country_code":{"type":"string","enum":["EE","FI","LT","LV","PL","SE"]},"business_id":{"type":"string"}}},"MonitoringPeriod":{"properties":{"start_date":{"type":"string","format":"date-time"},"end_date":{"type":"string","format":"date-time"}}},"PartnerInterpretations":{"properties":{"combined_interpretation":{"type":"string","enum":["GREEN","GREY","YELLOW","BLUE","RED","OLD"]},"contractors_obligations":{"type":"string","enum":["GREEN","GREY","YELLOW","BLUE","RED","OLD"]}}},"SubcontractorDetails":{"properties":{"total_subcontractors_count":{"type":"integer","format":"int32"},"active_subcontractors_count":{"type":"integer","format":"int32"}}},"PartnerAddCompanyRequest":{"properties":{"business_id":{"type":"string"},"country_code":{"type":"string"},"notes":{"type":"string"},"parent_id":{"type":"integer","format":"int64"}}},"FailedItem":{"properties":{"business_id":{"type":"string"},"country_code":{"type":"string"},"message":{"type":"string"}}},"PartnerAddCompaniesResponse":{"properties":{"ok":{"type":"array","items":{"$ref":"#/components/schemas/SuccessItem"}},"failed":{"type":"array","items":{"$ref":"#/components/schemas/FailedItem"}}}},"SuccessItem":{"properties":{"business_id":{"type":"string"},"country_code":{"type":"string"}}},"PartnerRemoveCompanyRequest":{"properties":{"business_id":{"type":"string"},"country_code":{"type":"string"}}},"PartnerRemoveCompaniesResponse":{"properties":{"ok":{"type":"array","items":{"$ref":"#/components/schemas/SuccessItem"}},"failed":{"type":"array","items":{"$ref":"#/components/schemas/FailedItem"}}}}},"securitySchemes":{"HTTPBearer":{"type":"http","scheme":"bearer"}},"responses":{}},"tags":[{"name":"Test Data API v1.0","description":"This API provides access to a collection of predefined test data for validating API integrations. The data is available exclusively in the test environment and must not be used in production.\n\nIt can be used to retrieve test entities such as company identifiers, personal tax numbers, and Valtti card identification data for testing integrations with other APIs in the test environment.\n\n**All testing must be performed using the data provided by this API.**\n"},{"name":"Customer Identifiers API v1.0","description":"Get details about customer-identifiers"},{"name":"Competence Input API v1.0","description":"Add or delete competences"},{"name":"Korttivarasto API v1.3","description":"Get Valtti card (Valttikortti) data"},{"name":"Luotettava Kumppani API v1.1","description":"### The API supports two main product scopes:\n  - **RP CL (Reliable Partner Contractor’s Liability Information)** (FI: Tilaajavastuutiedot) — data available both for RP CL and RP companies.\n  - **RP (Reliable Partner)** — data available only for RP companies. RP includes RP CL (an active RP version also includes RP CL data).\n\n### Sync vs. incremental:\nMost endpoints accept `changed_after` query parameter.  \n  - For a full initial sync, set `changed_after` far in the past (e.g. 2000-01-01T00:00:00.001Z).  \n  - For incremental updates, set `changed_after` to your previous successful run timestamp.\n\n### Interpretation types\n#### Reliable Partner Contractor's Liability Information:\n- CL Interpretation formed from the contractor’s liability information.\n\n#### Reliable Partner:\n- Combined Interpretation formed from the contractor’s liability information, other financial matters, financial classifications, and responsible persons’ information.\n\n\n---\n\n### Check report versions\n**Mandatory first step before retrieving company-specific data. Use this endpoint to determine which report versions are available for each company before calling any other data retrieval endpoints.**\n\n`/luotettavakumppani/v1.1/report_versions`\n- Determine which business IDs have an active Reliable Partner Contractor’s Liability Information (RP CL) or Reliable Partner (RP) report version.\n\n---\n\n### Fetch Reliable Partner Contractor’s Liability Information data\nFetch Reliable Partner Contractor’s Liability Information (RP CL) data for the given companies. Data is returned for any company that has an active **RP CL** or **RP** report version as determined via `/report_versions`.\n\n#### Interpretation data\n`/luotettavakumppani/v1.1/cl_interpretations?changed_after=<timestamp>`\n- RP CL interpretations for the companies in the request.\n\n#### Report data\n`/luotettavakumppani/v1.1/cl_reports?changed_after=<timestamp>`\n- RP CL reports in JSON format for the companies in the request.\n\n`/luotettavakumppani/v1.1/cl_report_pdf`\n- Retrieve the latest available RP CL report as a PDF for a single company.\n\n---\n\n### Fetch Reliable Partner data\nFetch Reliable Partner data for companies that have an active **RP** report version as determined via `/report_versions`.\n\n#### Interpretation data\n`/luotettavakumppani/v1.1/interpretations?changed_after=<timestamp>`\n- RP interpretations for the companies in the request.\n\n`/luotettavakumppani/v1.1/combined_interpretations?changed_after=<timestamp>`\n- Combined **RP + RP CL** interpretations for the companies in the request.\n\n#### Report data\n**Use each `*_changed` endpoint first to identify changed companies, then fetch the actual data for the returned business IDs using the corresponding data endpoint.**\n\n`/luotettavakumppani/v1.1/finance_changed?changed_after=<timestamp>`\n- List of companies where RP finance data has changed since `changed_after`.\n\n`/luotettavakumppani/v1.1/finance`\n- RP finance data for a single company.\n\n`/luotettavakumppani/v1.1/key_persons_changed?changed_after=<timestamp>`\n- List of companies where RP key person data has changed since `changed_after`.\n\n`/luotettavakumppani/v1.1/key_persons`\n- RP key person data for a single company.\n\n`/luotettavakumppani/v1.1/responsibility_changed?changed_after=<timestamp>`\n- List of companies where RP responsibility data has changed since `changed_after`.\n\n`/luotettavakumppani/v1.1/responsibility`\n- RP responsibility data for a single company.\n\n`/luotettavakumppani/v1.1/rp_report_html`\n- Retrieve the latest available RP report as HTML for a single company.\n\n#### Code tables (rarely changing reference data)\nThis reference data changes rarely and can be cached.\n\n`/luotettavakumppani/v1.1/remark_codes`\n- Descriptions for remark codes.\n\n`/luotettavakumppani/v1.1/key_person_role_codes`\n- Descriptions for key person role codes. \n\n---\n\n### RALA (competence/certification data)\nRALA data is only available for companies listed by `/rala_companies`. These companies must also have an active RP CL or RP report version.\n\nUse `/rala_companies` first to identify companies with RALA data, then fetch certificate details per company using `/rala_certificates`.\n\n`/luotettavakumppani/v1.1/rala_companies`\n- List companies with RALA competence and/or certification.\n\n`/luotettavakumppani/v1.1/rala_certificates`\n- Retrieve RALA certificates for a single company from the companies returned by `/rala_companies`.\n\n`/luotettavakumppani/v1.1/rala_certificate_types`\n- Descriptions for RALA certificate types. This reference data changes rarely and can be cached.\n\n## Changelog\n|API endpoint|Change|Description|\n|----|----|----|\n|all|Renamed base url|Base url changed from /luotettavakumppani2 to /luotettavakumppani. Also, version changed from 1.0 to 1.1. So all endpoints will start with /luotettavakumppani/v1.1/|\n|all|Renamed scopes|See individual endpoints for required scope.|\n|/report_versions|New endpoint|Replaces /subscriptions -endpoint with slightly changed payload.<br />Customer-identifier header parameter changed to optional.|\n|/subscriptions|Removed endpoint|Removed|\n|/rp_report_html|Renamed endpoint|Replaces /lk2_report -endpoint|\n|/rala_companies|New endpoint|Returns list of companies that have Rala -certificates|\n|/responsibility|Changed response|Add properties `public_procurement_units_as_customers` and `company_one_of_following` and deprecate `subcontractor_procurement_check`|\n|/cl_reports|Changed response|Added `remark` property to the BIS register elements `tax_basic_reg`, `prepayment_reg`, `trade_reg` and `employer_reg`. Provides additional context for the register status (e.g. why a company is not registered). The value can be `null`.|\n|/cl_reports|Changed response|Added `insurer` property to `liability_insurance`. Contains the name of the insurance company.|\n|/cl_reports|Changed response|Added `remark` property to `health_cares`. Contains additional remark for health care. HealthCares cannot be null anymore|\n|/finance|Changed response|Added `failure_score` to finance `classifications` (`interpretation`, `failure_class`, `score`, `source`). Always present; `failure_class` and `score` are `null` and `interpretation` is `GREY` when D&B has no data.|\n|/finance|Changed response|`credit_rating` is deprecated: `interpretation` is now always `GREY` and the `scoring` field has been removed.|\n|/interpretations|Changed response|A `GREY` (no-data) failure score does not lower `combined_interpretation`, but is reflected in `finance_classification_sub_interpretation`.|\n|/finance|Changed response|Changed failure score's threshold for interpretation `GREEN` from 34 to 21|"},{"name":"Person API v1.2","description":"## Changelog\n\n|API endpoint|Change|Descripion|\n|----|----|----|\n|/card|A new `/card` API endpoint.|Returns card basic data.|\n|/authority_report|Deprecated the `country` query parameter of the `authority_report` endpoint|The `country` query parameter was ambiguous. Use `id_country`.|\n|/contacts|A new HTTP return code 403|A new HTTP return code 403 with an error message \"The requester organization does not have access to the requested employment.\". The requesting organization does not have permission the view the requested employment. Starting from version v1.2 the endpoint will also return contact details for employees without a verified tax number in the Finnish tax registry. For these employments the data only is available if the requesting party is the employer.| \n"},{"name":"Tarkastaja API v1.1","description":"## Changelog\n\n\n| Change | Description |\n|----|----|\n|`validation_status` of the competence object has been deprecated.|`validation_status` served no purpose because competences are not validated from external sources. The `source` attribute should be used intead. It contains the `employer` for competences the employers have added themselved and `trainer` for competences imported from external registries.|\n|Competences have a new attribute `source_org`.|The attribute contains name of the organization which added the competence. For competences added by the employer (`source` `employer`) it's the name of the employer company. For competences added by some external training organization (`source` `trainer`) it's the name of the external organization.|\n|Documents have a new `source_org` attribute.|Documents have a new `source_org` attribute which contain the name of the organization which added the document. Currently it is always the name of employer company.|\n|Added `posted_worker_contact_info`.|The employee posted worker contact information is available in the `posted_worker_contact_info` element.|\n"}],"x-tagGroups":[{"name":"Test Data","tags":["Test Data API v1.0"]},{"name":"Customer Identifiers","tags":["Customer Identifiers API v1.0"]},{"name":"Luotettava Kumppani","tags":["Luotettava Kumppani API v1.1"]},{"name":"Valtti Services","tags":["Competence Input API v1.0","Korttivarasto API v1.3","Person API v1.2","Tarkastaja API v1.1"]}]}